POST
/gate/signoutSign Out
Terminates the calling end-user's current project session by revoking the active refresh-token chain.
The end-user's access JWT continues to be valid until its TTL expires; the refresh chain is invalidated immediately so subsequent refresh attempts fail.
Parameters
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
Request body
| refreshToken * | string | The refresh token of the session to end. |
Responses
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 401 | K9O_SESSION_EXPIRED | The session token is expired or has already been revoked. |
Response body (200)
| data * | object | The result of the sign-out. |
| revoked * | boolean | True when this call ended a live session. False when the refresh token is unknown or its session had already ended; the call still succeeds. |
| meta * | any | Request metadata: cost, timing and the request and trace ids. |
TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.gate.signOut({
refreshToken: 'EXAMPLE-refresh-token-not-a-real-secret-000'
})Showing example in TypeScript
Request example
{
"refreshToken": "EXAMPLE-refresh-token-not-a-real-secret-000"
}Response example (200)
{
"data": {
"revoked": false
}
}