Update a user

PATCH 
/v2/users/:username

Update details about a user such as role names.

Request

Path Parameters

username stringrequired

Specifies the user ID to update. Note that the username must be percent encoded.

Header Parameters

Request-Timeout integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified seconds or time out.

Request-Timeout-Millis integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified milliseconds or time out.

application/json

Body

enabled boolean

Indicates whether to enable or disable the user.

api_roles ApiRole[]

Possible values: [owner, administrator, billing_administrator, corpus_administrator]

The new role names of the user.

Responses

200

New user after modification.

application/json

Schema

Schema

id string

Possible values: Value must match regular expression usr_.+

The Vectara ID for the user.

email email

The email address for the user.

username string

The username for the user.

enabled boolean

Indicates whether the user is enabled or disabled.

description string

The description of the user.

created_at date-time

When the user was created.

updated_at date-time

When a user property was last updated.

api_roles ApiRole[]

Possible values: [owner, administrator, billing_administrator, corpus_administrator]

The role names of the user.

api_policy object
What actions a principal can take on the Vectara platform.
name stringrequired
The name of the API role.
allowed_operations objectrequired
Operations that are allowed by the API role. Each operation may only allow certain resources that are described by a resource path to resource value map. If the value is null, then the operation is allowed on any resource.
property name* ApiOperationPolicy
Policy to allow operations if only using the specified resource.
allow_any_resource booleanrequired
Default value: true
If any resource is allowed for the operation.
allowed_resources object
Object with keys of resource paths to a list of allowed resources. A resource path starts with either body, path, or implicit. A body or path resource is within the operation body, and an implicit resource is a resource implied by the request.
property name* string[]
Array [
string
]

Example (from schema)

{
  "id": "string",
  "email": "user@example.com",
  "username": "string",
  "enabled": true,
  "description": "string",
  "created_at": "2024-10-29T01:49:06.244Z",
  "updated_at": "2024-10-29T01:49:06.244Z",
  "api_roles": [
    "owner"
  ],
  "api_policy": {
    "name": "string",
    "allowed_operations": {}
  }
}

403

Permissions do not allow updating the user.

application/json

Schema

Schema

messages message[]

The messages describing why the error occurred.

request_id string

The ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "messages": [
    "Internal server error."
  ],
  "request_id": "string"
}

404

User not found.

application/json

Schema

Schema

id string

The ID cannot be found.

messages message[]
request_id string

ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "id": "string",
  "messages": [
    "string"
  ],
  "request_id": "string"
}

Loading...