v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Authentication API

Refresh the Access Token

Use this endpoint to renew an expired access token with a valid refresh token.

post/v1/login/oauth/refresh_token

Request body

refreshTokenstring required

The refresh token that you want to exchange.

scopestring required

The access level for the new token.

Example request

{
  "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ",
  "scope": "openid profile email"
}

Response

Indicates that the resource was successfully created and the operation was completed as expected.

accessTokenstring required

A temporary token that grants the user secure access the APIs.

expiresIninteger required

The time (in seconds) until the token expires.

idTokenstring

The identity details about the authenticated user in OpenID Connect standards. It can be used to verify user authentication.

refreshTokenstring required

A long-lived token that allows users to obtain a new access_token without requiring them to log in again.

scopestring

The level of access granted to the issued tokens

tokenTypestring required

The type of token issued.