1. Docs
  2. API Reference
  3. Begin a passkey step-up

Begin a passkey step-up

POST/v1/auth/mfa/step-up/webauthn/options

Starts a passkey step-up for the authenticated administrator by returning navigator.credentials.get() options under Canopy's relying party, limited to their passkeys, with a sealed transit token tying the nonce to the caller. Responds 401 when the administrator has no passkey. Rate-limited to 10 requests per minute.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Responses

application/json

  • dataMfaStepUpWebAuthnOptionsResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Rate limit

10 requests per 1mPer caller: the signed-in user for a bearer token; for an API key, the key and the end user's address when a backend forwards it, otherwise the client address

Returned object

MfaStepUpWebAuthnOptionsResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/v1/auth/mfa/step-up/webauthn/options" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "transit_token": "string",
    "options": {}
  }
}
 Related endpoints
GETList the caller's enrolled second factors
POSTBegin authenticator app enrollment
POSTComplete authenticator app enrollment
POSTBegin passkey enrollment
POSTComplete passkey enrollment
POSTProve a fresh second factor before a sensitive change
POSTComplete a passkey step-up
DELETERemove one of the caller's second factors
GETHow many recovery codes the caller has left
POSTRegenerate the caller's recovery codes
GETList the caller's remembered devices
DELETEForget every remembered device
DELETEForget one remembered device
 Was this page helpful?

Tell us how we can improve this guide.

Canopy