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 DescriptionRequired
departmentstringUser’s department
displayNamestringUser’s display name.Yes
emailstringThe primary email of the user.Yes
familyNamestringThe family name of the user.
givenNamestringThe given name of the user.
titlestringUser’s title.
nicknamestringUser’s nickname.
organizationstringUser’s organization.
timezonestringUser timezone. e.g. America/Los_Angeles.
userNamestringUnique identifier defined by the provisioning clientYes
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.