Class Phone

Index

Constructors

Methods

getMessageTypes setMessageTypes getTwilioProvider setTwilioProvider getSelectedProvider setProvider getTemplates setTemplates _getAuthorizationHeader

Properties

_options

Constructors

constructor

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

Methods

getMessageTypes

getMessageTypes(
requestOptions?: Phone.RequestOptions,
): HttpResponsePromise<GetGuardianFactorPhoneMessageTypesResponseContent>
Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.
Parameters
- OptionalrequestOptions: Phone.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetGuardianFactorPhoneMessageTypesResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.phone.getMessageTypes()
```

setMessageTypes

setMessageTypes(
request: Management.SetGuardianFactorPhoneMessageTypesRequestContent,
requestOptions?: Phone.RequestOptions,
): HttpResponsePromise<SetGuardianFactorPhoneMessageTypesResponseContent>
Replace the list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.
Parameters
- request: Management.SetGuardianFactorPhoneMessageTypesRequestContent
- OptionalrequestOptions: Phone.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetGuardianFactorPhoneMessageTypesResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError
Example
```
await client.guardian.factors.phone.setMessageTypes({
        message_types: ["sms"]
    })
```

getTwilioProvider

getTwilioProvider(
requestOptions?: Phone.RequestOptions,
): HttpResponsePromise<GetGuardianFactorsProviderPhoneTwilioResponseContent>
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.
Parameters
- OptionalrequestOptions: Phone.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetGuardianFactorsProviderPhoneTwilioResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

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

setTwilioProvider

setTwilioProvider(
request?: Management.SetGuardianFactorsProviderPhoneTwilioRequestContent,
requestOptions?: Phone.RequestOptions,
): HttpResponsePromise<SetGuardianFactorsProviderPhoneTwilioResponseContent>
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.
Parameters
- request: Management.SetGuardianFactorsProviderPhoneTwilioRequestContent = {}
- OptionalrequestOptions: Phone.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetGuardianFactorsProviderPhoneTwilioResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

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

getSelectedProvider

getSelectedProvider(
requestOptions?: Phone.RequestOptions,
): HttpResponsePromise<GetGuardianFactorsProviderPhoneResponseContent>
Retrieve details of the multi-factor authentication phone provider configured for your tenant.
Parameters
- OptionalrequestOptions: Phone.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetGuardianFactorsProviderPhoneResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

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

setProvider

setProvider(
request: Management.SetGuardianFactorsProviderPhoneRequestContent,
requestOptions?: Phone.RequestOptions,
): HttpResponsePromise<SetGuardianFactorsProviderPhoneResponseContent>
Parameters
- request: Management.SetGuardianFactorsProviderPhoneRequestContent
- OptionalrequestOptions: Phone.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetGuardianFactorsProviderPhoneResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

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

getTemplates

getTemplates(
requestOptions?: Phone.RequestOptions,
): HttpResponsePromise<GetGuardianFactorPhoneTemplatesResponseContent>
Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant.
Parameters
- OptionalrequestOptions: Phone.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetGuardianFactorPhoneTemplatesResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

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

setTemplates

setTemplates(
request: Management.SetGuardianFactorPhoneTemplatesRequestContent,
requestOptions?: Phone.RequestOptions,
): HttpResponsePromise<SetGuardianFactorPhoneTemplatesResponseContent>
Customize the messages sent to complete phone enrollment and verification (subscription required).
Parameters
- request: Management.SetGuardianFactorPhoneTemplatesRequestContent
- OptionalrequestOptions: Phone.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetGuardianFactorPhoneTemplatesResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

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

`Protected`_getAuthorizationHeader

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

Properties

`Protected` `Readonly`_options

_options: Phone.Options

Class Phone

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Phone

Methods

getMessageTypes

Parameters

Returns HttpResponsePromise<GetGuardianFactorPhoneMessageTypesResponseContent>

Throws

Throws

Throws

Example

setMessageTypes

Parameters

Returns HttpResponsePromise<SetGuardianFactorPhoneMessageTypesResponseContent>

Throws

Throws

Throws

Throws

Example

getTwilioProvider

Parameters

Returns HttpResponsePromise<GetGuardianFactorsProviderPhoneTwilioResponseContent>

Throws

Throws

Throws

Example

setTwilioProvider

Parameters

Returns HttpResponsePromise<SetGuardianFactorsProviderPhoneTwilioResponseContent>

Throws

Throws

Throws

Example

getSelectedProvider

Parameters

Returns HttpResponsePromise<GetGuardianFactorsProviderPhoneResponseContent>

Throws

Throws

Throws

Example

setProvider

Parameters

Returns HttpResponsePromise<SetGuardianFactorsProviderPhoneResponseContent>

Throws

Throws

Throws

Example

getTemplates

Parameters

Returns HttpResponsePromise<GetGuardianFactorPhoneTemplatesResponseContent>

Throws

Throws

Throws

Example

setTemplates

Parameters

Returns HttpResponsePromise<SetGuardianFactorPhoneTemplatesResponseContent>

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options