Back to Node Auth0

Class RulesConfigsClient

docs/classes/management.SDK.RulesConfigsClient.html

5.9.14.7 KB
Original Source

Class RulesConfigsClient

Index

Constructors

constructor

Methods

listsetdelete

Properties

_options

Constructors

constructor

new RulesConfigsClient(options: BaseClientOptions): RulesConfigsClient

Parameters

Returns RulesConfigsClient

Methods

list

list(
requestOptions?: RulesConfigsClient.RequestOptions,
): HttpResponsePromise<RulesConfig[]>

Retrieve rules config variable keys.

Note: For security, config variable values cannot be retrieved outside rule execution.

Parameters

Request-specific configuration.

Returns HttpResponsePromise<RulesConfig[]>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.rulesConfigs.list()Copy

set

set(
key: string,
request: SetRulesConfigRequestContent,
requestOptions?: RulesConfigsClient.RequestOptions,
): HttpResponsePromise<SetRulesConfigResponseContent>

Sets a rules config variable.

Parameters

  • key: string

Key of the rules config variable to set (max length: 127 characters).

Request-specific configuration.

Returns HttpResponsePromise<SetRulesConfigResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.rulesConfigs.set("key", { value: "value" })Copy

delete

delete(
key: string,
requestOptions?: RulesConfigsClient.RequestOptions,
): HttpResponsePromise<void>

Delete a rules config variable identified by its key.

Parameters

  • key: string

Key of the rules config variable to delete.

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.rulesConfigs.delete("key")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listsetdelete Properties _options