Create a multi-factor authentication enrollment ticket

import { ManagementClient } from "auth0"; async function main() { const client = new ManagementClient({ token: "<token>", }); await client.guardian.enrollments.createTicket({ userId: "user_id", }); } main();

承認

Authorization

string

header

必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

ボディ

user_id

string<user-id>

必須

user_id for the enrollment ticket

string<email>

alternate email to which the enrollment email will be sent. Optional - by default, the email will be sent to the user's default address

send_mail

boolean

Send an email to the user to start the enrollment

email_locale

string

Optional. Specify the locale of the enrollment email. Used with send_email.

factor

enum<string>

Optional. Specifies which factor the user must enroll with.
Note: Parameter can only be used with Universal Login; it cannot be used with Classic Login or custom MFA pages.

利用可能なオプション:

push-notification,

phone,

email,

otp,

webauthn-roaming,

webauthn-platform

allow_multiple_enrollments

boolean

Optional. Allows a user who has previously enrolled in MFA to enroll with additional factors.
Note: Parameter can only be used with Universal Login; it cannot be used with Classic Login or custom MFA pages.

レスポンス

Enrollment ticket successfully created.

ticket_id

string

デフォルト:u2x2-u2x2-u2x2-u2x2-u2x2-u2x2

The ticket_id used to identify the enrollment

ticket_url

string<url>

The url you can use to start enrollment