Refresh Token

Refresh Token

curl --request POST \
  --url https://api.example.com/api/auth/refresh-token \
  --header 'Content-Type: application/json' \
  --data '
{
  "refreshToken": "<string>"
}
'

import requests

url = "https://api.example.com/api/auth/refresh-token"

payload = { "refreshToken": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({refreshToken: '<string>'})
};

fetch('https://api.example.com/api/auth/refresh-token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/auth/refresh-token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'refreshToken' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/auth/refresh-token"

	payload := strings.NewReader("{\n  \"refreshToken\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/auth/refresh-token")
  .header("Content-Type", "application/json")
  .body("{\n  \"refreshToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/auth/refresh-token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"refreshToken\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "accessToken": "<string>",
  "refreshToken": "<string>",
  "expiresIn": 123,
  "requiresPasswordChange": true
}

POST

api

auth

refresh-token

Refresh Token

curl --request POST \
  --url https://api.example.com/api/auth/refresh-token \
  --header 'Content-Type: application/json' \
  --data '
{
  "refreshToken": "<string>"
}
'

import requests

url = "https://api.example.com/api/auth/refresh-token"

payload = { "refreshToken": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({refreshToken: '<string>'})
};

fetch('https://api.example.com/api/auth/refresh-token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/auth/refresh-token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'refreshToken' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/auth/refresh-token"

	payload := strings.NewReader("{\n  \"refreshToken\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/auth/refresh-token")
  .header("Content-Type", "application/json")
  .body("{\n  \"refreshToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/auth/refresh-token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"refreshToken\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "accessToken": "<string>",
  "refreshToken": "<string>",
  "expiresIn": 123,
  "requiresPasswordChange": true
}

Exchanges a Cognito refresh token for a new access token and ID token. Use this endpoint to maintain an authenticated session without requiring the user to log in again.

Authentication

This is a public endpoint that does not require authentication. However, you must provide a valid refresh token obtained from a previous login.

Rate Limiting

This endpoint is rate-limited to 5 requests per minute per IP address.

Request Body

string

required

Cognito refresh token obtained from a previous login responseThis is the long-lived token returned by /api/auth/login.Example: eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ...

Request Example

curl -X POST https://api.example.com/api/auth/refresh-token \
  -H "Content-Type: application/json" \
  -d '{
    "refreshToken": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ..."
  }'

Response

Success Response (200 OK)

string

New Cognito JWT access tokenUse this token in the Authorization: Bearer <token> header for authenticated requests.

string

The same refresh token that was provided in the requestCognito does not issue a new refresh token on refresh, so the original token is returned.

number

Token expiration time in secondsTypically 3600 (1 hour).

boolean

Always false for refresh token responses

{
  "accessToken": "eyJraWQiOiJxYz...",
  "refreshToken": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ...",
  "expiresIn": 3600,
  "requiresPasswordChange": false
}

Error Responses

Invalid or expired refresh tokenThe refresh token is malformed, expired, or has been revoked.

{
  "statusCode": 401,
  "message": "Invalid or expired refresh token",
  "error": "Unauthorized"
}

Rate limit exceeded — More than 5 requests in 1 minute

{
  "statusCode": 429,
  "message": "Too many requests",
  "error": "Too Many Requests"
}

Notes

Refresh tokens are long-lived and remain valid until explicitly revoked
Cognito does not rotate refresh tokens automatically—the same refresh token can be used multiple times
Access tokens expire after 1 hour, so refresh them before they expire to maintain a seamless user experience
If the refresh token is expired or invalid, the user must log in again using /api/auth/login

Authentication

Assessments

Jobs

Prompts

Admin

Authentication

Rate Limiting

Request Body

Request Example

Response

Success Response (200 OK)

Error Responses

Notes

​Authentication

​Rate Limiting

​Request Body

​Request Example

​Response

​Success Response (200 OK)

​Error Responses

​Notes

Authentication

Rate Limiting

Request Body

Request Example

Response

Success Response (200 OK)

Error Responses

Notes