SparQDocs
GuidesAPI referencesparqhq.ai
API referenceSign in

Confirm Totp

POST
/v1/sign-in/totp/confirm

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.

The authenticator's first code: TOTP on, ten recovery codes, signed in.

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
challenge*Challenge
Length20 <= length <= 200
code*Code
Match^\d{6}$

Response Body

Successful Response

application/json
  1. response

For the BFF only: an access token for the SilverLyte API and a refresh token.

access_token*Access Token
refresh_token*Refresh Token
token_type?Token Type
Default"Bearer"
expires_in*Expires In
recovery_codes?array<string>|

Only after enrolling TOTP: ten one-time codes, shown once.

Example Request
curl -X POST 'https://dev-api.silverlyte.io/v1/sign-in/totp/confirm' \  -H 'Content-Type: application/json' \  -d '{  "challenge": "stringstringstringst",  "code": "string"}'
Example Response
{  "access_token": "string",  "refresh_token": "string",  "token_type": "Bearer",  "expires_in": 0,  "recovery_codes": [    "string"  ]}

Check Totp 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. A code from the authenticator, or one recovery code: signed in.

Enroll Totp 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. A new authenticator secret, confirmed by its first code (`confirmSignInTotp`).