Class PhoneClient

Namespace

Auth0.ManagementApi.Guardian.Factors

Assembly

Auth0.ManagementApi.dll

public class PhoneClient : IPhoneClient

Inheritance

object

PhoneClient

Implements

IPhoneClient

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Methods

GetMessageTypesAsync(RequestOptions?, CancellationToken)

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

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

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorPhoneMessageTypesResponseContent>

Examples

await client.Guardian.Factors.Phone.GetMessageTypesAsync();

GetSelectedProviderAsync(RequestOptions?, CancellationToken)

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

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

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderPhoneResponseContent>

Examples

await client.Guardian.Factors.Phone.GetSelectedProviderAsync();

GetTemplatesAsync(RequestOptions?, CancellationToken)

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

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

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorPhoneTemplatesResponseContent>

Examples

await client.Guardian.Factors.Phone.GetTemplatesAsync();

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.

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

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderPhoneTwilioResponseContent>

Examples

await client.Guardian.Factors.Phone.GetTwilioProviderAsync();

SetMessageTypesAsync(SetGuardianFactorPhoneMessageTypesRequestContent, RequestOptions?, CancellationToken)

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

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

Parameters

request SetGuardianFactorPhoneMessageTypesRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorPhoneMessageTypesResponseContent>

Examples

await client.Guardian.Factors.Phone.SetMessageTypesAsync(
    new SetGuardianFactorPhoneMessageTypesRequestContent
    {
        MessageTypes = new List<GuardianFactorPhoneFactorMessageTypeEnum>()
        {
            GuardianFactorPhoneFactorMessageTypeEnum.Sms,
        },
    }
);

SetProviderAsync(SetGuardianFactorsProviderPhoneRequestContent, RequestOptions?, CancellationToken)

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

Parameters

request SetGuardianFactorsProviderPhoneRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderPhoneResponseContent>

Examples

await client.Guardian.Factors.Phone.SetProviderAsync(
    new SetGuardianFactorsProviderPhoneRequestContent
    {
        Provider = GuardianFactorsProviderSmsProviderEnum.Auth0,
    }
);

SetTemplatesAsync(SetGuardianFactorPhoneTemplatesRequestContent, RequestOptions?, CancellationToken)

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

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

Parameters

request SetGuardianFactorPhoneTemplatesRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorPhoneTemplatesResponseContent>

Examples

await client.Guardian.Factors.Phone.SetTemplatesAsync(
    new SetGuardianFactorPhoneTemplatesRequestContent
    {
        EnrollmentMessage = "enrollment_message",
        VerificationMessage = "verification_message",
    }
);

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.

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

Parameters

request SetGuardianFactorsProviderPhoneTwilioRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderPhoneTwilioResponseContent>

Examples

await client.Guardian.Factors.Phone.SetTwilioProviderAsync(
    new SetGuardianFactorsProviderPhoneTwilioRequestContent()
);