IIdentityStoreCreateUserRequest
Interface in AWS.IdentityStore
Interface for CreateUser requests.
Ancestors
Properties
Addresses
property Addresses: TList<IIdentityStoreAddress>
Type: IIdentityStoreAddress
A list of physical addresses associated with the user.
This property contains one or more structured postal addresses representing the user's home, work, or other locations. Each address includes fields such as street address, locality, region, country, and postal code. Addresses are compliant with the SCIM 2.0 schema and may optionally include a Formatted field for display purposes, and a Primary flag to indicate the default address.
DisplayName
property DisplayName: string
A human-readable name for display purposes, such as in directories or user interfaces.
This property represents a friendly or preferred name for the user. It is typically used in application UIs, email headers, or directory listings. This value is distinct from the login user name and does not need to be unique.
Emails
property Emails: TList<IIdentityStoreEmail>
Type: IIdentityStoreEmail
A list of email addresses associated with the user.
This property contains one or more email address entries, each including the address value, optional classification (such as work or home), and a flag indicating the primary address. The Identity Store supports only a single email address in the CreateUser request. If more than one is provided, only the first valid entry will be used.
Email
property Email: IIdentityStoreEmail
Type: IIdentityStoreEmail
A convenience property for setting or retrieving a single email address.
This property provides simplified access to the user's primary email address. Internally, it sets or clears the single entry in the Emails list, as the Identity Store CreateUser operation allows only one. Setting this property replaces the entire Emails list with a new entry. If set to nil, the list will be cleared.
IdentityStoreId
property IdentityStoreId: string
The identifier of the AWS SSO identity store.
Locale
property Locale: string
The user's default locale, such as en-US or fr-FR.
This property represents the user's language and region preferences using an IETF BCP 47 language tag. It may be used by client applications to localize content or format data appropriately.
Name
property Name: IIdentityStoreName
Type: IIdentityStoreName
A structured representation of the user's full name.
This property includes fields such as given name, family name, and honorifics. It allows client applications to store and format names according to regional and cultural preferences. If no value is provided, the user will be created without a structured name.
NickName
property NickName: string
The casual or informal name by which the user is commonly referred to.
This property represents an alternate name such as a nickname, alias, or preferred name that differs from the user's legal or formal name. Examples include Johnny, Liz, or RJ. This value is often used in user interfaces, chat applications, or social contexts where a less formal name is appropriate.
PhoneNumbers
property PhoneNumbers: TList<IIdentityStorePhoneNumber>
Type: IIdentityStorePhoneNumber
A list of phone numbers associated with the user.
This property contains one or more phone number entries, each including the number value, an optional type (such as work or mobile), and a flag indicating the primary number. The Identity Store supports only a single phone number in the CreateUser request. If more than one is provided, only the first valid entry will be used.
PhoneNumber
property PhoneNumber: IIdentityStorePhoneNumber
Type: IIdentityStorePhoneNumber
A convenience property for setting or retrieving a single phone number.
This property provides simplified access to the user's primary phone number. Internally, it sets or clears the single entry in the PhoneNumbers list, as the Identity Store CreateUser operation supports only one. Setting this property replaces the entire PhoneNumbers list with a new entry. If set to nil, the list will be cleared.
PreferredLanguage
property PreferredLanguage: string
The user's preferred language, represented as an IETF BCP 47 language tag.
This property indicates the user's language preference, such as en, en-US, or fr-FR. It may be used by client applications to localize content, interfaces, or communications. The value must follow the BCP 47 specification, but the Identity Store API does not enforce strict validation.
ProfileUrl
property ProfileUrl: string
A URL that points to the user's profile page or external representation.
This property may reference a web-accessible profile for the user, such as a company directory entry, social media profile, or intranet page. The URL is optional and not validated by the Identity Store API, but it should be a well-formed URI if provided.
Timezone
property Timezone: string
The user's time zone, typically in IANA Time Zone format.
This property indicates the user's preferred time zone, such as America/Los_Angeles or Europe/Berlin. It can be used to display local times or schedule events relative to the user's region. The value should follow the IANA Time Zone Database format, but the Identity Store API does not enforce strict validation.
Title
property Title: string
The user's job title or designation.
This property represents the user's professional role or position within an organization, such as Software Engineer, Product Manager, or Chief Financial Officer. It is typically displayed in directories, badges, or organizational charts.
UserName
property UserName: string
The unique user name used to identify the user for login and directory purposes.
This property serves as the user's login identifier and must be unique within the identity store. Examples include jane.doe, jdoe, or janed. The Identity Store does not enforce a specific format, but user names should follow organizational conventions and avoid leading/trailing whitespace.
UserType
property UserType: string
A string that identifies the user's type or classification.
This property is intended to distinguish different categories of users, such as employee, contractor, external, or student. The value is a free-form string and is not validated or restricted by the Identity Store API.
Methods
AddAddress
function AddAddress(const AAddress: IIdentityStoreAddress): NativeInt;
Add an address to Addresses.
Parameters
| Name | Description |
|---|---|
AAddress | Specify an Address to add to Addresses. |
Returns
Returns the index of the Address added to Addresses.