docs/classes/management.SDK.SmsClient.html
getTwilioProvidersetTwilioProvidergetSelectedProvidersetProvidergetTemplatessetTemplates
new SmsClient(options: BaseClientOptions): SmsClient
getTwilioProvider(
requestOptions?: SmsClient.RequestOptions,
): HttpResponsePromise<GetGuardianFactorsProviderSmsTwilioResponseContent>
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.
OptionalrequestOptions: SmsClient.RequestOptionsRequest-specific configuration.
await client.guardian.factors.sms.getTwilioProvider()Copy
setTwilioProvider(
request?: SetGuardianFactorsProviderSmsTwilioRequestContent,
requestOptions?: SmsClient.RequestOptions,
): HttpResponsePromise<SetGuardianFactorsProviderSmsTwilioResponseContent>
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.
OptionalrequestOptions: SmsClient.RequestOptionsRequest-specific configuration.
await client.guardian.factors.sms.setTwilioProvider()Copy
getSelectedProvider(
requestOptions?: SmsClient.RequestOptions,
): HttpResponsePromise<GetGuardianFactorsProviderSmsResponseContent>
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.
OptionalrequestOptions: SmsClient.RequestOptionsRequest-specific configuration.
await client.guardian.factors.sms.getSelectedProvider()Copy
setProvider(
request: SetGuardianFactorsProviderSmsRequestContent,
requestOptions?: SmsClient.RequestOptions,
): HttpResponsePromise<SetGuardianFactorsProviderSmsResponseContent>
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.
OptionalrequestOptions: SmsClient.RequestOptionsRequest-specific configuration.
await client.guardian.factors.sms.setProvider({ provider: "auth0" })Copy
getTemplates(
requestOptions?: SmsClient.RequestOptions,
): HttpResponsePromise<GetGuardianFactorSmsTemplatesResponseContent>
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.
OptionalrequestOptions: SmsClient.RequestOptionsRequest-specific configuration.
await client.guardian.factors.sms.getTemplates()Copy
setTemplates(
request: SetGuardianFactorSmsTemplatesRequestContent,
requestOptions?: SmsClient.RequestOptions,
): HttpResponsePromise<SetGuardianFactorSmsTemplatesResponseContent>
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.
OptionalrequestOptions: SmsClient.RequestOptionsRequest-specific configuration.
await client.guardian.factors.sms.setTemplates({ enrollment_message: "enrollment_message", verification_message: "verification_message" })Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods getTwilioProvidersetTwilioProvidergetSelectedProvidersetProvidergetTemplatessetTemplates Properties _options