v1

latestOpenAPI 3.1.02026-07-14103.6 KB

Refresh Access Token

Refreshes an access token. To retrieve the user_id, the JWT token needs to be decoded. The "Content-Type" header must be set to "application/json".

post/oauth/token

Query parameters

envelopeboolean

Whether to envelope the token response in Flume's custom formatting.

Request body

grant_typestring required

Must be "refresh_token".

refresh_tokenstring required

The refresh token used to get a new access token.

client_idstring required

Client ID provided by Flume.

client_secretstring required

Client secret provided by Flume.

Response

200

successboolean
codeinteger
messagestring
http_codeinteger
http_messagestring
{"stackTrail":"paths:/oauth/token:post:responses:200:content:application/json:schema:properties:detailed","oasType":"schema","type":"unknown"}
countinteger
{"stackTrail":"paths:/oauth/token:post:responses:200:content:application/json:schema:properties:pagination","oasType":"schema","type":"unknown"}

Example response

{
  "success": true,
  "code": 602,
  "message": "Request OK",
  "http_code": 200,
  "http_message": "OK",
  "data": [
    {
      "token_type": "bearer",
      "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
      "expires_in": 604800,
      "refresh_token": "fdb8fdbecf1d03ce5e6125c067733c0d51de209c"
    }
  ],
  "count": 1
}
All 1 operations