Refresh Token
URL: /api/v1/refreshToken
Method: GET
Authentication: Bearer <refreshToken>
Request Header
Header |
Data type |
Mandatory |
Description |
Validations |
---|---|---|---|---|
Authorization |
String |
Y |
Bearer <refreshToken> |
Check if refreshToken is valid or not or empty. |
Response body
Field |
Data type |
Mandatory |
Description |
---|---|---|---|
version |
String |
Y |
Defines the version of the API. |
status |
String |
Y |
Defines the response status. For asuccessful response, its value will be “success”. |
data |
Object |
Y |
This is the element which encapsulates the API response. For this API, its value is null. |
jwtToken |
String |
Y |
This is the new jwtToken. |
{
"version": "1",
"status": "success",
"data": {
"jwtToken": "eyJhbGciOiJIUzM4NCJ9.eyJ0ZW5hbnRVcmwiOiJmb3J0ZXN0LnZwMDQudmlkeW8udXMucmQuZWlsYWIuYml6IiwidGVuYW50SWQiOjgs
ImVuZHBvaW50R3VpZCI6ImNmYmE0MDI3LTZjYjgtNGIzMi1hNzE5LTJlMmJiMzM3MmZkYiIsIm1lbWJlclR5cGUiOiJHVUVTVCIsInRva2VuVHlwZSI6IlJFR1VMQVI
iLCJ1c2VySWQiOjEsImlhdCI6MTYzNTQyNjg4MywiZXhwIjoxNjM1NDI2OTEzfQ.9XPpA8_ocfFImKnYyu3nTyQmvsUc3uqkwmlFhZn5rsn1EvbUn1I4K12UJqtq5LLq"
}
}
HTTP status codes, error codes, and messages
HTTP response code |
Error code |
Error message |
Scenario |
---|---|---|---|
404 |
101018 |
Signing Algorithm not configured |
If invalid, refreshToken is header or empty. |
403 |
|
|
|
{
"version": "string",
"status": "string",
"error": {
"code": 0,
"message": "string",
"errors": [
"string"
]
}
}