Here you can find common settings for all user directories.
Display options
At the top of the user directory editor there will be display options for the user directory. The current options include:
Enabled, this will enable/disable the user directory, if the user directory is disabled it cannot be used to login. If the user directory is enabled the Enabled text will be green.
Directory display name, this will change the display name of the user directory. This will be the name that will be found when selecting user directories.
Directory alias, TODO
Directory icon, is a small icon that will be usually shown next to the user directory display name. User directories will have a default icon but custom directory icons can be uploaded. Max file size is 2 Megabytes.
Login translations
If you want to customise login button/select translations that are visible to user when selecting or signing in via this directory, you can do that in Login translations tab.
Directory login captions can be added for every language / locale you need, just press Add button and select appropriate language and country. In most cases, it is useful to only select translation language and leave country unselected unless you really need different translations for, for example, British and American English.
Directory login descriptions are currently not used but maybe used in future to provide additional details about this directory.
User information
Most of the following user attribute mappings are available in every supported user directory. Ignore any mappings not available in the directory type you are configuring. Default values differ between directory types.
Attribute mappings can take multiple values in order of preference, separated by comma.
Field | Description | Default value | Example value |
|---|---|---|---|
Allow creating new users | Allow or deny creating new users. If you want to allow every user from directory to sign in to TrivoreID, you need to check this. If not checked, only existing users can link their accounts with external directory accounts | False (not checked) | N/A |
Link ID *required | Permanent, non-secretive user identifier from external directory. | Depends on directory |
|
Encrypt link ID using salted hash algorithm | Will encrypt the Link ID described above. This will allow for more security. | False (Not checked) | N/A |
How to handle conflicts with soft deleted users | Action to be performed upon detecting conflicts with soft deleted users | Existing soft deleted user causes conflict. Sign in is not possible | N/A |
Username import policy | How to handle usernames in TrivoreID. This option exists in order to guarantee username uniqueness within a namespace, which is a technical requirement. You can choose to import usernames from an external directory but the preferred method is to generate them automatically using default settings. | Automatic namespace username policy (actual value depends on the configured policy in namespace settings) | N/A |
Update username if it does match match given settings | Updates username if it matches the given settings. | False (Not checked) | N/A |
Username | Attribute from external directory that provides user’s username | Depends on directory |
|
Username prefix | Add username prefix with this literal value |
| N/A |
Username suffix | Add username suffix with this literal value |
| N/A |
Update username if it does match given settings | Update user’s username on every successful login if it does not match given settings. Very rarely needed feature | False (not checked) | N/A |
Friendly name | Friendly name for user’s external directory account that helps s/he identify it. Only useful if users are given access to manage their account linkings (add, edit, remove links) | Depends on directory |
|
First name | Attribute from external directory that provides user’s first name | Depends on directory |
|
Last name | Attribute from external directory that provides user’s last name | Depends on directory |
|
Full name | Attribute from external directory that provides user’s full name, including both first and last name and possible middle names. This is only useful if separate attributes for first and last name are not available. | Depends on directory |
|
Attribute from external directory that provides user’s email | Depends on directory |
| |
Email verified | Attribute from external directory that provides user’s email verification information. Boolean attribute. May not be available | Depends on directory |
|
Mobile | Attribute from external directory that provides user’s mobile number | Depends on directory |
|
Mobile verified | Attribute from external directory that provides user’s mobile number verification information. Boolean attribute. May not be available | Depends on directory |
|
Locale / language | Attribute from external directory that provides user’s language or localisation information | Depends on directory |
|
Photo URL | Attribute from external that provides user’s photo URL. Actual implementation varies between different directory types. | Depends on directory |
|