Sign in with WebAuthn

POST/{apiBasePath}/{tenantId}/webauthn/signin

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

tenantIdstring

The tenant against which the request is made. If left empty, the default tenant will be used.

Header parameters

ridstring

The WebAuthn recipe ID

Request body

application/json

webauthnGeneratedOptionsIdstringrequired

credentialauthenticationPayloadrequired

WebAuthn authentication payload

Show properties

idstringrequired

Credential ID

rawIdstringrequired

Raw credential ID

authenticatorAttachmentstring

Type of authenticator

Allowed:platformcross-platform

clientExtensionResultsobject

Client extension results

responseobjectrequired

Authentication response

Show properties

clientDataJSONstringrequired

Client data JSON

authenticatorDatastringrequired

Authenticator data

signaturestringrequired

Authentication signature

userHandlestring

User handle

typestringrequired

Credential type

Allowed:public-key

shouldTryLinkingWithSessionUserboolean

Responses

200Sign in response

One of:

object

statusstatusOK

Success status indicator

Allowed:OK

useruser

User information

Show properties

iduserId

Unique identifier for a user

timeJoinednumber

Timestamp when user joined

isPrimaryUserboolean

Whether this is the primary user account

tenantIdsstring[]

List of tenant IDs the user belongs to

emailsstring[]

List of user's email addresses

phoneNumbersstring[]

List of user's phone numbers

thirdPartyobject[]

List of third party accounts

Show properties

Array of object

idstring

Third party provider ID

userIdstring

User ID in the third party system

loginMethodsobject[]

List of login methods available to the user

Show properties

Array of object

recipeIdstring

The recipe ID for this login method

Allowed:emailpasswordthirdpartypasswordless

recipeUserIduserId

Unique identifier for a user

verifiedboolean

Whether this login method is verified

tenantIdsstring[]

List of tenant IDs for this login method

timeJoinednumber

Timestamp when this login method was added

emailstring

Email address for this login method

phoneNumberstring

Phone number for this login method

thirdPartyobject

Third party information for this login method

Show properties

idstring

Third party provider ID

userIdstring

User ID in the third party system

generalErrorResponse

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

object

statusstring

Allowed:INVALID_CREDENTIALS_ERROR

object

statusstring

Allowed:SIGN_IN_NOT_ALLOWED

reasonstring

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the usertenantIdpath*The tenant against which the request is made. If left empty, the default tenant will be used.ridheaderThe WebAuthn recipe ID

Bodyapplication/json

Request body

Request

curl -X POST "/auth/public/webauthn/signin" \
  -H "Content-Type: application/json" \
  -d '{
  "webauthnGeneratedOptionsId": "opt_123...",
  "credential": {
    "id": "cred_123...",
    "rawId": "base64rawid...",
    "authenticatorAttachment": "platform",
    "clientExtensionResults": {},
    "response": {
      "clientDataJSON": "base64clientdata...",
      "authenticatorData": "base64authenticatordata...",
      "signature": "base64signature...",
      "userHandle": "base64userhandle..."
    },
    "type": "public-key"
  },
  "shouldTryLinkingWithSessionUser": true
}'

const response = await fetch("/auth/public/webauthn/signin", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "webauthnGeneratedOptionsId": "opt_123...",
  "credential": {
    "id": "cred_123...",
    "rawId": "base64rawid...",
    "authenticatorAttachment": "platform",
    "clientExtensionResults": {},
    "response": {
      "clientDataJSON": "base64clientdata...",
      "authenticatorData": "base64authenticatordata...",
      "signature": "base64signature...",
      "userHandle": "base64userhandle..."
    },
    "type": "public-key"
  },
  "shouldTryLinkingWithSessionUser": true
})
});

import requests

response = requests.post(
    "/auth/public/webauthn/signin",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "webauthnGeneratedOptionsId": "opt_123...",
  "credential": {
    "id": "cred_123...",
    "rawId": "base64rawid...",
    "authenticatorAttachment": "platform",
    "clientExtensionResults": {},
    "response": {
      "clientDataJSON": "base64clientdata...",
      "authenticatorData": "base64authenticatordata...",
      "signature": "base64signature...",
      "userHandle": "base64userhandle..."
    },
    "type": "public-key"
  },
  "shouldTryLinkingWithSessionUser": True
},
)

Response

{
  "status": "OK",
  "user": {
    "id": "fa7a0841-b533-4478-95533-0fde890c3483",
    "timeJoined": 1638433545183,
    "isPrimaryUser": true,
    "tenantIds": [
      "public"
    ],
    "emails": [
      "johndoe@gmail.com"
    ],
    "phoneNumbers": [
      36201234123
    ],
    "thirdParty": [
      {
        "id": "google",
        "userId": "rq238mrq2389rvq123213"
      }
    ],
    "loginMethods": [
      {
        "recipeId": "emailpassword",
        "recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
        "verified": true,
        "tenantIds": [
          "public"
        ],
        "timeJoined": 1638433545183,
        "email": "johndoe@gmail.com",
        "phoneNumber": 36201234123,
        "thirdParty": {
          "id": "google",
          "userId": "rq238mrq2389rvq123213"
        }
      }
    ]
  }
}

"Not Found"

"Internal Error"