Sync Users

FTP / SFTP IP address

URL of the (S)FTP server where the user data is located

Port

(S)FTP server port to be used

Protocol

Dropdown list to chose between FTP and SFTP

Authentication method

Select the authentication method:

• Password
• Key

Only available for SFTP servers

Username

Username for authentication with (S)FTP server

Password

Password to authentication with (S)FTP server

Only available for FTP server or SFTP server with authentication type "password"

Public key

Public key for authentication with SFTP server.

Only available for authentication type "key"

Private key

Private key for authentication with SFTP server.

Only available for authentication type "key"

Passphrase

Passphrase for authentication with SFTP server.

Only available for authentication type "key"

File format

Select the file format of the user list:

• csv
• xlsx
• xml

File Name (incl. file extension)

Relative path & filename of the user list. May contain wildcards.

E.g. /sguard/users.csv

E-Mail for reports

Allows to specify an e-mail address to which a report will be sent after synchronization.

Keep source file copy

Defines if the source file (original user list) shall be kept within the results folder.

Is the file encoded?

Enable if the file is encrypted

Cipher

Define which cipher is used:

• AES-256-CBC
• DES-CBC
• RC2-CBC

Only available if file encryption is enabled.

Password

Encryption password.

Only available if file encryption is enabled.

Mapping file

Allows to upload a mapping file which defines the mapping between xml tags and user attributes in s.GUARD.

Additionally to defining the attribute mapping, the mapping file allows to define the synchronization type (e.g. allow to only add users, allow to add and modify users, allow to add & modify & delete users)

Note: the mapping file has be provided by the s.GUARD support team.

Start row

Defines the first row to be taken into account for data processing.

Examples:

1 - Data will be processed starting from the first row

2 - Data will be processed starting from the second row (e.g. because the first row contains headers)

End row

Defines the last row to be taken into account for data processing.

0 means that all available rows shall be processed.

Delimiter

Defines the column delimiter.

This is only applicable for csv files.

Use as identifier

Defines the criteria to match users between synchronization runs:

• Client ID: users with the same client ID are considered to refer to the same entity
• Email: users with the same login e-mail are considered to refer to the same entity

Ignore invalid

If enabled, invalid entries will be ignored and the synchronization process continues.

Use default

Click to return all settings to the default values.

Client ID

Unique identifier (e.g. employee number)

Mandatory field

Status

User status (active / inactive)

Mandatory field

First name

First name

Mandatory field

Last name

Last name

Mandatory field

Language

Language of the user (EN, DE, FR, IT, NL)

Mandatory field

Email

Login e-mail address

Group name

Name of the user group the user should be added to

User groups

ID(s) of the user group(s) that the user should be added too.

If the user shall be added to more than one group, separate the group IDs with a comma

Business role

Business role

User groups names

Name(s) of the user group(s) that the user should be added to.

If the user shall be added to more than one group, separate the group names with a comma

User template

ID of the user template which shall be applied for newly created users

Channels

Allows to select any of the channels which are configured for this tenant

Custom property

Allows to select any of the custom properties which are configured for this tenant

Activate

If enabled, the synchronization will be executed repeatedly in the defined period

Start time

Time of day when the synchronization shall be started

Period

Defines how often the synchronization shall be executed:

• Hourly
• Daily
• Weekly
• Monthly
• Yearly

Further options

Depending on the chosen period, further configuration options become available to define the time span between two synchronizations.

Examples:

• Daily at 5 AM
• Every Monday
• Every 1st day of the month

Connection test

Click "check" button to verify if s.GUARD can establish a connection to the (S)FTP server

Synchronize file manually

Click button to start a synchronization run manually

Logs storage

Drop down which allow to select the storage location of the synchronization logs:

• None - No logs are stored at all
• Remote server - Logs are stored on the (S)FTP server
• Local server - Logs are stored in the s.GUARD database

Download Logs

Click to download the latest synchronization log

Mapping file

Allows to upload a mapping file which defines the mapping between SCIM attributes and user attributes in s.GUARD.

Note: the mapping file has be provided by the s.GUARD support team.

Status

If enabled, the (S)FTP synchronization will trigger the events which are defined below

Event information (Critical Sync Failure)

Select an event to be triggered in case an error occurs during synchronization

Event information (Sync Success)

Select an event to be triggered after successful synchronization

Event information (Warning Sync Failure)

Select an event to be triggered in case a warning occurs during synchronization