Sign out

auth.sign_out

POST/api/v1/auth/sign-out

Ends this session and clears its cookie. Signing out when not signed in also succeeds.

Response#

204 Signed out. No body.

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

Sign out: errors
Status	Code	When

These are real. Each was recorded from a sample household, the Okafors, running through the whole API when this site was built.

Ends the session and clears its cookie.

Request, curl

curl -X POST 'https://rigel.house/api/v1/auth/sign-out'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/auth/sign-out", {
  method: "POST",
});
const data = await response.json();

Request, HTTP

POST /api/v1/auth/sign-out HTTP/1.1
Host: rigel.house

Response, 204

HTTP/1.1 204 No Content
X-Request-Id: req_01M6V9CVJDZGAJV6Y0C2ZBSBSB
Set-Cookie: rigel_session=; Max-Age=0; Path=/