identitystore/aws.sdk.kotlin.services.identitystore.model/User

User

class User

A user object that contains the metadata and attributes for a specified user.

Types

object Companion

Properties

val addresses: List<Address>?

A list of Address objects containing addresses associated with the user.

val birthdate: String?

The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.

val createdAt: Instant?

The date and time the user was created.

val createdBy: String?

The identifier of the user or system that created the user.

val displayName: String?

A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."

val emails: List<Email>?

A list of Email objects containing email addresses associated with the user.

val extensions: Map<String, Document?>?

A map of explicitly requested attribute extensions associated with the user. Not populated if the user has no requested extensions.

val externalIds: List<ExternalId>?

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

identityStoreId

val identityStoreId: String

The globally unique identifier for the identity store.

val locale: String?

A string containing the geographical region or location of the user.

val name: Name?

An object containing the name of the user.

val nickName: String?

A string containing an alternate name for the user.

val phoneNumbers: List<PhoneNumber>?

A list of PhoneNumber objects containing phone numbers associated with the user.

val photos: List<Photo>?

A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.

preferredLanguage

val preferredLanguage: String?

A string containing the preferred language of the user. For example, "American English" or "en-us."

val profileUrl: String?

A string containing a URL that might be associated with the user.

val revision: String

The current revision of the user in the identity store. This value changes each time the user is modified. You can provide it as the Revision parameter of an UpdateUser or DeleteUser request to make the operation conditional on the user not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.

val roles: List<Role>?

A list of Role objects containing roles associated with the user.

val timezone: String?

A string containing the time zone of the user.

val title: String?

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

val updatedAt: Instant?

The date and time the user was last updated.

val updatedBy: String?

The identifier of the user or system that last updated the user.

val userArn: String

The Amazon Resource Name (ARN) of the user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

val userId: String

The identifier for a user in the identity store.

val userName: String?

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

val userStatus: UserStatus?

The current status of the user account.

val userType: String?

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

val website: String?

The user's personal website or blog URL. This field stores website information for personal or professional use.

Functions

inline fun copy(block: User.Builder.() -> Unit = {}): User

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String