Table of Contents

Interface IPhoneClient

Namespace
Auth0.ManagementApi.Guardian.Factors
Assembly
Auth0.ManagementApi.dll
public interface IPhoneClient
Extension Methods

Methods

GetMessageTypesAsync(RequestOptions?, CancellationToken)

Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.

WithRawResponseTask<GetGuardianFactorPhoneMessageTypesResponseContent> GetMessageTypesAsync(RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorPhoneMessageTypesResponseContent>

GetSelectedProviderAsync(RequestOptions?, CancellationToken)

Retrieve details of the multi-factor authentication phone provider configured for your tenant.

WithRawResponseTask<GetGuardianFactorsProviderPhoneResponseContent> GetSelectedProviderAsync(RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderPhoneResponseContent>

GetTemplatesAsync(RequestOptions?, CancellationToken)

Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant.

WithRawResponseTask<GetGuardianFactorPhoneTemplatesResponseContent> GetTemplatesAsync(RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorPhoneTemplatesResponseContent>

GetTwilioProviderAsync(RequestOptions?, CancellationToken)

Retrieve configuration details for a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA.

WithRawResponseTask<GetGuardianFactorsProviderPhoneTwilioResponseContent> GetTwilioProviderAsync(RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderPhoneTwilioResponseContent>

SetMessageTypesAsync(SetGuardianFactorPhoneMessageTypesRequestContent, RequestOptions?, CancellationToken)

Replace the list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.

WithRawResponseTask<SetGuardianFactorPhoneMessageTypesResponseContent> SetMessageTypesAsync(SetGuardianFactorPhoneMessageTypesRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request SetGuardianFactorPhoneMessageTypesRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorPhoneMessageTypesResponseContent>

SetProviderAsync(SetGuardianFactorsProviderPhoneRequestContent, RequestOptions?, CancellationToken) 

WithRawResponseTask<SetGuardianFactorsProviderPhoneResponseContent> SetProviderAsync(SetGuardianFactorsProviderPhoneRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request SetGuardianFactorsProviderPhoneRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderPhoneResponseContent>

SetTemplatesAsync(SetGuardianFactorPhoneTemplatesRequestContent, RequestOptions?, CancellationToken)

Customize the messages sent to complete phone enrollment and verification (subscription required).

WithRawResponseTask<SetGuardianFactorPhoneTemplatesResponseContent> SetTemplatesAsync(SetGuardianFactorPhoneTemplatesRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request SetGuardianFactorPhoneTemplatesRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorPhoneTemplatesResponseContent>

SetTwilioProviderAsync(SetGuardianFactorsProviderPhoneTwilioRequestContent, RequestOptions?, CancellationToken)

Update the configuration of a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA.

WithRawResponseTask<SetGuardianFactorsProviderPhoneTwilioResponseContent> SetTwilioProviderAsync(SetGuardianFactorsProviderPhoneTwilioRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request SetGuardianFactorsProviderPhoneTwilioRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderPhoneTwilioResponseContent>