v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1480317256.9 KB

Provides information regarding the user.

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

Headers

X-Amz-Target'WorkMailService.DescribeUser' required

Request body

OrganizationIdstring required

The identifier for the organization under which the user exists.

UserIdstring required

The identifier for the user to be described.

Response

Success

UserIdstring

The identifier for the described user.

Namestring

The name for the user.

Emailstring

The email of the user.

DisplayNamestring

The display name of the user.

State'ENABLED' | 'DISABLED' | 'DELETED'

The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

UserRole'USER' | 'RESOURCE' | 'SYSTEM_USER'

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.

EnabledDatestring date-time

The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.

DisabledDatestring date-time

The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.