Begin a WebAuthn login ceremony

POST

/api/v1/login/mfa/webauthn/begin

curl --request POST \
  --url https://example.com/api/v1/login/mfa/webauthn/begin \
  --header 'Content-Type: application/json' \
  --data '{ "challenge": "example", "credential": {}, "name": "example" }'

Returns WebAuthn assertion options for an MFA challenge.

Request Body^required

Request body

Media typeapplication/json

object

challenge

string

credential

object

name

string

Example^generated

{
  "challenge": "example",
  "credential": {},
  "name": "example"
}

Responses

200

OK

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}

403

Forbidden

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

404

Not found

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

500

Internal server error

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}