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 Name | Attribute Type | Attribute Description |
|---|---|---|
id | string | Unique Identifier of Identity |
name | string | Name of Identity |
endpoint | string | Endpoint name of Identity |
description | string | Description of Identity |
schema | string | Schema 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 Name | Attribute Type | Attribute Description | Required | Sample Value |
|---|---|---|---|---|
| department | string | The user’s department or functional business unit as displayed in Atlassian user profiles and used for organizational grouping. | False | Information Technology |
| displayName | string | The full display name of the user as shown throughout Atlassian Cloud products, including Confluence, Jira, and People Directory. | True | John Doe |
| string | The user's primary email address, used as the main identity for Atlassian Cloud authentication and notifications. Must be unique and immutable. | True | [email protected] | |
| familyName | string | The user's legal last name (surname). Displayed in Atlassian user profiles and used for search, sorting, and identification. | False | Doe |
| givenName | string | The user’s legal first name. Displayed prominently across Atlassian Cloud apps—e.g., mentions, profile cards, and user pickers. | False | John |
| title | string | The user’s job title or professional designation displayed on Atlassian user profiles and People Directory. | False | Senior Software Engineer |
| nickName | string | An informal or preferred name for the user, optionally displayed in Atlassian user profile fields depending on configuration. | False | Johnny |
| organization | string | The organization or company name associated with the user as stored in Atlassian Cloud profile metadata. | False | Example Corporation |
| timezone | string | The user’s preferred timezone used across Atlassian Cloud (e.g., task timestamps, notifications). Must use IANA timezone format. | False | America/Los_Angeles |
| userName | string | A unique identifier for the user defined by the provisioning client. Atlassian SCIM enforces global uniqueness. Required when creating or updating a user. | True | jdoe |
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 Name | Attribute Type | Attribute Description |
|---|---|---|
accountId | string | A additional unique identifier for an Atlassian user. This is an Account ID which is not changed. |
accountType | string | The type of account that the user belongs to. |
locale | string | The default location of the user for the purpose of localizing items. |
groups | string | The list of groups that the user belongs to. |
projectRoles | dateTime | The 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 Name | Attribute Type | Attribute Description | Required |
|---|---|---|---|
description | string | Description of entitlement. | Yes |
displayName | string | The entitlement (Group / Project Role / Space) name. | Yes |
type | string | Indicate type of entitlement | Yes |
form | string | Entitlement Form containing Entitlement Attributes. |
tip
The form contains attributes like projectId, spaceId etc. which are specific to entitlement type.