PATCH

/api/v1/users/{UserId}

http://workdocs.{region}.amazonaws.com/api/v1/users/{UserId}

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

Access Token Required: API Key

Path Parameters

UserIdstringrequired

The ID of the user.

Body Params

Typestring

The type of the user.

Localestring

The locale of the user.

Surnamestring

The surname of the user.

GivenNamestring

The given name of the user.

TimeZoneIdstring

The time zone ID of the user.

StorageRuleobject

Describes the storage for a user.

GrantPoweruserPrivilegesstring

Boolean value to determine whether the user is granted Power user privileges.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://workdocs.{region}.amazonaws.com/api/v1/users/{UserId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}