Menu
Amazon WorkDocs
API Reference (API Version 2016-05-01)

UpdateUser

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Request Syntax

Copy
PATCH /api/v1/users/UserId HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "GivenName": "string", "Locale": "string", "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "Surname": "string", "TimeZoneId": "string", "Type": "string" }

URI Request Parameters

The request requires the following URI parameters.

AuthenticationToken

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

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

UserId

The ID of the user.

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

Pattern: [&\w+-.@]+

Request Body

The request accepts the following data in JSON format.

GivenName

The given name of the user.

Type: String

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

Required: No

Locale

The locale of the user.

Type: String

Valid Values: en | fr | ko | de | es | ja | ru | zh_CN | zh_TW | pt_BR | default

Required: No

StorageRule

The amount of storage for the user.

Type: StorageRuleType object

Required: No

Surname

The surname of the user.

Type: String

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

Required: No

TimeZoneId

The time zone ID of the user.

Type: String

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

Required: No

Type

The type of the user.

Type: String

Valid Values: USER | ADMIN

Required: No

Response Syntax

Copy
HTTP/1.1 200 Content-type: application/json { "User": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "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.

User

The user information.

Type: User object

Errors

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

DeactivatingLastSystemUserException

The last user in the organization is being deactivated.

HTTP Status Code: 409

EntityNotExistsException

The resource does not exist.

HTTP Status Code: 404

FailedDependencyException

The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

HTTP Status Code: 424

IllegalUserStateException

The user is undergoing transfer of ownership.

HTTP Status Code: 409

ServiceUnavailableException

One or more of the dependencies is unavailable.

HTTP Status Code: 503

UnauthorizedOperationException

The operation is not permitted.

HTTP Status Code: 403

UnauthorizedResourceAccessException

The caller does not have access to perform the action on the resource.

HTTP Status Code: 404

See Also

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