This article covers how to manage users and groups through Secure FTP (SFTP).
What is SFTP
SFTP stands for Secure File Transfer Protocol. SFTP allows automatically importing files to create, update, and delete users, groups, memberships, and facilities. Each file type has its own set of column name requirements, see the sections below for detailed explanations, or download our example files. The standard SFTP integration supports uploading a single file for each data type (groups, users, memberships, and facilities). If you need to upload more than one file for any given data type, please contact your Account Manager or reach out to us at support@konexus.com.
How Often can File be Uploaded
Automatic imports can occur at any interval that best fits your organization’s needs. Typically uploads occur either daily or weekly.
What Data can be Transferred via SFTP
Users
The following columns are required when importing a user file:
- UniqueId - A unique identifier (Badge Number, User ID, Employee ID, etc.)
- First Name
- Last Name
The following columns are common, but not required:
- Role (if the role column is included, values must match a known role in the system)
- Title
- Cell Phone
- Business Phone
- Location - if provided, user locations will be displayed for geo-fenced alerting
- AssetId - required if importing facility data. Users will be associated to the correct facility if a match is found. Values are matched to the UniqueId column in the facility file
If you are wanting to manage public users through SFTP, an additional column will need to be added.
- Column Name: Classification
- Column Values:
- Internal - used for any internal users within the file
- Public - used for any public users within the file
Public users apply to Government clients and Public Alerting Authorities.
The last column of the user file should be called MemberImport and all rows should be empty.
Example:
| uniqueId | firstName | lastName | cellphone | title | role | MemberImport | |
Groups
Required columns (in order)
- uniqueId - unique ID for the group
- parentId - the unique ID for the parent group if the group is a subgroup. If the group is not a subgroup leave this cell blank.
- groupName
- GroupStructureImport - leave all rows blank, this notates the file data type
If you are wanting to manage public groups through SFTP, two additional column will need to be added.
- Column Name: Classification
- Column Values:
- Internal - used for any internal groups within the file
- Public - used for any public groups within the file
- Column Name: ShowOnPublicSignUp
- Column Values:
- True
- False
Public groups apply to Government clients and Public Alerting Authorities.
The last column of the group file should be called GroupStructureImport and all rows should be empty.
Example
|
uniqueId |
parentId |
groupName |
GroupStructureImport |
Group Memberships
Required columns (in order)
- memberId - unique ID of the associated user
- groupId - unique ID of the group the user belongs to
- groupName
- GroupMembershipImport - leave all rows blank, this notates the file data type
The last column of the membership file should be called GroupMembershipImport and all rows should be empty.
Users and groups should not be mixed when nesting groups. Users should only be added to the lowest level of nesting within a group structure
Good:
- Departments
- Security
- User 1
- Facilities
- User 2
- Security
Bad:
- Departments
- Security
- User 1
- Facilities
- User 2
- User 3
- Security
Example
|
memberId |
groupId |
groupName |
GroupMembershipImport |
Facility Files
Facilities
The following columns are required when importing a facilities file:
- UniqueId - A unique identifier for the facility
- FacilityName
- LocationType
- FacilityLocation - Latitude/Longitude of the facility
- FacilityAddress1
- FacilityAddress2
- FacilityCity
- FacilityState
- FacilityCountry
- FacilityPostalCode
- AssetsImport
The last column of the facility file should be called AssetsImport and all rows should be empty.
Example
To see an example please download the Facility Example file below
Facility Definitions
Facility definitions provide additional details about your sites that are used within the our Geo-Fenced Alerting tools.
Both a Facility and Facility Definitions file are required if you would like to import your organization's facility data.
The following columns are required when importing a facility definitions file:
- AttributeName
- AttributeType
- Attributevalue
- This is the only column that will need to be edited from the example file
- The value of this column should match the various LocationType values in the facility file in a semi-colon delimited format
- Example: Data Center;Local Office;Main Office
- AssetsDefinitionImport
The last column of the facility file should be called AssetsDefinitionImport and all rows should be empty.
Example
To see an example please download the Facility Definition Example file below
Example Files
Download Zip file
Download Individual Files
Requirements
There are several requirements and information that is exchanged to establish a connection to the Konexus SFTP server. Upon requesting an SFTP account you will be provided with a more detailed explanation of what is needed and how to connect. You can always reach out to our support team at support@konexus.com to request this information again.
Here are the basic requirements:
- SSH key for Authentication
- Rather than username/password, keypair authentication is used to connect to the server
- Konexus will need the public SSH key that pairs with your private SSH key to create your sftp account
- You will use your private SSH key to connect to the server
- A unique/secure username provided by Konexus
- Konexus only allows known IP Addresses to connect to the server
- The public IP address for any computer you wish to connect with will need to be provided to Konexus