For the complete documentation index, see llms.txt. This page is also available as Markdown.

Refresh Access Token

Generates a new access token using a valid refresh token, extending the user's session without requiring reauthentication.

Endpoint

GET/v2/auth/refresh/{token}

Link

Request

Path Parameters

Parameter
Type
Description
Required
Example

token

string

Valid refresh token (from login/recovery).

Yes

"xyz789abc"

Headers

Key
Value
Required

Accept

application/json

Yes


Response (200 OK)

Returns new authentication tokens with updated expiration times.

Response Fields

Field
Type
Description
Example

accessToken

string

New JWT for API authorization.

"eyJhbGci...xyz"

refreshToken

string

New refresh token.

"eyJhbGci...abc"

guid

string

User identifier.

"D69Ijtr-sTPF-2FhmobKMEExA"

accessTtl

integer

Access token lifetime (seconds).

3600 (1 hour)

refreshTtl

integer

Refresh token lifetime (seconds).

2592000 (30 days)

Example Response:

json

Error Responses

  1. Invalid/Expired Token:

    json

  2. Revoked Token:

    json


Notes

  • When to Use:

    • When the accessToken expires (check accessTtl).

    • After password changes or security events.

  • Security:

    • Refresh tokens are single-use (a new one is issued each refresh).

    • Old refresh tokens are invalidated immediately.

  • Best Practices:

    • Store refresh tokens securely (e.g., HTTP-only cookies).

    • Rotate tokens frequently.

Examples

Real request

Real response

200 OK

Last updated