Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14198281.1 KB

Retrieves the user metadata and attributes from the <code>UserId</code> in an identity store.

post/#X-Amz-Target=AWSIdentityStore.DescribeUser

Headers

X-Amz-Target'AWSIdentityStore.DescribeUser' required

Request body

IdentityStoreIdstring required

The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

UserIdstring required

The identifier for a user in the identity store.

Response

Success

UserNamestring password

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.

UserIdstring required

The identifier for a user in the identity store.

DisplayNamestring password

The display name of the user.

NickNamestring password

An alternative descriptive name for the user.

ProfileUrlstring password

A URL link for the user's profile.

UserTypestring password

A string indicating the type of user.

Titlestring password

A string containing the title of the user.

PreferredLanguagestring password

The preferred language of the user.

Localestring password

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

Timezonestring password

The time zone for a user.

IdentityStoreIdstring required

The globally unique identifier for the identity store.