Refresh an access token

POST

/auth/refresh

const url = 'https://example.com/auth/refresh';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"refresh_token":"vRT0XmbTHs3KzrPZJD8F92AWnOrPk9o781mQkP63iyZZ8MNzfpd5x5xVRojFrjXmM72vYe3I9v/PR16dzHxgkg=="}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/auth/refresh \
  --header 'Content-Type: application/json' \
  --data '{ "refresh_token": "vRT0XmbTHs3KzrPZJD8F92AWnOrPk9o781mQkP63iyZZ8MNzfpd5x5xVRojFrjXmM72vYe3I9v/PR16dzHxgkg==" }'

Generates a new access token using an existing valid refresh token

Request Body

A refresh token request

application/json

A refresh token request

object

refresh_token

required

The refresh token held by the client

string

Responses

200

Successful token refresh

application/json

A response object containing a refreshed access token

object

access_token

required

The access token generated by the server

string

expires_in

required

The lifetime of the access token, in seconds

number

Example

{
  "access_token": "G6IWgOSDfXylCr8donVs5wlnfaBvv6EszuKcppz9XXbC9AqiT5jp161nN05jghcQ2OQ/JMRvSaUQxf6L9fWVYA==",
  "expires_in": 3600
}

401

Refresh token is expired

application/json

Generic error object

object

error

required

The error message

string

description

required

The error description

string

Example

{
  "error": "Unauthorized",
  "description": "The supplied refresh token has expired. Please reauthenticate"
}

500

Internal server error

application/json

Generic error object

object

error

required

The error message

string

description

required

The error description

string

Example

{
  "error": "Internal server error",
  "description": "The server encountered an error while processing the request"
}