NHnhost
security

Initialize adding of a new webauthn security key

Changed on

Start the process of adding a new WebAuthn security key to the user's account. Returns a challenge that must be completed by the user's authenticator device. Requires elevated permissions.

post/user/webauthn/add

Request

  • Base URL
    https://{subdomain}.auth.{region}.nhost.run/v1
  • URL
    https://{subdomain}.auth.{region}.nhost.run/v1/user/webauthn/add
  • Auth
    HTTP bearer

Response

Challenge created for registering a new security key

challengestring byte required

Base64url-encoded binary data

timeoutinteger

A time, in milliseconds, that the caller is willing to wait for the call to complete

hintsPublicKeyCredentialHints[]

Hints to help guide the user through the experience

attestation'none' | 'indirect' | 'direct' | 'enterprise'

The attestation conveyance preference

attestationFormatsAttestationFormat[]

The preferred attestation statement formats

extensionsAuthenticationExtensions

Additional parameters requesting additional processing by the client and authenticator

Changes

  • 0fc5fd589dbfRevision changes
    • warning

      added the new otp-too-many-attempts enum value to the response property for the response status

  • b39086c84b43Revision changes
    • warning

      added the new user-already-exists enum value to the response property for the response status

    • info

      removed the email-already-in-use enum value from the response property for the response status