Sign in
Users

Update a user

Updates details of a user such as role names.

patch/v2/users/{username}

Path parameters

usernamestring required

The username of the user to update. The username must be percent encoded.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Request body

enabledboolean

Indicates whether to enable or disable the user.

api_rolesApiRole[]

The new customer-level role names of the user.

descriptionstring

The description of the user.

metadataobject nullable

Arbitrary metadata associated with the user. Replaces the stored metadata entirely; it is not merged. Omit the field to leave it unchanged, or set it to null to clear it. The JSON serialization must not exceed 65535 bytes; larger payloads are rejected with a 400 response.

Example request

{
  "metadata": {
    "console_mode": "business"
  }
}

Response

The user after the update.

idstring required

The Vectara ID for the user.

emailstring email required

The email address for the user.

usernamestring

The username for the user.

enabledboolean

Indicates whether the user is enabled or disabled.

descriptionstring

The description of the user.

created_atstring date-time

When the user was created.

updated_atstring date-time

When a user property was last updated.

api_rolesApiRole[]

The customer-level role names of the user.

metadataobject

Arbitrary metadata associated with the user.

Example response

{
  "metadata": {
    "console_mode": "business"
  }
}

Changes