SparQDocs
GuidesAPI referencesparqhq.ai
API referenceSign in

Sign Out

POST
/v1/sign-in/logout

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

Ends the session the refresh token belongs to; an unknown token changes nothing.

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid
Idempotency-Key?string

Makes a retry safe: the same key, route and body within 24 hours returns the stored response and the same result id. The same key with a different body or route is idempotency_conflict; while the first request runs, idempotency_in_progress.

Length8 <= length <= 128

Request Body

application/json
  1. body
refresh_token*Refresh Token
Length1 <= length <= 200

Response Body

Successful Response

Example Request
curl -X POST 'https://dev-api.silverlyte.io/v1/sign-in/logout' \  -H 'Content-Type: application/json' \  -d '{  "refresh_token": "string"}'
Example Response
Empty

Sign In With Password POST

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version. An email and a password: the next step. A wrong email or password, a disabled account and a locked one get the same answer, in the same time.

Create Audience Tenant POST

Next Page