Class FactorsClient

Index

Accessors

email phone pushNotification sms duo

Constructors

Methods

Properties

_options _email _phone _pushNotification _sms _duo

Accessors

email

get email(): EmailClient

Returns EmailClient

phone

get phone(): PhoneClient

Returns PhoneClient

pushNotification

get pushNotification(): PushNotificationClient

Returns PushNotificationClient

sms

get sms(): SmsClient

Returns SmsClient

duo

get duo(): DuoClient

Returns DuoClient

Constructors

constructor

new FactorsClient(options: BaseClientOptions): FactorsClient
Parameters
- options: BaseClientOptions
Returns FactorsClient

Methods

list

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

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.guardian.factors.list()
```

set

set(
    name: Management.GuardianFactorNameEnum,
    request: SetGuardianFactorRequestContent,
    requestOptions?: FactorsClient.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, recovery-code, or passkey.
- request: SetGuardianFactorRequestContent
- OptionalrequestOptions: FactorsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetGuardianFactorResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
errors.ManagementError

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

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_email

_email: EmailClient | undefined

`Protected`_phone

_phone: PhoneClient | undefined

`Protected`_pushNotification

_pushNotification: PushNotificationClient | undefined

`Protected`_sms

_sms: SmsClient | undefined

`Protected`_duo

_duo: DuoClient | undefined