User

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

IdentityStoreId

The globally unique identifier for the identity store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

UserId

The identifier for a user in the identity store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 47.

Pattern: ([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}

Required: Yes

Addresses

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

Type: Array of Address objects

Array Members: Fixed number of 1 item.

Required: No

Birthdate

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

CreatedAt

The date and time the user was created.

Type: Timestamp

Required: No

CreatedBy

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

Type: String

Required: No

DisplayName

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

Prefix search supports a maximum of 1,000 characters for the string.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

Emails

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

Type: Array of Email objects

Array Members: Fixed number of 1 item.

Required: No

ExternalIds

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

Type: Array of ExternalId objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

Locale

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

Name

An object containing the name of the user.

Type: Name object

Required: No

NickName

A string containing an alternate name for the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

PhoneNumbers

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

Type: Array of PhoneNumber objects

Array Members: Fixed number of 1 item.

Required: No

Photos

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

Type: Array of Photo objects

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Required: No

PreferredLanguage

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

ProfileUrl

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

Timezone

A string containing the time zone of the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

Title

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

UpdatedAt

The date and time the user was last updated.

Type: Timestamp

Required: No

UpdatedBy

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

Type: String

Required: No

UserName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Required: No

UserStatus

The current status of the user account.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

UserType

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

Website

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

User

Contents

See Also