Here you can find instructions how to configure TrivoreID authentication to work with Azure AD. Configuring Azure AD itself is out scope of this document (only general requirements provided).
Configure TrivoreID
First, select User directories from main menu as shown below and click button Add directory.
You will be asked to select directory type. Select Azure AD.
Core settings
Configure necessary settings, including Name, Tenant, Client ID and Client secret. Depending on your use-case, you may also need to adjust Scope value. Default Scope value provides access to basic user information and is sufficient for most use-cases.
Appropriate values for Tenant, Client ID and Client secret all depend on the service provider (the organisation managing the Azure AD instance you are integrating to). Azure AD needs to be configured first before these values are available. You will need the Redirect URL (shown in picture) value when configuring Azure AD. Note that this value is different for every TrivoreID instance.
Field | Description |
|---|---|
Name | Any name you want to choose for this directory. |
Tenant | Azure AD instance unique identifier. |
Client ID | OpenID Connect client_id parameter. |
Client secret | OpenID Connect client_secret parameter. |
User information
After you have configured necessary core settings, you may need to adjust user attribute mappings. Default mappings are suitable for most cases. Attribute mappings can take multiple values in order of preference, separated by comma.
All fields are documented in detail in table below. You do not need to modify these attribute mappings in most use-cases. Default values are usually sufficient.
Field | Description | Default value | Example value from Azure AD |
|---|---|---|---|
Allow creating new users | Allow or deny creating new users. If you want to allow every user from Azure to sign in to Trivore Identity Service, you need to check this. If not checked, only existing users can link their accounts with Azure AD accounts | False (not checked) | N/A |
Link ID | Permanent, non-secretive user identifier from Azure AD. Rarely needs to be modified. | sub |
|
Username import policy | How to handle usernames in Trivore Identity Service. This option exist in order to guarantee username uniqueness within namespace, which is a technical requirement. You can choose to import usernames from Azure but 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 |
Username | Attribute from Azure AD that provides user’s username | preferred_username, unique_name, upn |
|
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 Azure AD account that helps s/he identify it. Only useful if users are given access to manage their account linkings (add, edit, remove links) | preferred_username, unique_name, upn, name |
|
First name | Attribute from Azure AD that provides user’s first name | given_name (OIDC standard attribute) |
|
Last name | Attribute from Azure AD that provides user’s last name | family_name (OIDC standard attribute) |
|
Full name | Attribute from Azure AD 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. | name |
|
Attribute from Azure AD that provides user’s email |
| ||
Email verified | Attribute from Azure AD that provides user’s email verification information. Boolean attribute. May not be available |
|
|
Mobile | Attribute from Azure AD that provides user’s mobile number |
|
|
Mobile verified | Attribute from Azure AD that provides user’s mobile number verification information. Boolean attribute. May not be available |
|
|
Locale / language | Attribute from Azure AD that provides user’s language or localisation information |
|
|
Photo URL | Attribute from Azure AD that provides user’s photo URL. User photos will be fetched from via GraphAPI (not implemented yet). | picture |
|