Enroll Totp

POST
/v1/sign-in/totp/enroll

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).

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

Response Body

Successful Response

application/json
  1. response

The authenticator's secret, as text and as the otpauth:// URI for a QR code.

secret*Secret
otpauth_uri*Otpauth Uri
challenge*Challenge
Example Request
curl -X POST 'https://dev-api.silverlyte.io/v1/sign-in/totp/enroll' \  -H 'Content-Type: application/json' \  -d '{  "challenge": "stringstringstringst"}'
Example Response
{  "secret": "string",  "otpauth_uri": "string",  "challenge": "string"}