docs/classes/management.SDK.EnrollmentsClient.html
new EnrollmentsClient(options: BaseClientOptions): EnrollmentsClient
createTicket(
request: CreateGuardianEnrollmentTicketRequestContent,
requestOptions?: EnrollmentsClient.RequestOptions,
): HttpResponsePromise<CreateGuardianEnrollmentTicketResponseContent>
Create a multi-factor authentication (MFA) enrollment ticket, and optionally send an email with the created ticket, to a given user. Create a multi-factor authentication (MFA) enrollment ticket, and optionally send an email with the created ticket to a given user. Enrollment tickets can specify which factor users must enroll with or allow existing MFA users to enroll in additional factors.
Note: Users cannot enroll in Email as a factor through custom enrollment tickets.
OptionalrequestOptions: EnrollmentsClient.RequestOptionsRequest-specific configuration.
await client.guardian.enrollments.createTicket({ user_id: "user_id" })Copy
get(
id: string,
requestOptions?: EnrollmentsClient.RequestOptions,
): HttpResponsePromise<GetGuardianEnrollmentResponseContent>
Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account.
ID of the enrollment to be retrieve.
OptionalrequestOptions: EnrollmentsClient.RequestOptionsRequest-specific configuration.
await client.guardian.enrollments.get("id")Copy
delete(
id: string,
requestOptions?: EnrollmentsClient.RequestOptions,
): HttpResponsePromise<void>
Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA. For more information, review Reset User Multi-Factor Authentication and Recovery Codes.
ID of the enrollment to be deleted.
OptionalrequestOptions: EnrollmentsClient.RequestOptionsRequest-specific configuration.
await client.guardian.enrollments.delete("id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods createTicketgetdelete Properties _options