Public

post/api/v1/tokens/two-factor/enroll/totp/begin

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/tokens/two-factor/enroll/totp/begin
  • Auth: none declared

Query parameters

dataunknown required

Response

The shared secret and enrollment-test challenge are returned.

challenge_tokenstring nullable

Short-lived signed JWT identifying the enrollment-test challenge. Echo it back to POST /api/v1/tokens/two-factor/enroll/totp/confirm along with the first code from the authenticator app.

secretstring nullable

The Base32-encoded shared secret. Offer this for manual entry by users who cannot scan the QR code.

otpauth_uristring nullable

The full otpauth://totp/... URI encoding the secret, issuer and parameters. Most authenticator apps add an account directly from this.

qr_code_png_base64string nullable

A QR code rendering of otpauth_uri as a PNG, Base64 encoded — render it as an <img> for the user to scan.

expires_ininteger

Seconds until the enrollment-test challenge expires (600).

Example response

{
  "challenge_token": "string",
  "secret": "string",
  "otpauth_uri": "string",
  "qr_code_png_base64": "string",
  "expires_in": 0
}

Changes

No recorded changes to this operation across all 1 revision of this API.