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 |
---|---|---|---|
department | string | User’s department | |
displayName | string | User’s display name. | Yes |
email | string | The primary email of the user. | Yes |
familyName | string | The family name of the user. | |
givenName | string | The given name of the user. | |
title | string | User’s title. | |
nickname | string | User’s nickname. | |
organization | string | User’s organization. | |
timezone | string | User timezone. e.g. America/Los_Angeles. | |
userName | string | Unique identifier defined by the provisioning client | Yes |
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.