Table of Contents

Interface IEnrollmentsClient

Namespace
Auth0.ManagementApi.Guardian
Assembly
Auth0.ManagementApi.dll
public interface IEnrollmentsClient
Extension Methods

Methods

CreateTicketAsync(CreateGuardianEnrollmentTicketRequestContent, RequestOptions?, CancellationToken)

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.

WithRawResponseTask<CreateGuardianEnrollmentTicketResponseContent> CreateTicketAsync(CreateGuardianEnrollmentTicketRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateGuardianEnrollmentTicketRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateGuardianEnrollmentTicketResponseContent>

DeleteAsync(string, RequestOptions?, CancellationToken)

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.

Task DeleteAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

Task

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account.

WithRawResponseTask<GetGuardianEnrollmentResponseContent> GetAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianEnrollmentResponseContent>