Sign in
Application Clients

Update an App Client

Updates the configuration of an existing App Client.

patch/v2/app_clients/{app_client_id}

Path parameters

app_client_idstring required

The ID of the App Client.

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

descriptionstring

The new App Client description.

api_rolesApiRole[]

The new roles attached to the App Client. These roles replace the current roles.

Response

The App Client.

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 2 of the 13 revisions of this API.22

  • c94fd099d78b11See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

      added the new metrics_viewer enum value to the request property /

      request-property-enum-value-added

  • 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