Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Endpoint

Set Endpoint Oauth Config

Set endpoint OAuth configuration.

put/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.

Request body

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

The client ID. Required for all authentication types.

clientSecretstring nullable

Optional client secret. This is only used for clientSecretBasic and clientSecretPost.

For clientSecretBasic, the secret will be appended to the Authorization header. For clientSecretPost, this will be added to the body in a client_secret parameter.

tokenUrlstring uri required

The URL of the authorization server.

scopesstring[] nullable

Optional OAuth scopes added to the request body.

extraParamsobject nullable

Extra parameters added to the request body as key-value pairs.

refreshTokenstring nullable

For refreshToken grant type.

extraHeadersobject nullable

Optional headers added to the token request.

Response

no content