Start the enrollment of a supported authentication method.

Start the enrollment of a supported authentication method.

POST https://{host}/me/v1/authentication-methods

cURL

phone

curl --request POST \ --url https://{host}/me/v1/authentication-methods \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "type": "phone", "phone_number": "[phone]", "preferred_authentication_method": "sms" } '

202

phone

{ "id": "phone|dev_XXXXXXXXXXXXXXXX", "auth_session": "Fe26.2**05c400ed..." }

承認

Authorization · string · header · 必須

Bearer and DPoP tokens are supported depending on the API configuration

ボディ

application/json

passkey

totp

push-notification

recovery-code

email

phone

password

Request content for creating an authentication method

type · string · デフォルト: passkey · 必須

Authentication method type (factor)

Allowed value: "passkey"

connection · string

Name of the database connection

Required string length: 1 - 128

Pattern: ^[a-zA-Z0-9-]+$

identity_user_id · string

Identity provider user ID

Required string length: 1 - 255

Pattern: ^\S+$

レスポンス

202

application/json

Enrollment started

Passkey enrollment information

WebAuthn enrollment information

Email/Phone enrollment information

TOTP/Push enrollment information

Recovery Code enrollment information

Password enrollment information

auth_session · string · 必須

The unique session identifier for the enrollment.

authn_params_public_key · object · 必須

Show child attributes