Skip to main content
Version: 2.0

Update User API Definition

The Update User API lets you update details about a user, such as their enabled status and assigned roles.

Update User Request and Response​

To updata a user, send a PATCH request to /v2/users/{username}, where {username} is the User ID of the user you want to update with the following properties:

  • enabled - Indicates whether to enable or disable the user (true or false)
  • api_roles - Specifies an array of role names to assigned to the user, including owner, administrator, billing_administrator, and corpus_administrator.

The response contains the updated user object with the modified properties.

REST 2.0 URL​

Update User Endpoint Address​

Vectara exposes a REST endpoint at the following URL to update a user: https://api.vectara.io/v2/users:username

The API Reference shows the full Update User REST definition.