Class Sms

Index

Constructors

constructor

new Sms(_options: Sms.Options): Sms
Parameters
- _options: Sms.Options
Returns Sms

Methods

getTwilioProvider

getTwilioProvider(
requestOptions?: Sms.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.
```
Parameters
- OptionalrequestOptions: Sms.RequestOptions
 Request-specific configuration.
Returns HttpResponsePromise<GetGuardianFactorsProviderSmsTwilioResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.sms.getTwilioProvider()
```

setTwilioProvider

setTwilioProvider(
request?: Management.SetGuardianFactorsProviderSmsTwilioRequestContent,
requestOptions?: Sms.RequestOptions,
): HttpResponsePromise<SetGuardianFactorsProviderSmsTwilioResponseContent>
This endpoint has been deprecated. To complete this action, use the Update Twilio phone configuration endpoint.
```
Previous functionality: Update the Twilio SMS provider configuration.
```
Parameters
- request: Management.SetGuardianFactorsProviderSmsTwilioRequestContent = {}
- OptionalrequestOptions: Sms.RequestOptions
 Request-specific configuration.
Returns HttpResponsePromise<SetGuardianFactorsProviderSmsTwilioResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.sms.setTwilioProvider()
```

getSelectedProvider

getSelectedProvider(
requestOptions?: Sms.RequestOptions,
): HttpResponsePromise<GetGuardianFactorsProviderSmsResponseContent>
This endpoint has been deprecated. To complete this action, use the Retrieve phone configuration endpoint instead.
```
Previous functionality: Retrieve details for the multi-factor authentication SMS provider configured for your tenant.
```
Parameters
- OptionalrequestOptions: Sms.RequestOptions
 Request-specific configuration.
Returns HttpResponsePromise<GetGuardianFactorsProviderSmsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.sms.getSelectedProvider()
```

setProvider

setProvider(
request: Management.SetGuardianFactorsProviderSmsRequestContent,
requestOptions?: Sms.RequestOptions,
): HttpResponsePromise<SetGuardianFactorsProviderSmsResponseContent>
This endpoint has been deprecated. To complete this action, use the Update phone configuration endpoint instead.
```
Previous functionality: Update the multi-factor authentication SMS provider configuration in your tenant.
```
Parameters
- request: Management.SetGuardianFactorsProviderSmsRequestContent
- OptionalrequestOptions: Sms.RequestOptions
 Request-specific configuration.
Returns HttpResponsePromise<SetGuardianFactorsProviderSmsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.sms.setProvider({
 provider: "auth0"
 })
```

getTemplates

getTemplates(
requestOptions?: Sms.RequestOptions,
): HttpResponsePromise<GetGuardianFactorSmsTemplatesResponseContent>
This endpoint has been deprecated. To complete this action, use the Retrieve enrollment and verification phone templates endpoint instead.
```
Previous function: Retrieve details of SMS enrollment and verification templates configured for your tenant.
```
Parameters
- OptionalrequestOptions: Sms.RequestOptions
 Request-specific configuration.
Returns HttpResponsePromise<GetGuardianFactorSmsTemplatesResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.sms.getTemplates()
```

setTemplates

setTemplates(
request: Management.SetGuardianFactorSmsTemplatesRequestContent,
requestOptions?: Sms.RequestOptions,
): HttpResponsePromise<SetGuardianFactorSmsTemplatesResponseContent>
This endpoint has been deprecated. To complete this action, use the Update enrollment and verification phone templates endpoint instead.
```
Previous functionality: Customize the messages sent to complete SMS enrollment and verification.
```
Parameters
- request: Management.SetGuardianFactorSmsTemplatesRequestContent
- OptionalrequestOptions: Sms.RequestOptions
 Request-specific configuration.
Returns HttpResponsePromise<SetGuardianFactorSmsTemplatesResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.sms.setTemplates({
 enrollment_message: "enrollment_message",
 verification_message: "verification_message"
 })
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Sms.Options

Class Sms

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Sms

Methods

getTwilioProvider

Parameters

Returns HttpResponsePromise<GetGuardianFactorsProviderSmsTwilioResponseContent>

Throws

Throws

Throws

Example

setTwilioProvider

Parameters

Returns HttpResponsePromise<SetGuardianFactorsProviderSmsTwilioResponseContent>

Throws

Throws

Throws

Example

getSelectedProvider

Parameters

Returns HttpResponsePromise<GetGuardianFactorsProviderSmsResponseContent>

Throws

Throws

Throws

Example

setProvider

Parameters

Returns HttpResponsePromise<SetGuardianFactorsProviderSmsResponseContent>

Throws

Throws

Throws

Example

getTemplates

Parameters

Returns HttpResponsePromise<GetGuardianFactorSmsTemplatesResponseContent>

Throws

Throws

Throws

Example

setTemplates

Parameters

Returns HttpResponsePromise<SetGuardianFactorSmsTemplatesResponseContent>

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options