WebAuthn

Login

Start WebAuthn Login

Initiate a WebAuthn login for a user. This endpoint creates a WebAuthn credential assertion challenge that is used to perform the login ceremony from the browser.

POSThttps://auth.passage.id/v1/apps/{app_id}/login/webauthn/start

Path parameters

app_id*string

App ID

Body

*/*

User Data

identifierstring

valid email or E164 phone number

Response

200400401403404500

OK

Body

application/json

handshake*CredentialAssertionChallenge1 (object)

usernullable User (object)

Request

JavaScriptCurl

const response = await fetch('https://auth.passage.id/v1/apps/{app_id}/login/webauthn/start', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "handshake": {
    "challenge": {
      "publicKey": {
        "allowCredentials": [
          {
            "id": "text",
            "transports": [
              "text"
            ],
            "type": "text"
          }
        ],
        "challenge": "text",
        "rpId": "text",
        "userVerification": "text"
      }
    },
    "id": "text"
  },
  "user": {
    "email": "text",
    "email_verified": false,
    "id": "text",
    "phone": "text",
    "phone_verified": false,
    "status": "active",
    "user_metadata": {},
    "webauthn": false,
    "webauthn_types": [
      "passkey"
    ]
  }
}

Finish WebAuthn Login

Complete a WebAuthn login and authenticate the user. This endpoint accepts and verifies the response from navigator.credential.get() and returns an authentication token for the user.

POSThttps://auth.passage.id/v1/apps/{app_id}/login/webauthn/finish

Path parameters

app_id*string

App ID

Body

application/json

User Data

handshake_id*string

handshake_response*CredentialAssertionResponse (object)

user_idstring

Response

200400401403404500

OK

Body

application/json

auth_result*AuthResult (object)

Request

JavaScriptCurl

const response = await fetch('https://auth.passage.id/v1/apps/{app_id}/login/webauthn/finish', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "handshake_id": "text",
      "handshake_response": {}
    }),
});
const data = await response.json();

Response

{
  "auth_result": {
    "auth_token": "text",
    "redirect_url": "text",
    "refresh_token": "text"
  }
}

Register

Start WebAuthn Register

Initiate a WebAuthn registration and create the user. This endpoint creates a WebAuthn credential creation challenge that is used to perform the registration ceremony from the browser.

POSThttps://auth.passage.id/v1/apps/{app_id}/register/webauthn/start

Path parameters

app_id*string

App ID

Body

application/json

User Data

identifier*string

valid email or E164 phone number

authenticator_attachmentAuthenticatorAttachment (enum)

selects the type of authentication that will be used in this WebAuthN flow request

platformcross-platformany

Response

200400401403404500

OK

Body

application/json

handshake*CredentialCreationChallenge (object)

usernullable User (object)

Request

JavaScriptCurl

const response = await fetch('https://auth.passage.id/v1/apps/{app_id}/register/webauthn/start', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "identifier": "text"
    }),
});
const data = await response.json();

Response

{
  "handshake": {
    "challenge": {
      "publicKey": {
        "attestation": "text",
        "authenticatorSelection": {
          "authenticatorAttachment": "text",
          "requireResidentKey": false,
          "residentKey": "text",
          "userVerification": "text"
        },
        "challenge": "text",
        "excludeCredentials": [
          {
            "id": "text",
            "transports": [
              "text"
            ],
            "type": "text"
          }
        ],
        "pubKeyCredParams": [
          {
            "type": "text"
          }
        ],
        "rp": {
          "icon": "text",
          "id": "text",
          "name": "text"
        },
        "user": {
          "displayName": "text",
          "icon": "text",
          "id": "text",
          "name": "text"
        }
      }
    },
    "id": "text"
  },
  "user": {
    "email": "text",
    "email_verified": false,
    "id": "text",
    "phone": "text",
    "phone_verified": false,
    "status": "active",
    "user_metadata": {},
    "webauthn": false,
    "webauthn_types": [
      "passkey"
    ]
  }
}

Finish WebAuthn Registration

Complete a WebAuthn registration and authenticate the user. This endpoint accepts and verifies the response from navigator.credential.create() and returns an authentication token for the user.

POSThttps://auth.passage.id/v1/apps/{app_id}/register/webauthn/finish

Path parameters

app_id*string

App ID

Body

application/json

WebAuthn Response Data

handshake_id*string

handshake_response*CredentialCreationResponse (object)

user_id*string

Response

201400401403404500

Created

Body

application/json

auth_result*AuthResult (object)

Request

JavaScriptCurl

const response = await fetch('https://auth.passage.id/v1/apps/{app_id}/register/webauthn/finish', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "handshake_id": "text",
      "handshake_response": {},
      "user_id": "text"
    }),
});
const data = await response.json();

Response

{
  "auth_result": {
    "auth_token": "text",
    "redirect_url": "text",
    "refresh_token": "text"
  }
}