• management
• SDK
• PoliciesClient

Class PoliciesClient

Index

Constructors

constructor

Methods

listset

Properties

_options

Constructors

constructor

new PoliciesClient(options: BaseClientOptions): PoliciesClient

Parameters

• options: BaseClientOptions

Returns PoliciesClient

Methods

list

list(
requestOptions?: PoliciesClient.RequestOptions,
): HttpResponsePromise<ListGuardianPoliciesResponseContent>

Retrieve the multi-factor authentication (MFA) policies configured for your tenant.

The following policies are supported:

• all-applications policy prompts with MFA for all logins.
• confidence-score policy prompts with MFA only for low confidence logins.

Note : The confidence-score policy is part of the Adaptive MFA feature. Adaptive MFA requires an add-on for the Enterprise plan; review Auth0 Pricing for more details.

Parameters

• OptionalrequestOptions: PoliciesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<ListGuardianPoliciesResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.policies.list()Copy

set

set(
request: SetGuardianPoliciesRequestContent,
requestOptions?: PoliciesClient.RequestOptions,
): HttpResponsePromise<SetGuardianPoliciesResponseContent>

Set multi-factor authentication (MFA) policies for your tenant.

The following policies are supported:

• all-applications policy prompts with MFA for all logins.
• confidence-score policy prompts with MFA only for low confidence logins.

Note : The confidence-score policy is part of the Adaptive MFA feature. Adaptive MFA requires an add-on for the Enterprise plan; review Auth0 Pricing for more details.

Parameters

• request: SetGuardianPoliciesRequestContent
• OptionalrequestOptions: PoliciesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<SetGuardianPoliciesResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.policies.set(["all-applications"])Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listset Properties _options