Configuring Usernames
  • 24 May 2023
  • Dark
  • PDF

Configuring Usernames

  • Dark
  • PDF

Article Summary

Configurable Usernames in Azure AD​

Administrators who use the Itential Azure AD AAA adapter can use the usernameKey property field to configure a specific name attribute in the AAA response for IAP to use as the "username". If the usernameKey field is not specified, the adapter will utilize the default value of "name" to set new users.​

To configure the usernameKey field, navigate to Admin Essentials in IAP. Use the search bar in the left sidebar to locate "Azure" in the Adapters menu list. Under the Configuration tab on the Properties page, enter a specific name in the usernameKey field.

Figure 1: Configure username


Why is this important?

The usernameKey provides Administrators with a configurable option to specify a custom claim in the AAA response for IAP to authenticate a user. Specifying the usernameKey as a custom attribute also prevents multiple users from having the same Azure AD display name in one IAP account. Lastly, if a user's identity is stored in Azure AS (Authentication Server), the Azure AD service can utilize usernameKey to check whether that "username" exists or not.

Property Schema

"usernameKey": {
    "type": "string",
    "description": "Key of the user token to be utilized as the username",
    "default": "name"

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.