SFTP Integration Guide

This guide explains how to sync users from a CSV file on an SFTP server to your Nimblr Security Awareness account.

1. Create a CSV file with your user data according to the format described in this article. Upload the file to a folder on an SFTP server that can be made accessible to the Nimblr system using a username and password.

2. Sing in to your Nimblr admin portal and navigate to Settings > Integrations and select Integration type SFTP. 

3. Enter the following information and credentials:

• Server - The hostname of the SFTP server hosting the CSV file
• User - The username of the account with access to the CSV file
• Password - The password Username for the account with access to the CSV file
• Port - The port number of the port to be used for SFTP communication
  
  

4. Click Save changes. An information box at the top of the page confirms that the connection is working.


5. The Integration Settings will now show. Enter the following information:

• File (with path) - The full file name including the path to the folder of the file.
• CSV delimiter - The delimiter used for values in the file. Choose from comma, tab, or semicolon.
• Remove users - When this option is active, any existing users not included in the file will be deleted.
• Activate users - When this option is active, any new user added via the SFTP integration will receive the status 'Active' and immediately start receiving training invitations and/or simulations.
  If this option is inactive, new users added via the SFTP integration will receive the status 'Pending'. An administrator will need to manually activate them for the training program to begin."
• Import groups - When this option is active, new groups will be automatically created in the Nimblr portal if the file contains groups that did not previously exist there.
• Group auditors - When this option is active, the system will automatically create group auditors based on the manager_email field in the file. Group auditors have limited read-only access to reports and statistics and will, by default, receive a monthly report by email.

6. Click Save and Sync. Within a few minutes, your users will be imported/synchronized. If an error occurs, a message will appear. See the example below.

The system will automatically import/synchronize via the SFTP integration on a daily basis. When updating the file on the SFTP server, the same filename should be retained, and the existing file should be overwritten. View other integration options on Integration overview page.