Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444236171.7 KB

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

patch/api/v1/users/{UserId}

Path parameters

UserIdstring required

The ID of the user.

Headers

Authenticationstring password

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Request body

GivenNamestring password

The given name of the user.

Surnamestring password

The surname of the user.

Type'USER' | 'ADMIN' | 'POWERUSER' | 'MINIMALUSER' | 'WORKSPACESUSER'

The type of the user.

TimeZoneIdstring

The time zone ID of the user.

Locale'en' | 'fr' | 'ko' | 'de' | 'es' | 'ja' | 'ru' | 'zh_CN' | 'zh_TW' | 'pt_BR' | 'default'

The locale of the user.

GrantPoweruserPrivileges'TRUE' | 'FALSE'

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

Response

Success