Table of Contents

Interface ISmsClient

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

Methods

GetSelectedProviderAsync(RequestOptions?, CancellationToken)

This endpoint has been deprecated. To complete this action, use the Retrieve phone configuration endpoint instead.

<b>Previous functionality</b>: Retrieve details for the multi-factor authentication SMS provider configured for your tenant.

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

Parameters

options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderSmsResponseContent>

GetTemplatesAsync(RequestOptions?, CancellationToken)

This endpoint has been deprecated. To complete this action, use the Retrieve enrollment and verification phone templates endpoint instead.

<b>Previous function</b>: Retrieve details of SMS enrollment and verification templates configured for your tenant.

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

Parameters

options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorSmsTemplatesResponseContent>

GetTwilioProviderAsync(RequestOptions?, CancellationToken)

Retrieve the Twilio SMS provider configuration (subscription required).

A new endpoint is available to retrieve the Twilio configuration related to phone factors (<a href="https://auth0.com/docs/api/management/v2/#!/Guardian/get_twilio">phone Twilio configuration</a>). It has the same payload as this one. Please use it instead.

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

Parameters

options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderSmsTwilioResponseContent>

SetProviderAsync(SetGuardianFactorsProviderSmsRequestContent, RequestOptions?, CancellationToken)

This endpoint has been deprecated. To complete this action, use the Update phone configuration endpoint instead.

<b>Previous functionality</b>: Update the multi-factor authentication SMS provider configuration in your tenant.

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

Parameters

request SetGuardianFactorsProviderSmsRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderSmsResponseContent>

SetTemplatesAsync(SetGuardianFactorSmsTemplatesRequestContent, RequestOptions?, CancellationToken)

This endpoint has been deprecated. To complete this action, use the Update enrollment and verification phone templates endpoint instead.

<b>Previous functionality</b>: Customize the messages sent to complete SMS enrollment and verification.

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

Parameters

request SetGuardianFactorSmsTemplatesRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorSmsTemplatesResponseContent>

SetTwilioProviderAsync(SetGuardianFactorsProviderSmsTwilioRequestContent, RequestOptions?, CancellationToken)

This endpoint has been deprecated. To complete this action, use the Update Twilio phone configuration endpoint.

<b>Previous functionality</b>: Update the Twilio SMS provider configuration.

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

Parameters

request SetGuardianFactorsProviderSmsTwilioRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderSmsTwilioResponseContent>