Refresh user session

Refresh the user session

POST/{apiBasePath}/session/refresh

Authorization

AuthorizationBearer token · headerrequired

Returned as the "st-refresh-token" header from sign-in and refresh endpoints

sRefreshTokenAPI key · cookierequired

This is an HTTPOnly cookie, set by the sign-in and refresh endpoints

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Header parameters

ridstring

The recipe ID for the request

anti-csrftoken

This will only be here if enabled by the user.

Responses

200Refresh users

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the userridheaderThe recipe ID for the requestanti-csrfheaderThis will only be here if enabled by the user.

Request

curl -X POST "/auth/session/refresh" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/auth/session/refresh", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.post(
    "/auth/session/refresh",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

Refresh users

"Not Found"

"Internal Error"