TrieOH
IdentityXAPIAuthn

Refresh a user session

Exchanges a refresh token (sent in the `Refresh-Token` header) for a fresh access/refresh token pair. Use when the access token is about to expire or has expired.

POST/auth/refresh

Exchanges a refresh token (sent in the Refresh-Token header) for a fresh access/refresh token pair. Use when the access token is about to expire or has expired.

Header Parameters

Refresh-Token*string

The refresh token to exchange.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/auth/refresh" \  -H "Refresh-Token: string"
{
  "access_token": "string",
  "refresh_token": "string",
  "access_expires_at": "2019-08-24T14:15:22Z",
  "refresh_expires_at": "2019-08-24T14:15:22Z",
  "domain": "string"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 401,
  "title": "Unauthenticated"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 500,
  "title": "Internal Server Error"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 503,
  "title": "Identity Unavailable"
}