Refresh Access Token¶

Request a new access token using the refresh token.

Request Format¶

GET https://{apigw-address}/app-portal-service/v2.2/token/refresh

Request Parameters (URI)¶

Name	Location (Path/Query)	Required/Optional	Data Type	Description
refreshToken	Query	Required	String	The refresh token. You can get the refresh token through the Choose Organization API.

Response Parameters¶

Name	Data Type	Description
userId	String	The user ID.
userName	String	The user name.
currentOrgId	String	The current OU ID.
currentOrgName	String	The current OU name.
accessToken	String	The new access token. You can use the access token for user authentication later.
refreshToken	String	The new refresh token.
refreshTokenExpire	String	The refresh token expiration time in UTC format. For time formats, see ISO8601 Standard Time Formats Used by UTC.

Error Code¶

Code	Message	Description
31400	Refresh Token is required	Refresh Token is required
31401	Please login first	Please login first to get the Access Token and Refresh Token

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/token/refresh?refreshToken=yourRefreshToken

method: GET

Return Sample¶

{
  "code": 0,
  "message": "OK",
  "data": {
    "userId": "your_user_id",
    "userName": "your_user_name",
    "workingOrganizationId": "your_org_id",
    "workingOrganizationName": "your_org_name",
    "accessToken": "your_access_token",
    "refreshToken": "your_refresh_token",
    "refreshTokenExpire": 1571368315000
  }
}