POST
/
users
/
{userId}
/
authenticators

Path Parameters

userId
string
required

The ID of the user.

Body

application/json
verificationMethod
enum<string>
required

The verification method of the authenticator being enrolled.

Available options:
EMAIL_MAGIC_LINK,
EMAIL_OTP,
SMS,
AUTHENTICATOR_APP
email
string

The user's email address. Required for EMAIL_MAGIC_LINK and EMAIL_OTP.

phoneNumber
string

The user's phone number in E.164 format. Required for SMS.

otpUri
string

The formatted OTP URI. Required for AUTHENTICATOR_APP.

oobChannel
enum<string>

Deprecated - use 'verificationMethod' instead.

Available options:
EMAIL_MAGIC_LINK,
EMAIL_OTP,
SMS

Response

200 - application/json
authenticator
object
recoveryCodes
string[]