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

DescribeUserResponse

class DescribeUserResponse

Types

object Companion

Properties

val addresses: List<Address>?

The physical address of the user.

val birthdate: String?

The user's birthdate in YYYY-MM-DD format. This field returns the stored 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?

The display name of the user.

val emails: List<Email>?

The email address of 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?

The name of the user.

val nickName: String?

An alternative descriptive name for the user.

val phoneNumbers: List<PhoneNumber>?

A list of PhoneNumber objects associated with a user.

val photos: List<Photo>?

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

preferredLanguage

val preferredLanguage: String?

The preferred language of the user.

val profileUrl: String?

A URL link for the user's profile.

val timezone: String?

The time zone for a user.

val title: String?

A string containing the title of the user.

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 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.

val website: String?

The user's personal website or blog URL. Returns the stored website information for the user.

Functions

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

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

open override fun hashCode(): Int

open override fun toString(): String