List App Clients
GET/v2/app_clients
List App Clients
Request
Query Parameters
Possible values: >= 1
and <= 100
Default value: 10
The maximum number of App Clients to return at one time.
Regular expression to filter the names of the App Clients.
Used to retrieve the next page of App Clients after the limit has been reached.
Responses
- 200
- 400
- 403
An array of App Clients.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
app_clients object[]
List of App Clients.
Possible values: Value must match regular expression app_.+$
The Vectara App Client ID. This ID is not used during an OAuth flow but the ID used within the Vectara API.
The human-readable name of the App Client.
Description of the App Client.
The client ID used with the OAuth flow.
The key used in API requests. Should be kept secure.
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.
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
metadata object
The standard metadata in the response of a list operation.
When requesting the next page of this list, this is needed as a query parameter.
{
"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"
}
}
API key list request was malformed.
- application/json
- Schema
- Example (from schema)
Schema
field_errors object
The errors that relate to specific fields in the request.
The ID of the request that can be used to help Vectara support debug what went wrong.
{
"field_errors": {},
"messages": [
"string"
],
"request_id": "string"
}
Permissions do not allow listing API keys.
- 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"
}