NHnhost
authentication

Sign up with Webauthn

Changed on

Initiate a Webauthn sign-up process by sending a challenge to the user's device. The user must not have an existing account.

post/signup/webauthn

Request

  • Base URL
    https://{subdomain}.auth.{region}.nhost.run/v1
  • URL
    https://{subdomain}.auth.{region}.nhost.run/v1/signup/webauthn
  • Auth
    none declared

Request body

emailstring email required

A valid email

Example request

{
  "email": "john.smith@nhost.io",
  "options": {
    "allowedRoles": [
      "me",
      "user"
    ],
    "defaultRole": "user",
    "displayName": "John Smith",
    "locale": "en",
    "metadata": {
      "firstName": "John",
      "lastName": "Smith"
    },
    "redirectTo": "https://my-app.com/catch-redirection"
  }
}

Response

Challenge sent

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