Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Table of Contents

Changelogs

Version

Date

Changes by

Description of change

V1.0

April 10, 2024

Que Nguyen

  • Initiate document

Release status

Environment

Status

Released Date

Version

DEV

RELEASED

April 10, 2024

V1.0

UAT

RELEASED

April 17, 2024

V1.0

PROD

NOT RELEASED

N/A

N/A

The Token resource

The primary resource that you will be interacting with when retrieving the authorization token.

AccessToken text

User access token

Token lifetime: https://redex-eco.atlassian.net/wiki/spaces/PAD/pages/286490675/Authentication#Access-Token%3A

RefreshToken text

User refresh token. Using in API “GET Refresh Token”

Token lifetime: https://redex-eco.atlassian.net/wiki/spaces/PAD/pages/286490675/Authentication#Refresh-Token%3A

ExpiresIn int

Token’s expired time in second

TokenType text

Type Identifier: Bearer

Scope text

Collection of scopes granted for this user access token.

{
  "AccessToken": "{{AccessToken}}",
  "RefreshToken": "{{RefreshToken}}",
  "ExpiresIn": "3600",
  "TokenType": "Bearer",
  "Scope": "REConnect_api REDEX_api REHash_api"
}

API Definitions

POST /public/v2/connect/token/refresh

Request Header

Content-Type

application/json

Request Payload

RefreshToken (required) text

RefeshToken getting from the response

GrantType (required) text

Grant type: refresh_token

ClientId (required) text

System / App / Platform unique identifier

Max length: 36

ClientSecret (required) text

System / App / Platform secret

Max length: 36

curl -X POST 'https://uat-api.redex.eco/public/v2/connect/token/refresh' \
-H 'Content-Type: application/json' \
-D '{
    "RefreshToken": "4d7869f0-71cc-43d8-8b82-1f87db6eda2f",
    "GrantType": "refresh_token",
    "ClientId": "3Yj1rQvcDGYXqXtaxDNyWaNkWPUAwJ",
    "ClientSecret": "fNDq3vGM26wzOqr9OMUXQkxdG5J3$o"
}'

Response

Response Body

Data object

Return Token Resource above

返回上面的Token资源

Errors list of error objects

Please see "Getting Started - #Error Object" for more details

请查看Getting Started - #Error Object以获得更多信息。

Meta null object

Return null object

StatusCode integer

Http Status codes standard. Example 200, 201, 404.

http状态码,如200,201,404

Message text

Response message: Success or error message.

返回成功或错误的信息。

200 Success

{
    "Data": {
        "AccessToken": {{AccessToken}},
        "RefreshToken": {{RefreshToken}},
        "ExpiresIn": "3600",
        "TokenType": "Bearer",
        "Scope": "REConnect_api REDEX_api REHash_api"
    },
    "Errors": null,
    "StatusCode": 200,
    "Message": "Return tokens successfully",
    "Meta": null
}

401 Unauthorized

{
    "Data": null,
    "Errors": [
        {
            "Key": "unsupported_grant_type",
            "Message": "unsupported_grant_type"
        }
    ],
    "StatusCode": 401,
    "Message": "unsupported_grant_type",
    "Meta": null
}

  • No labels