• management
• SDK
• FactorsClient

Class FactorsClient

Index

Accessors

phonepushNotificationsmsduo

Constructors

constructor

Methods

listset

Properties

_options_phone_pushNotification_sms_duo

Accessors

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

Example

await client.guardian.factors.list()Copy

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, or recovery-code.

• request: SetGuardianFactorRequestContent
• OptionalrequestOptions: FactorsClient.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 })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Protected_phone

_phone: PhoneClient | undefined

Protected_pushNotification

_pushNotification: PushNotificationClient | undefined

Protected_sms

_sms: SmsClient | undefined

Protected_duo

_duo: DuoClient | undefined

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Accessors phonepushNotificationsmsduo Constructors constructor Methods listset Properties _options_phone_pushNotification_sms_duo