Get WebAuthn registration options

POST

/v1/users/me/mfa/webauthn/register

curl --request POST \
  --url 'https://example.com/v1/users/me/mfa/webauthn/register?method_type=webauthn_passkey' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Tenant-ID

required

string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Query Parameters

method_type

string

default: webauthn_fido

Allowed values: webauthn_passkey webauthn_fido

Responses

200

WebAuthn registration options

Media type application/json

object

options

required

PublicKeyCredentialCreationOptions

object

Example ^generated

{
  "options": {}
}

401

Unauthenticated

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

501

Not implemented

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}