Start the enrollment of a supported authentication method.

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

Authorizations

Authorization

string

header

required

Bearer and DPoP tokens are supported depending on the API configuration

Body

application/json

Request content for creating an authentication method

type

string

default:passkey

required

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+$

Response

Enrollment started

auth_session

string

required

The unique session identifier for the enrollment.

authn_params_public_key

object

required

Show child attributes