Skip to main content

RefreshToken

Replace an existing session and its refresh token.

No valid session token is required. No input or output blobs are used.

Parameters​

  • refresh_token (string, required): the complete refresh token returned by Authenticate or a previous refresh.

Behavior​

Submit RefreshToken alone, including when a valid session is supplied in the request header. Refresh requires an unexpired, unrevoked refresh token. It replaces both tokens together; after a successful refresh, use the new pair. The replacement counts as the newest session without consuming an additional session slot. The configured per-user session limit still applies. If refresh fails because the token expired or was revoked, authenticate again.

Response​

Success returns status: 0, a new session_token and refresh_token, and their session_token_expires_in and refresh_token_expires_in durations. An expired, revoked, or invalid token returns a negative status and an info message inside the RefreshToken command result. Authenticate again to start a new session. See Responses for other errors and retry guidance.

Examples​

[{
    "RefreshToken": {
        "refresh_token": "adbr_TxchBKOyerwLEbNnnhuoxtzSuC8ag0u9j5O"
    }
}]

Response:

[{
    "RefreshToken": {
        "status": 0,
        "session_token": "adbs_FE3fajEyerwLEb42kqwfkhqdHJ2ag0u9j5O",
        "session_token_expires_in": 36000,
        "refresh_token": "adbr_Z2nOUCAE37tlfcPUdeNGE5wtMRZvFYUn6iv",
        "refresh_token_expires_in": 360000
    }
}]