List App Clients

GET 
/v2/app_clients

List App Clients

Request

Query Parameters

limit int32

Possible values: >= 1 and <= 100

Default value: 10

The maximum number of App Clients to return at one time.

filter string

Regular expression to filter the names of the App Clients.

page_key string

Used to retrieve the next page of App Clients 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

An array of App Clients.

application/json

Schema

Schema

app_clients object[]
List of App Clients.
Array [
id string
Possible values: Value must match regular expression app_.+$
The Vectara App Client ID. This ID is not used during an OAuth flow. However, the ID used within the Vectara API.
name string
The human-readable name of the App Client.
description string
Description of the App Client.
client_id string
The client ID used with the OAuth flow.
client_secret string
The client secret used in API requests. The secret should be kept secure.
api_roles ApiRole[]
Possible values: [owner, administrator, billing_administrator, corpus_administrator]
The API roles attached to the App Client.
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)

{
  "app_clients": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "client_id": "string",
      "client_secret": "string",
      "api_roles": [
        "owner"
      ],
      "api_policy": {
        "name": "string",
        "allowed_operations": {}
      }
    }
  ],
  "metadata": {
    "page_key": "string"
  }
}

400

App Clients list request was malformed.

application/json

Schema

Schema

field_errors object
The errors that relate to specific fields in the request.
property name* string
messages message[]
request_id string

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

Example (from schema)

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

403

Permissions do not allow listing App Clients.

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...