Renew Access Token

View as Markdown
### Renew an existing access token without starting a new session. **Available to:** All authenticated users **Environments:** Demo, Live **[Rate Limit](/api/authentication#request-rate-limits-and-time-penalties):** 15 requests per hour, 15-second back-off, counts all requests Extends the lifetime of your current access token without creating a new session. Send your existing, non-expired token with the `Bearer` scheme; the response returns a fresh `accessToken` and `expirationTime`. Use renewal in long-running applications so you don't start a new session unless it's absolutely necessary. Repeatedly calling [`accessTokenRequest`](/api/rest-api-endpoints/authentication/access-token-request) starts new sessions, and because you're limited to two concurrent sessions per user, that can drop dependent services that share a token. Call renewal about 15 minutes before the current token expires. See [Authentication & Access](/api/authentication) for session details. **Common Failure Scenarios** - The supplied access token has already expired — renew before expiry, not after. - The `Authorization` header is missing or malformed (returns `HTTP 401`). **Error Messages** | `errorText` | Trigger | |-------------|---------| | Non-empty `errorText` | The request failed; the field describes the reason. |

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

AccessTokenResponse
errorTextstring<=8192 characters

Non-empty if the request failed

hibpHintenum
EmailAndPasswordCompromised, PasswordCompromised
accessTokenstring<=8192 characters
expirationTimedatetime
passwordExpirationTimedatetime
userStatusenum
Active, Closed, Initiated, TemporaryLocked, UnconfirmedEmail
userIdlong
namestring<=64 characters
hasLiveboolean
hasSimPlusboolean
showKIDsboolean