Refresh Access Token

The default validity period of Access Token is 2 hours (7200 seconds), with a maximum of 24 hours (86400). After expiration, the user needs to re-authorize to obtain a new Access Token. This step enables automatic renewal of authorization, avoiding the need for users to authorize again and improving user experience.

Request Description

POST https://{your_domain}/api/v1/oauth2/token

Request Headers

Parameter	Name	Required	Example	Description
Authorization	Authentication info	Required	Basic UnFCMNOWk9xWA==	Use client_id and client_secret for Base64 authentication. Format: base64(client_id:client_secret)
Content-Type	Data type	Required	application/x-www-form-urlencoded	Submit parameters using form data.

Request Example

POST https://{your_domain}/api/v1/oauth2/token

Authorization: Basic UnFCMkhKdGt6bFU...aT0NObkk4NlNOWk9xWA==

Content-Type: application/x-www-form-urlencoded

grant_type=refresh_token&refresh_token=wuGzSMMTjb4YhRUOjXHj-t-QD84

Request Parameters

Parameter	Name	Required	Example	Description
grant_type	Authorization type	Required	refresh_token	Fixed value: refresh_token
refresh_token	Refresh token	Required	wuGzSMMTjb4YhRUOjXHj-t-QD84	Refresh token validity period up to 30 days

Response Example

Success response example

HTTP Status: 200 OK 
{    
    "access_token": "Z43T3yJNw9es8bruLXRmsXaA",    
    "token_type": "Bearer",    "refresh_token": "WEq8anwE6qu5aq8mRq5DtHK7YznzDQ2adn5yXkFlFA",    "expires_in": 7199,    
    "scope": "openid",    
    "id_token": "eyJra21o...8oEoRsydhg" 
}

Incorrect grant_type parameter value

HTTP Status: 400 BAD REQUEST  
{
	"error": "unsupported_grant_type",
	"error_description": "Unsupported grant type"
}

Incorrect refresh token value

HTTP Status: 400 BAD REQUEST 
{
    "error": "invalid_grant",
    "error_description": "Invalid refresh token: wuGzSMMTjb4YhRUOjXHj-t-QD84"
}

Response Parameters

If successful, the Access Token can be obtained from the response.

Parameter	Name	Required	Example	Description
access_token	Authorization token	Required	3oDi8mk0q9mnTpGxcHu3Gi_vX4o	Authorization token returned by the authorization server to the third-party application.
expires_in	Access token validity period	Required	7199	Validity period of the access ticket returned by the authorization server to the application. Note: the validity period is in seconds.
refresh_token	Refresh token		wuGzSMMTjb4YhRUOjXHj-t-QD84
token_type	Token type	Required	Bearer
scope	Authorization scope	Required	openid