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 basic fields and tags of Users present in your AWS instance.
Attribute NameAttribute TypeAttribute DescriptionRequired
arnstringThe ARN of the user
idstringThe unique ID for the user
citystringThe city in which the user is located. Maximum length is 128 characters.
companyNamestringThe company name which the user is associated.
countrystringThe country/region in which the user is located.
departmentstringThe name for the department in which the user works.
displayNamestringThe name displayed in the address book for the user.Yes
employeeIdstringThe employee identifier assigned to the user by the organization.
employeeTypestringCaptures enterprise worker type.
firstNamestringThe given name (first name) of the user.
jobTitlestringThe users job title.
mailstringThe SMTP address for the user.
mobilePhonestringPrimary cellular telephone number for the user.
pathstringThe path of the user.
postalCodestringThe postal code for the users postal address.
statestringThe state or province in the users address.
streetAddressstringThe street address of the users place of business.
lastNamestringThe users surname (family name or last name).
statestringState or province in the user's address.
locationstringLocation of user.
userNamestringThe name of the user, which can be used for signing in to the AWS Management Console.Yes

Other Account Attributes

Other Account Attributes can be included by support team are discussed here
Attribute NameAttribute TypeAttribute Description
CreateDatestringCreation date of the user.
ConsoleAccessstringPassword status of the user.
GroupsstringGroups the user is a part of
AWSManagedPoliciesstringAWS Managed Policies directly assigned to the user
CustomerManagedPoliciesstringCustomer Managed Policies directly assigned to the user.
InlinePoliciesstringInline Policies directly assigned to the user.
Access KeysstringAccess keys associated with the user.
AWS CodeCommit HTTPS CredentialstringAWS CodeCommit HTTPS Git credentials associated with the user
AWS CodeCommit SSH KeysstringAWS CodeCommit SSH public keys associated with the user.
Signing CertificatesstringSigning Certificates associated with the user.
Multi-Factor Authentication DevicestringMulti-Factor Authentication device associated with the user.
PasswordLastUsedstringPassword last used date of the user.
AccessKeyLastUsedstringAccess key last used details of the user.
TagsstringTag list in the format TagKey~TagValue pair

Entitlement Attribute

Below are the default entitlement attributes that Entitlement.json can accommodate to fetch entitlements like Group etc from your AWS instance.
Attribute NameAttribute TypeAttribute DescriptionRequired
descriptionbooleanDescription of entitlementYes
displayNamestringDisplay Name of Entitlement. Maximum length: 256 charactersYes
entitlementArnstringThe ARN of the entitlement.
typestringIndicate type of entitlementYes
used asstringIndicate mode of assignment of entitlementYes

Other Entitlement Attributes

Other Entitlement Attributes can be included by support team are discussed here
Attribute NameAttribute TypeAttribute Description
Type: Group
GroupIdStringUnique ID of the group.
PathStringPath to the group.
CreateStringCreation date of the group.
AWSManagedPoliciesAWSManagedPolicyAWS Managed Policies directly assigned to the group.
CustomerManagedPoliciesCustomerManagedPolicyCustomer Managed Policies directly assigned to the group.
InlinePoliciesInlinePolicyInline Policies directly assigned to the group.
Type: AWSManagedPolicy
PolicyIdStringThe unique ID of the AWS managed policy.
PathStringThe path to the AWS managed policy.
CreateDateStringThe creation date of the AWS managed policy.
UpdateDateStringThe last update date of the AWS managed policy.
DefaultVersionIdStringThe currently enabled version ID of the AWS managed policy.
PolicyJSONStringThe JSON document for the AWS managed policy.
Type: Customer Managed Policy
PolicyIdStringThe unique ID of the customer managed policy.
CreateDateStringThe creation date of the customer managed policy.
UpdateDateStringThe last update date of the customer managed policy.
PathStringThe path to the customer managed policy.
DefaultVersionIdStringThe currently enabled version ID of the customer managed policy.
PolicyJSONStringThe JSON document for the customer managed policy.
PolicyGroupsStringGroups attached to the customer managed policy.
PolicyRolesStringRoles attached to the customer managed policy.
TagsStringTag list in the format TatKey~TagValue pair
Type: InlinePolicy
IdStringThe unique ID of the policy.This is an Identity Attribute which must not be changed.
PolicyJSONStringThe JSON document for the policy.
Type: Role
RoleIdStringThe unique ID of the role.
PathStringPath to the Role.
CreateDateStringCreation date of the role.
AWSManagedPoliciesAWSManagedPolicyAWS Managed Policies directly assigned to the role.
CustomerManagedPoliciesCustomerManagedPolicyCustomer Managed Policies directly assigned to the role.
InlinePoliciesInlinePolicyInline Policies directly assigned to the role.
TrustPolicyJSONStringTrust Relationship Policy JSON.
MaxSessionDurationStringMaximum CLI/API session duration.
TagsStringTag list in the format TagKey~TagValue pair
Type: SCP
SCPIdStringThe unique ID of the Service Control Policy.
AWSManagedStringA boolean value that indicates whether the Service Control Policy is an AWS managed policy.
PolicyJSONStringThe JSON document for the Service Control Policy.
TagsStringTag list in the format TagKey~TagValue pair
Type: AWSAccount
AWSAccountIdStringThe unique ID of the AWS account.
EmailStringThe email address associated with the AWS account.
StatusStringThe status of the AWS account in the organization.
JoinedMethodStringThe method by which the AWS account joined the organization.
JoinedTimestampStringThe date the AWS account became a part of the organization.
OrganizationUnitOrganizationUnitOrganization unit holding the AWS Account.
TagsStringTag list in the format TagKey~TagValue pair
Type: OrganizationUnit
OUIdStringThe unique ID of the Organization Unit.
ServiceControlPoliciesSCPService Control Policies attached to the Organization Unit.
ParentOrganizationUnitParent Organization Unit.
AWSAccountsAWSAccountAWS Accounts attached to the Organization Unit.
TagsStringTag list in the format TagKey~TagValue pair