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 Atlassian instance.
Attribute NameAttribute TypeAttribute DescriptionRequiredSample Value
departmentstringThe user’s department or functional business unit as displayed in Atlassian user profiles and used for organizational grouping.FalseInformation Technology
displayNamestringThe full display name of the user as shown throughout Atlassian Cloud products, including Confluence, Jira, and People Directory.TrueJohn Doe
emailstringThe user's primary email address, used as the main identity for Atlassian Cloud authentication and notifications. Must be unique and immutable.True[email protected]
familyNamestringThe user's legal last name (surname). Displayed in Atlassian user profiles and used for search, sorting, and identification.FalseDoe
givenNamestringThe user’s legal first name. Displayed prominently across Atlassian Cloud apps—e.g., mentions, profile cards, and user pickers.FalseJohn
titlestringThe user’s job title or professional designation displayed on Atlassian user profiles and People Directory.FalseSenior Software Engineer
nickNamestringAn informal or preferred name for the user, optionally displayed in Atlassian user profile fields depending on configuration.FalseJohnny
organizationstringThe organization or company name associated with the user as stored in Atlassian Cloud profile metadata.FalseExample Corporation
timezonestringThe user’s preferred timezone used across Atlassian Cloud (e.g., task timestamps, notifications). Must use IANA timezone format.FalseAmerica/Los_Angeles
userNamestringA unique identifier for the user defined by the provisioning client. Atlassian SCIM enforces global uniqueness. Required when creating or updating a user.Truejdoe
tip

The email attribute only fetches accounts from domains belonging to the domain of the admin email (service account).

Other Attributes

Other Attributes can be included by support team are discussed here
Attribute NameAttribute TypeAttribute Description
accountIdstringA additional unique identifier for an Atlassian user. This is an Account ID which is not changed.
accountTypestringThe type of account that the user belongs to.
localestringThe default location of the user for the purpose of localizing items.
groupsstringThe list of groups that the user belongs to.
projectRolesdateTimeThe list of roles that the user belongs to.

Entitlement Attribute

Below are the default entitlement attributes that Entitlement.json can accommodate to fetch entitlements like Group, Project Roles etc from your Atlassian instance.
Attribute NameAttribute TypeAttribute DescriptionRequired
descriptionstringDescription of entitlement.Yes
displayNamestringThe entitlement (Group / Project Role / Space) name.Yes
typestringIndicate type of entitlementYes
formstringEntitlement Form containing Entitlement Attributes.
tip

The form contains attributes like projectId, spaceId etc. which are specific to entitlement type.