v15

latestOpenAPI 3.0.0MIT Licenseraw.githubusercontent.com2026-08-016088119.5 KB

authentication

Sign up with Webauthn

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 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