IIdentityStoreDescribeUserResponse
Interface in AWS.IdentityStore
Interface for DescribeUser responses.
Ancestors
Properties
Addresses
property Addresses: TList<IIdentityStoreAddress>
Type: IIdentityStoreAddress
A list of physical addresses associated with the user.
Each address includes structured fields such as StreetAddress, Locality, Region, PostalCode, and Country. Addresses may also include a Formatted display string, a Type label, and a Primary flag indicating the default address. The list may be empty if no address is associated with the user.
DisplayName
property DisplayName: string
A human-readable name to display for the user.
This property represents the preferred display name for the user, typically shown in user interfaces, contact directories, and communication headers. It is distinct from the user's UserName and may include nicknames, titles, or cultural formatting based on regional naming conventions.
Emails
property Emails: TList<IIdentityStoreEmail>
Type: IIdentityStoreEmail
A list of email addresses associated with the user.
Each email entry may include the email Value, a Type such as work or home, and a Primary flag to indicate the default address. AWS Identity Store supports multiple email addresses, but only one may be marked as primary.
ExternalIds
property ExternalIds: TList<IIdentityStoreExternalId>
Type: IIdentityStoreExternalId
A list of external identifiers associated with the user.
Each entry in this list represents a mapping between the AWS Identity Store user and an external identity system, such as a third-party directory service or federated identity provider. Entries typically include an Id value and an optional Issuer string.
IdentityStoreId
property IdentityStoreId: string
The globally unique identifier for the identity store.
Locale
property Locale: string
The user's default locale, expressed as a BCP 47 language tag.
This property indicates the user's cultural or regional preference for formatting, such as en-US for American English or de-DE for German (Germany). It may be used by client applications to adapt content display or input formatting.
Name
property Name: IIdentityStoreName
Type: IIdentityStoreName
A structured object containing components of the user's full name.
The Name object includes fields such as GivenName, FamilyName, MiddleName, HonorificPrefix, HonorificSuffix, and Formatted. This structure enables culturally appropriate display and sorting of names and is compliant with the SCIM 2.0 specification.
NickName
property NickName: string
An informal or preferred name the user is commonly known by.
This property may contain a shortened, alternate, or familiar name, such as Bob for Robert or Katie for Katherine. It is commonly used in user interfaces, messaging apps, and social environments.
PhoneNumbers
property PhoneNumbers: TList<IIdentityStorePhoneNumber>
Type: IIdentityStorePhoneNumber
A list of telephone numbers associated with the user.
Each phone number entry includes a Value (e.g., +1-202-555-0185), an optional Type such as work or mobile, and a Primary flag to indicate the default contact number. This field supports multiple entries, although typically only one is marked as primary.
PreferredLanguage
property PreferredLanguage: string
The user's preferred language for communication and content localization.
This property is expressed as a BCP 47 language tag, such as en, en-GB, or fr-FR. It may be used by client applications to localize messages, interfaces, or documentation based on user preference.
ProfileUrl
property ProfileUrl: string
A URL pointing to the user's external profile or directory entry.
This value may refer to a public-facing profile, intranet directory page, or federated identity record. It is not validated by the Identity Store API and may be omitted if not applicable.
Timezone
property Timezone: string
The user's preferred time zone, expressed using IANA time zone format.
This property indicates the user's time zone for scheduling or localization purposes. Examples include America/Los_Angeles, Europe/Paris, or Asia/Tokyo. While recommended to follow the IANA Time Zone Database, the API does not enforce format validation.
Title
property Title: string
The user's professional title or designation.
This property may describe the user's job function or role, such as Software Engineer, Project Manager, or Vice President, Sales. It is often displayed in contact cards, org charts, or profile summaries.
UserId
property UserId: string
The unique identifier assigned to the user by the identity store.
This identifier is generated when the user is created and is used in subsequent operations such as DeleteUser, DescribeUser, and CreateGroupMembership.
UserName
property UserName: string
The unique user name assigned to the user for login and directory identification.
This value serves as the primary login name and must be unique within the identity store. It may be displayed in UIs or used for lookup and filtering operations.
UserType
property UserType: string
A classification string that describes the user's type or role within the organization.
Common examples include employee, contractor, student, or external. This value is not validated by the API and may be used for internal categorization or filtering.