Sign in
auth

Begin TOTP enrolment; returns the otpauth URI once.

Changed on

An account-security proof up front (the pre-existing password, since no possession factor stands yet — human-auth ADR § Account-security mutations). Stages a sealed seed as a pending, inert enrolment and returns the otpauth:// URI exactly once. It confirms nothing and mutates no session: enrol/confirm completes the enrolment. A confirmed factor already standing is refused (400).

post/api/v1/auth/totp/enrol/start

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/auth/totp/enrol/start
  • Auth: HTTP bearer

Request body

passwordstring required

The account-security proof: the pre-existing password. Verified before a pending seed is staged; never logged, never echoed.

Response

The provisioning URI, returned once.

otpauth_uristring required

The otpauth://totp/... provisioning URI, returned exactly once. The seed is never re-retrievable.

Changes

  • 54b2780eec85Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f84a1cd8a05aRevision changes
    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status