Skip to main content

Attributes

Identity Attribute

There are 2 json files which distributes the identity in IDHub. One is Account.json for Accounts and Entitlement.json for Entitlements
Attribute NameAttribute TypeAttribute Description
idstringUnique Identifier of Identity
namestringName of Identity
endpointstringEndpoint name of Identity
descriptionstringDescription of Identity
schemastringSchema path of Identity

Account Attribute

Below are the default attributes that Account.json can accommodate to fetch account related information from your Microsoft AD instance.
Attribute NameAttribute TypeAttribute DescriptionRequiredSample Value
idstringA unique, immutable identifier assigned to the user object within Active Directory.False3f1b5a72-2d4f-4a1b-9a77-9bfb1aab1234
cnstringThe user’s canonical name within Active Directory, representing the user object’s distinguished naming attribute.FalseCN=john.doe,OU=Employees,DC=example,DC=com
companystringThe name of the organization or company the user is affiliated with.FalseExample Corporation
departmentstringThe internal department or business unit to which the user belongs.FalseInformation Technology
displayNamestringThe full display name shown in address lists, typically combining first and last name.FalseJohn Doe
givenNamestringThe user’s legal first name as stored in Active Directory.TrueJohn
snstringThe user’s surname or last name.TrueDoe
employeeIDstringA unique identifier assigned to the user by the organization for employment or HR purposes.FalseE12345
employeeTypestringThe classification of the user within the organization (e.g., Employee, Contractor, Vendor).FalseEmployee
mailstringThe primary email address associated with the user’s Active Directory account.Truejohn.doe@example.com
sAMAccountNamestringThe Windows logon name used for legacy authentication and domain sign-in, limited to 20 characters.Truejdoe
streetAddressstringThe first line of the user’s business or residential physical address.False123 Main St
postOfficeBoxstringAn optional P.O. Box number associated with the user’s mailing address.FalsePO Box 789
lstringThe city component of the user’s physical or mailing address.FalseSeattle
ststringThe state or province component of the user’s address.FalseWashington
postalCodestringThe ZIP or postal code associated with the user’s address.False98109
costringThe full name of the country where the user resides or works.FalseUnited States
telephoneNumberstringThe user’s primary business telephone number.False+1 206 555 0198
titlestringThe user’s formal job title or role within the organization.FalseSystems Administrator
userPrincipalNamestringThe user’s sign-in identity in email-format (UPN), typically used for modern authentication.Falsejohn.doe@example.com
userAccountControlstringA system attribute that defines the account status and user-level access flags (e.g., enabled/disabled).False512
managerLoginstringThe Active Directory login name of the user’s direct manager.Falseasmith
managerDisplayNamestringThe full display name of the user’s direct manager.FalseAlice Smith
managerstringThe Distinguished Name (DN) of the user’s manager within Active Directory.FalseCN=Alice Smith,OU=Managers,DC=example,DC=com

Other Attributes

Other Attributes can be included by support team are discussed here
Attribute NameAttribute TypeAttribute Description
initialsstringMiddle Name/Initials
DescriptionstringDescription
physicalDeliveryOfficeNamestringOffice
wWWHomePagestringWeb Page
passwordstringPassword
cstringCountry 2 Digit Code - e.g., US
countryCodestringCountry Code - e.g., 840 for the US
memberOfstringAdd to Groups
removememberOfstringRemove from Groups
accountExpiresstringAccount Expires (use the same date format as the server)
userAccountControlstringUser Account Control
thumbnailPhoto / exchangePhoto (supports high resolution photos) / jpegPhoto / photo / thumbnailLogostringUser Photo
profilePathstringProfile Path
scriptPathstringLogin Script
homeDirectorystringHome Folder
homeDrivestringHome Drive
userWorkstationsstringLog on to
homePhonestringHome
pagerstringPager
mobilestringMobile
facisimileTelephoneNumberstringFax
ipPhonestringIP Phone
infostringNotes
titlestringTitle
managerstringManager
mailNickNamestringMail Alias
displayNamePrintablestringSimple Display Name
msExchHideFromAddressListsstringHide from Exchange Address Lists
submissionContLengthstringSending Message Size (KB)
delivContLengthstringReceiving Message Size (KB)
msExchRequireAuthToSendTostringAccept Messages from Authenticated Users Only
unauthOrigstringReject Messages From
authOrigstringAccept Messages From
publicDelegatesstringSend on Behalf
altRecipientstringForward To
deliverAndRedirectstringDeliver and Redirect
msExchRecipLimitstringRecipient Limits
mDBuseDefaultsstringUse Mailbox Store Defaults
mDBStorageQuotastringIssue Warning at (KB)
mDBOverQuotaLimitstringProhibit Send at (KB)
mDBOverHardQuotaLimitstringProhibit Send and Receive at (KB)
deletedItemFlagsstringDo not Permanently Delete Messages Until the Store Has Been Backed Up
garbageCollPeriodstringKeep Deleted Items for (days)
msExchOmaAdminWirelessEnablestringOutlook Mobile Access
protocolSettingsstringOutlook Web Access
tsAllowLogonstringAllow Terminal Server Logon
tsProfilePathstringTerminal Services Profile Path
tsHomeDirstringTerminal Services Home Directory
tsInheritInitialProgramstringStart the Following Program at Logon
tsInitialProgramstringStarting Program File Name
tsWorkingDirstringStart In
tsDeviceClientDrivesstringConnect Client Drive at Logon
tsDeviceClientPrintersstringConnect Client Printer at Logon
tsDeviceClientDefaultPrinterstringDefault to Main Client Printer
tsTimeOutSettingsDisConnectionsstringEnd Disconnected Session
tsTimeOutSettingsConnectionsstringActive Session Limit
tsTimeOutSettingsIdlestringIdle Session Limit
tsBrokenTimeOutSettingsstringWhen Session Limit Reached or Connection Broken
tsReConnectSettingsstringAllow Reconnection
tsShadowSettingsstringRemote Control
preventDeletionstringProtect Accidental Deletion
managerCanUpdateMembersstringManager Can Update Members
primaryGroupIDstringPrimary Group ID
msExchAdminGroupstringAdministrative Group
msExchHomeServerNamestringExchange Server Name
managedBystringManaged By

Entitlement Attribute

Below are the default entitlement attributes that Entitlement.json can accommodate to fetch entitlements like Group etc from your Microsoft AD instance.
Attribute NameAttribute TypeAttribute DescriptionRequired
cnstringThe name of the group.Yes
namestringThe name of the group.Yes
descriptionstringThe description of the groupYes
wWWHomePagestringThis is the custom attribute for Client
schemasstringThe schemasattribute is an array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure. This attribute may be used by parsers to define the attributes present in the JSON structure that is the body to an HTTP request or response. Each String value is an unique URI.Yes