DescribeUser - Amazon WorkMail
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

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

Length Constraints: Fixed length of 34.

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

Required: Yes

UserId

The identifier for the user to be described.

The identifier can be the UserId, Username, or email. The following identity formats are available:

  • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: user@domain.tld

  • User name: user

Type: String

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

Pattern: [a-zA-Z0-9._%+@-]+

Required: Yes

Response Syntax

{
   "City": "string",
   "Company": "string",
   "Country": "string",
   "Department": "string",
   "DisabledDate": number,
   "DisplayName": "string",
   "Email": "string",
   "EnabledDate": number,
   "FirstName": "string",
   "HiddenFromGlobalAddressList": boolean,
   "IdentityProviderIdentityStoreId": "string",
   "IdentityProviderUserId": "string",
   "Initials": "string",
   "JobTitle": "string",
   "LastName": "string",
   "MailboxDeprovisionedDate": number,
   "MailboxProvisionedDate": number,
   "Name": "string",
   "Office": "string",
   "State": "string",
   "Street": "string",
   "Telephone": "string",
   "UserId": "string",
   "UserRole": "string",
   "ZipCode": "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.

City

City where the user is located.

Type: String

Length Constraints: Maximum length of 256.

Company

Company of the user.

Type: String

Length Constraints: Maximum length of 256.

Country

Country where the user is located.

Type: String

Length Constraints: Maximum length of 256.

Department

Department of the user.

Type: String

Length Constraints: Maximum length of 256.

DisabledDate

The date and time at which the user was disabled for 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 WorkMailusage, in UNIX epoch time format.

Type: Timestamp

FirstName

First name of the user.

Type: String

Length Constraints: Maximum length of 256.

HiddenFromGlobalAddressList

If enabled, the user is hidden from the global address list.

Type: Boolean

IdentityProviderIdentityStoreId

Identity Store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

Type: String

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

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

IdentityProviderUserId

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

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}$

Initials

Initials of the user.

Type: String

Length Constraints: Maximum length of 256.

JobTitle

Job title of the user.

Type: String

Length Constraints: Maximum length of 256.

LastName

Last name of the user.

Type: String

Length Constraints: Maximum length of 256.

MailboxDeprovisionedDate

The date when the mailbox was removed for the user.

Type: Timestamp

MailboxProvisionedDate

The date when the mailbox was created for the user.

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,})?

Office

Office where the user is located.

Type: String

Length Constraints: Maximum length of 256.

State

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

Type: String

Valid Values: ENABLED | DISABLED | DELETED

Street

Street where the user is located.

Type: String

Length Constraints: Maximum length of 256.

Telephone

User's contact number.

Type: String

Length Constraints: Maximum length of 256.

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 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, SYSTEM_USER, and REMOTE_USER.

Type: String

Valid Values: USER | RESOURCE | SYSTEM_USER | REMOTE_USER

ZipCode

Zip code of the user.

Type: String

Length Constraints: Maximum length of 256.

Errors

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

DirectoryServiceAuthenticationFailedException

The directory service doesn't recognize the credentials supplied by WorkMail.

HTTP Status Code: 400

DirectoryUnavailableException

The directory is unavailable. It might be located in another Region or deleted.

HTTP Status Code: 400

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