List users in the account

GET 
/v2/users

Lists all users in the account.

Request

Query Parameters

limit int32

Possible values: >= 1 and <= 100

Default value: 10

The maximum number of users to return at one time.

page_key string

Used to retrieve the next page of users after the limit has been reached.

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.

Responses

200

List of users.

application/json

Schema

Schema

users object[]
List of users.
Array [
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
]
]
metadata object

The standard metadata in the response of a list operation.

page_key string

When requesting the next page of this list, this is needed as a query parameter.

Example (from schema)

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

403

Permissions do not allow listing users.

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"
}

Loading...