auth

Begin passkey enrolment; returns opaque creation options.

Changed on

Verifies the account-security proof up front (the pre-existing password or a confirmed TOTP code, where one stands) and opens a registration ceremony, returning the browser-generated creation options verbatim. enrol/finish completes the enrolment.

post/api/v1/auth/webauthn/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/webauthn/enrol/start
  • Auth: HTTP bearer

Request body

passwordstring

The pre-existing password proof (an account with no confirmed factor).

codestring

The confirmed TOTP code proof (an account holding a factor).

Response

Opaque WebAuthn creation options for the browser.

WebauthnOptions required

Opaque WebAuthn ceremony options (creation or request), generated by the relying party and handed to the browser navigator.credentials API verbatim. The server treats the blob as raw bytes; the base64url fields the authenticator signs over are preserved by round-tripping.

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