Refresh token

This endpoint allows a signed-in user to get a refresh token.

Endpoint: /api/v1/auth/refresh

Method: POST

Request Body

Media Type: application/json

Body:

{
  "refreshToken": "string"
}

Responses

200 (OK) The request was successful.

Body:

{
  "status": "string",
  "message": "string",
  "data": {
    "userId": "UUID",
    "accessToken": "string",
    "accessTokenExpiresIn": "number",
    "refreshToken": "string",
    "refreshTokenExpiresIn": "number",
    "roles": []
  },
  "metadata": {
    "timestamp": "date"
  }
}

401 (Unauthorized) This response is returned if the request is not authorized.

Body:

{
  "message": "string",
  "timestamp": "date",
  "data": "object",
  "version": "number",
  "metadata": "object"
}

404 (Not Found) This response is returned if the required resources are not found.

Body:

{
  "message": "string",
  "timestamp": "date",
  "data": "object",
  "version": "number",
  "metadata": "object"
}

412 (Precondition Failed) This response is returned if a precondition is not met.

Body:

{
  "message": "string",
  "timestamp": "date",
  "data": "object",
  "version": "number",
  "metadata": "object"
}

500 (Internal Server Error) This response is returned if an unexpected internal server error occurs.

Body:

{
  "message": "Internal Server Error",
  "timestamp": "2023-09-28T15:37:14.223Z",
  "data": "object",
  "version": "string",
  "metadata": "object"
}