IIdentityStoreUser
Interface in AWS.IdentityStore
Interface for IdentityStore User.
Properties
Addresses
property Addresses: TList<IIdentityStoreAddress>
Type: IIdentityStoreAddress
A list of physical addresses associated with the user.
Each address entry includes structured fields such as StreetAddress, Locality, Region, PostalCode, and Country, as well as optional Formatted, Type, and Primary values. The list may be empty if no addresses are associated with the user.
DisplayName
property DisplayName: string
A human-readable display name for the user.
This value may be shown in UIs, directories, or communication headers. It is distinct from UserName and does not need to be unique.
Emails
property Emails: TList<IIdentityStoreEmail>
Type: IIdentityStoreEmail
A list of email addresses associated with the user.
Each email entry may include the email Value, an optional Type (e.g., work, home), and a Primary flag to indicate the default email address. The list may contain multiple entries, although only one should be marked as primary.
ExternalIds
property ExternalIds: TList<IIdentityStoreExternalId>
Type: IIdentityStoreExternalId
A list of external identifiers associated with the user.
These identifiers map the user to entries in external identity systems such as Okta or AzureAD. Each entry may include an Id and an optional Issuer.
IdentityStoreId
property IdentityStoreId: string
The identifier of the identity store that contains the user.
This value uniquely identifies the AWS SSO identity store instance in which the user is defined.
Locale
property Locale: string
The user's default locale, represented as a BCP 47 language tag.
This value indicates the user's cultural and regional formatting preferences. Examples include en-US, fr-FR, or de-DE. Client applications may use this to localize content or format dates and numbers appropriately.
Name
property Name: IIdentityStoreName
Type: IIdentityStoreName
A structured object representing the components of the user's full name.
The name object includes fields such as GivenName, FamilyName, Formatted, and optional parts like MiddleName, HonorificPrefix, and HonorificSuffix. This structure allows culturally appropriate display and formatting of names in client applications.
NickName
property NickName: string
An informal or alternate name that the user is commonly known by.
This property may include a nickname, preferred name, or alias such as Bob for Robert. It is often used in user interfaces and social settings.
PhoneNumbers
property PhoneNumbers: TList<IIdentityStorePhoneNumber>
Type: IIdentityStorePhoneNumber
A list of telephone numbers associated with the user.
Each phone number entry may include a Value (e.g., +1-202-555-0199), a Type such as work or mobile, and a Primary flag indicating the default contact number. The list may contain multiple phone numbers, although only one should be marked as primary.
PreferredLanguage
property PreferredLanguage: string
The user's preferred language for communication and display.
This value is expressed as a BCP 47 language tag, such as en, fr-FR, or es. It may be used by client applications to localize content or messages based on user preference.
ProfileUrl
property ProfileUrl: string
A URL pointing to the user's profile or directory page.
This optional field may reference a web-accessible user profile on a corporate directory, social platform, or intranet site. The value must be a valid URL string if present, but is not validated by the Identity Store API.
Timezone
property Timezone: string
The user's preferred time zone, expressed in IANA time zone format.
This value may be used to display or convert times relative to the user's location. Examples include America/New_York, Europe/London, or Asia/Tokyo. The format should follow the IANA Time Zone Database, though it is not validated by the API.
Title
property Title: string
The user's professional title or job designation.
This value describes the user's role within an organization, such as Software Engineer, Team Lead, or Chief Financial Officer. It may be displayed in directories, email signatures, or user profiles.
UserId
property UserId: string
The unique identifier assigned to the user by the identity store.
This value is used to reference the user in other operations such as DescribeUser, CreateGroupMembership, or DeleteUser.
UserName
property UserName: string
The unique user name assigned to the user for login and directory identification.
This is typically a human-readable identifier such as jdoe or jane.doe@example.com, and must be unique within the identity store.
UserType
property UserType: string
A classification that describes the type of user within the organization.
This value may be used to distinguish between different categories of users, such as employee, contractor, external, or student. The value is a free-form string and is not validated by the Identity Store API, but may be used for filtering, auditing, or access control policies.