List App Clients API Definition
The List App Clients API lets you list an Application Client for OAuth 2.0 authentication with Vectara's APIs.
note
For more information about using OAuth 2.0 with Vectara, see OAuth 2.0 Tokens.
To list the App Client, send a POST request to /v2/app_clients
with the
following properties:
name
- (Required) Specifies the name of the client credentials.description
- Describes the client credentials.types
- (Requires) Indicates the type asclient_credentials
.api_roles
- Specifies the API roles associated with the client credentials asowner
,administrator
,billing_administrator
, orcorpus_administrator
.
The response includes the AppClient
object that contains the assigned App
Client ID, name, description, client ID used within the OAuth flow, client
secret, API roles, and API policy.
REST 2.0 API URL
List App Client Endpoint Address
Vectara exposes a REST endpoint at the following URL to list app clients:https://api.vectara.io/v2/api_keys
The API Reference shows the full List App Client REST definition.