Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Endpoint

Get Endpoint Oauth Config

Get endpoint OAuth configuration.

get/api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

The Endpoint's ID or UID.

Response

grantType'clientCredentials' | 'refreshToken' required
authMethod'clientSecretJwt' | 'clientSecretBasic' | 'clientSecretPost' required

The method used for authenticating to the OAuth authorization server.

clientSecretJwt will construct a JWT used for authentication with the oauth authorization server. This method is less commonly used and may not be supported by all oauth providers. clientSecretBasic will authenticate to the oauth authorization server using an Authorization header with the client secret as the value. This is the most common means of authentication. clientSecretPost will authenticate to the oauth authorization server by passing the client secret in a client_secret field in the request body. This method may not be supported by all oauth providers, and in general clientSecretBasic should be preferred.

clientIdstring required
tokenUrlstring required
scopesstring[] nullable
extraParamsobject nullable
extraHeadersobject nullable