• management
• Management
• CreateGuardianEnrollmentTicketRequestContent

Interface CreateGuardianEnrollmentTicketRequestContent

Example

{ * user_id: "user_id" * }Copy

interface CreateGuardianEnrollmentTicketRequestContent {
user_id: string;
email?: string;
send_mail?: boolean;
email_locale?: string;
factor?: Management.GuardianEnrollmentFactorEnum;
allow_multiple_enrollments?: boolean;
}

Index

Properties

user_idemail?send_mail?email_locale?factor?allow_multiple_enrollments?

Properties

user_id

user_id: string

user_id for the enrollment ticket

Optionalemail

email?: string

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

Optionalsend_mail

send_mail?: boolean

Send an email to the user to start the enrollment

Optionalemail_locale

email_locale?: string

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

Optionalfactor

factor?: Management.GuardianEnrollmentFactorEnum

Optionalallow_multiple_enrollments

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.

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties user_idemailsend_mailemail_localefactorallow_multiple_enrollments