---
title: "PATCH /api/v1/users/{UserId}"
method: PATCH
path: "/api/v1/users/{UserId}"
---

# PATCH /api/v1/users/{UserId}

`PATCH /api/v1/users/{UserId}`

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

## Path parameters

- `UserId` string, required

## Headers

- `Authentication` string, password

## Request body

- object
  - `GivenName` string, password — The given name of the user.
  - `Surname` string, password — The surname of the user.
  - `Type` 'USER' | 'ADMIN' | 'POWERUSER' | 'MINIMALUSER' | 'WORKSPACESUSER' — The type of the user.
  - `StorageRule` object — Describes the storage for a user.
    - `StorageAllocatedInBytes` integer — The amount of storage allocated, in bytes.
    - `StorageType` 'UNLIMITED' | 'QUOTA' — The type of storage.
  - `TimeZoneId` string — 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 `200`

Success

- UpdateUserResponse
  - `User` object — The user information.
    - `Id` string — The ID of the user.
    - `Username` string, password — The login name of the user.
    - `EmailAddress` string, password — The email address of the user.
    - `GivenName` string, password — The given name of the user.
    - `Surname` string, password — The surname of the user.
    - `OrganizationId` string — The ID of the organization.
    - `RootFolderId` string — The ID of the root folder.
    - `RecycleBinFolderId` string — The ID of the recycle bin folder.
    - `Status` 'ACTIVE' | 'INACTIVE' | 'PENDING' — The status of the user.
    - `Type` 'USER' | 'ADMIN' | 'POWERUSER' | 'MINIMALUSER' | 'WORKSPACESUSER' — The type of user.
    - `CreatedTimestamp` string, date-time — The time when the user was created.
    - `ModifiedTimestamp` string, date-time — The time when the user was modified.
    - `TimeZoneId` string — 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.
    - `Storage` object — The storage for the user.
      - `StorageUtilizedInBytes` integer — The amount of storage used, in bytes.
      - `StorageRule` object — The storage for a user.
        - `StorageAllocatedInBytes` integer — The amount of storage allocated, in bytes.
        - `StorageType` 'UNLIMITED' | 'QUOTA' — The type of storage.

## Other responses

- `480` — EntityNotExistsException
- `481` — UnauthorizedOperationException
- `482` — UnauthorizedResourceAccessException
- `483` — IllegalUserStateException
- `484` — ProhibitedStateException
- `485` — FailedDependencyException
- `486` — ServiceUnavailableException
- `487` — DeactivatingLastSystemUserException
- `488` — InvalidArgumentException

---

[API](https://skmtc.net/aws/apis/workdocs.md) · [All operations](https://skmtc.net/aws/apis/workdocs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/workdocs/versions/8a533af4e1ef/schema)