Sign in
Application Clients

Create an App Client

Creates an App Client. An App Client is used for OAuth 2.0 authentication when calling Vectara APIs.

post/v2/app_clients

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Request body

namestring required

Name of the client credentials.

descriptionstring

Description of the client credentials.

typestring required

Always the value client_credentials.

api_rolesApiRole[]

The API roles assigned to the client credentials.

Response

An App Client object, used to query the Vectara API with the assigned roles.

idstring required

The Vectara App Client ID. This ID is not used during an OAuth flow. Use this ID within the Vectara API.

namestring required

The human-readable name of the App Client.

descriptionstring

Description of the App Client.

client_idstring required

The client ID used with the OAuth flow.

client_secretstring required

The client secret used in API requests. Keep the secret secure.

api_rolesApiRole[]

The API roles attached to the App Client.

Changes

Changed in 1 of the 8 revisions of this API.11

  • fca567a46b3a11See the full diff
    • ●

      added the new agent_end_user enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new agent_end_user enum value to the request property //////

      request-property-enum-value-added