UpdateUser - Amazon WorkMail
Request SyntaxRequest ParametersResponse ElementsErrorsSee Also

UpdateUser

Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another DescribeUser call.

Request Syntax

{
   "City": "string",
   "Company": "string",
   "Country": "string",
   "Department": "string",
   "DisplayName": "string",
   "FirstName": "string",
   "HiddenFromGlobalAddressList": boolean,
   "IdentityProviderUserId": "string",
   "Initials": "string",
   "JobTitle": "string",
   "LastName": "string",
   "Office": "string",
   "OrganizationId": "string",
   "Role": "string",
   "Street": "string",
   "Telephone": "string",
   "UserId": "string",
   "ZipCode": "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.

City

Updates the user's city.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Company

Updates the user's company.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Country

Updates the user's country.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Department

Updates the user's department.

Type: String

Length Constraints: Maximum length of 256.

Required: No

DisplayName

Updates the display name of the user.

Type: String

Length Constraints: Maximum length of 256.

Required: No

FirstName

Updates the user's first name.

Type: String

Length Constraints: Maximum length of 256.

Required: No

HiddenFromGlobalAddressList

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

Type: Boolean

Required: No

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 0. 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: No

Initials

Updates the user's initials.

Type: String

Length Constraints: Maximum length of 256.

Required: No

JobTitle

Updates the user's job title.

Type: String

Length Constraints: Maximum length of 256.

Required: No

LastName

Updates the user's last name.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Office

Updates the user's office.

Type: String

Length Constraints: Maximum length of 256.

Required: No

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

Role

Updates the user role.

You cannot pass SYSTEM_USER or RESOURCE.

Type: String

Valid Values: USER | RESOURCE | SYSTEM_USER | REMOTE_USER

Required: No

Street

Updates the user's street address.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Telephone

Updates the user's contact details.

Type: String

Length Constraints: Maximum length of 256.

Required: No

UserId

The identifier for the user to be updated.

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

ZipCode

Updates the user's zip code.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Response Elements

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

Errors

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

DirectoryServiceAuthenticationFailedException
Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

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

HTTP Status Code: 400

DirectoryUnavailableException
Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

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

HTTP Status Code: 400

EntityNotFoundException
Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

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

HTTP Status Code: 400

EntityStateException
Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

HTTP Status Code: 400

InvalidParameterException
Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

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

HTTP Status Code: 400

OrganizationNotFoundException
Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

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

HTTP Status Code: 400

OrganizationStateException
Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

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

HTTP Status Code: 400

UnsupportedOperationException
Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

You can't perform a write operation against a read-only directory.

HTTP Status Code: 400

See Also

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