Exchange OAuth grant

Exchanges an OAuth2 grant (e.g.: authorization code) for an access token (and optionally a refresh/id token) - for a detailed description of all input parameters please see the OAuth2 and OpenID Connect Core specs

POST/{apiBasePath}/oauth/token

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Responses

200Issued tokens

One of:

object

access_tokenstring

The access token issued by the authorization server.

expires_innumberrequired

The lifetime in seconds of the access token (integer). For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated.

id_tokenstring

To retrieve a refresh token request the id_token scope.

refresh_tokenstring

The refresh token, which can be used to obtain new access tokens. To retrieve it add the scope "offline" to your access token request.

scopestringrequired

The scope of the access token

token_typestringrequired

The type of the token issued

generalErrorResponse

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

400OAuth2 specific error response

errorstring

The OAuth2 error code

error_descriptionstring

Human readable error description

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the user

Request

curl -X POST "/auth/oauth/token"

const response = await fetch("/auth/oauth/token", {
  method: "POST"
});

import requests

response = requests.post(
    "/auth/oauth/token",
)

Response

{
  "access_token": "string",
  "expires_in": 0,
  "id_token": "string",
  "refresh_token": "string",
  "scope": "string",
  "token_type": "string"
}

{
  "error": "invalid_request",
  "error_description": "Unsupported grant type: password"
}

"Not Found"

"Internal Error"