For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Platform On-Prem
    • Overview
    • Navigate
        • Overview
          • Configure
          • Synchronize Entra ID groups
          • Set up SSO
          • Configure usernames
          • Configure settings
    • Search resources
  • Apps
    • FlowAI
    • Itential Automation Gateway
  • Resources
    • Itential Academy
    • Version lifecycle
    • Itential MCP
    • Accessibility conformance
    • Get support
    • FAQs
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • Why this matters
  • Property schema
Platform On-PremControl accessAuthenticationAzure AD

Configure usernames in Azure AD

Was this page helpful?
Previous

Configure Azure AD settings in Platform

Next
Built with

Administrators who use the Itential Azure AD AAA adapter can use the usernameKey property field to configure a specific claim in the AAA response for Itential Platform to use as the username. If the usernameKey field is not specified, the adapter uses the default claim name to set new users.

To configure the usernameKey field, navigate to Admin Essentials. 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 claim in the usernameKey field.

Configure usernameKey in the Azure adapter

Why this matters

The usernameKey provides administrators with a configurable option to specify a custom or optional claim in the AAA response for Itential Platform to authenticate a user. As long as the configured attribute is confirmed to be unique in the Azure/EntityID database, specifying the usernameKey as an attribute of a custom or optional claim also prevents multiple users from having the same Azure/EntityID display name in one Itential Platform account.

The custom attribute that is chosen must contain a value. It cannot be blank or not found; otherwise, the user is unable to log in to Itential Platform.

Property schema

1"usernameKey": {
2 "type": "string",
3 "description": "Key of the user token to be utilized as the username",
4 "default": "name"
5}