Auth

Refresh an existing access token

Changed on

Refresh an existing access token

post/api/v1/oauth2/refresh

Request

Request body

refresh_tokenstring required

The refresh token obtained from a previous token request

Example request

{
  "refresh_token": "refresh_token_abc123"
}

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "access_token": "example_access_token_xyz789",
    "refresh_token": "example_refresh_token_abc123",
    "token_type": "Bearer",
    "expires_in": 900
  }
}

Changes

    • breaking

      the response property / became optional for the status

    • breaking

      the / response's property type changed from string to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

    • info

      endpoint added