Update a user
PATCH/v2/users/:username
Update details about a user such as role names.
Request
Path Parameters
Specifies the User ID to update. Note the username must be percent encoded.
- application/json
Body
Indicates whether to disable or disable the user.
Possible values: [owner
, administrator
, billing_administrator
, corpus_administrator
]
The new role names of the user.
Responses
- 200
- 403
- 404
New user after modification.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
Possible values: Value must match regular expression usr_.+
The Vectara ID for the user.
The email address for the user.
The username for the user.
Indicates whether the user is enabled or disabled.
The description for the user.
When the user was created.
When a user property was last updated.
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.
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.
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[]
string
{
"id": "string",
"email": "user@example.com",
"username": "string",
"enabled": true,
"description": "string",
"created_at": "2024-09-05T02:15:29.492Z",
"updated_at": "2024-09-05T02:15:29.492Z",
"api_roles": [
"owner"
],
"api_policy": {
"name": "string",
"allowed_operations": {}
}
}
Permissions do not allow updating the user.
- application/json
- Schema
- Example (from schema)
Schema
The messages describing why the error occurred.
The ID of the request that can be used to help Vectara support debug what went wrong .
{
"messages": [
"Internal server error."
],
"request_id": "string"
}
User not found.
- application/json
- Schema
- Example (from schema)
Schema
The ID cannot found.
ID of the request that can be used to help Vectara support debug what went wrong.
{
"id": "string",
"messages": [
"string"
],
"request_id": "string"
}