Menu
Sign In to the Console
Amazon WorkMail
API Reference (API Version 2017-10-01)

AWS Documentation » Amazon WorkMail » API Reference » Actions » DescribeUser

DescribeUser

Provides information regarding the user.

Request Syntax

{
   "OrganizationId": "string",
   "UserId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

OrganizationId

The identifier for the organization under which the user exists.

Type: String

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

UserId

The identifier for the user to be described.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: Yes

Response Syntax

{
   "DisabledDate": number,
   "DisplayName": "string",
   "Email": "string",
   "EnabledDate": number,
   "Name": "string",
   "State": "string",
   "UserId": "string",
   "UserRole": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DisabledDate

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

Type: Timestamp

DisplayName

The display name of the user.

Type: String

Length Constraints: Maximum length of 256.

Email

The email of the user.

Type: String

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

Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}

EnabledDate

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

Type: Timestamp

Name

The name for the user.

Type: String

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

Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9]{2,})?

State

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

Type: String

Valid Values: ENABLED | DISABLED | DELETED

UserId

The identifier for the described user.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

UserRole

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon 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.

Type: String

Valid Values: USER | RESOURCE | SYSTEM_USER

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

The identifier supplied for the user, group, or resource does not exist in your organization.

HTTP Status Code: 400

InvalidParameterException

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400

OrganizationNotFoundException

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

OrganizationStateException

The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its members.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: