Class Factors

Index

Accessors

phone pushNotification sms duo

Constructors

Methods

list set _getAuthorizationHeader

Properties

_options _phone _pushNotification _sms _duo

Accessors

phone

get phone(): Phone
Returns Phone

pushNotification

get pushNotification(): PushNotification
Returns PushNotification

sms

get sms(): Sms
Returns Sms

duo

get duo(): Duo
Returns Duo

Constructors

constructor

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

Methods

list

list(
requestOptions?: Factors.RequestOptions,
): HttpResponsePromise<GuardianFactor[]>
Retrieve details of all multi-factor authentication factors associated with your tenant.
Parameters
- OptionalrequestOptions: Factors.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GuardianFactor[]>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

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

set

set(
    name: Management.GuardianFactorNameEnum,
    request: Management.SetGuardianFactorRequestContent,
    requestOptions?: Factors.RequestOptions,
): HttpResponsePromise<SetGuardianFactorResponseContent>
Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.
Parameters
- name: Management.GuardianFactorNameEnum
  Factor name. Can be sms, push-notification, email, duo otp webauthn-roaming, webauthn-platform, or recovery-code.
- request: Management.SetGuardianFactorRequestContent
- OptionalrequestOptions: Factors.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetGuardianFactorResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.set("push-notification", {
        enabled: true
    })
```

`Protected`_getAuthorizationHeader

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

Properties

`Protected` `Readonly`_options

_options: Factors.Options

`Protected`_phone

_phone: undefined | Phone

`Protected`_pushNotification

_pushNotification: undefined | PushNotification

`Protected`_sms

_sms: undefined | Sms

`Protected`_duo

_duo: undefined | Duo