docs/classes/management.SDK.RulesClient.html
new RulesClient(options: BaseClientOptions): RulesClient
list(
request?: ListRulesRequestParameters,
requestOptions?: RulesClient.RequestOptions,
): Promise<Page<Rule, ListRulesOffsetPaginatedResponseContent>>
Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.
OptionalrequestOptions: RulesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.rules.list({ page: 1, per_page: 1, include_totals: true, enabled: true, fields: "fields", include_fields: true })Copy
create(
request: CreateRuleRequestContent,
requestOptions?: RulesClient.RequestOptions,
): HttpResponsePromise<CreateRuleResponseContent>
Create a new rule.
Note: Changing a rule's stage of execution from the default login_success can change the rule's function signature to have user omitted.
OptionalrequestOptions: RulesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.rules.create({ name: "name", script: "script" })Copy
get(
id: string,
request?: GetRuleRequestParameters,
requestOptions?: RulesClient.RequestOptions,
): HttpResponsePromise<GetRuleResponseContent>
Retrieve rule details. Accepts a list of fields to include or exclude in the result.
ID of the rule to retrieve.
OptionalrequestOptions: RulesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.rules.get("id", { fields: "fields", include_fields: true })Copy
delete(
id: string,
requestOptions?: RulesClient.RequestOptions,
): HttpResponsePromise<void>
Delete a rule.
ID of the rule to delete.
OptionalrequestOptions: RulesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.rules.delete("id")Copy
update(
id: string,
request?: UpdateRuleRequestContent,
requestOptions?: RulesClient.RequestOptions,
): HttpResponsePromise<UpdateRuleResponseContent>
Update an existing rule.
ID of the rule to retrieve.
OptionalrequestOptions: RulesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.rules.update("id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods listcreategetdeleteupdate Properties _options