Back to Node Auth0

Interface ListRulesRequestParameters

docs/interfaces/management.Management.ListRulesRequestParameters.html

5.9.11.8 KB
Original Source

Interface ListRulesRequestParameters

Example

{ * page: 1, * per_page: 1, * include_totals: true, * enabled: true, * fields: "fields", * include_fields: true * }Copy

interface ListRulesRequestParameters {
page?: number | null;
per_page?: number | null;
include_totals?: boolean | null;
enabled?: boolean | null;
fields?: string | null;
include_fields?: boolean | null;
}

Index

Properties

page?per_page?include_totals?enabled?fields?include_fields?

Properties

Optionalpage

page?: number | null

Page index of the results to return. First page is 0.

Optionalper_page

per_page?: number | null

Number of results per page.

Optionalinclude_totals

include_totals?: boolean | null

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

Optionalenabled

enabled?: boolean | null

Optional filter on whether a rule is enabled (true) or disabled (false).

Optionalfields

fields?: string | null

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

Optionalinclude_fields

include_fields?: boolean | null

Whether specified fields are to be included (true) or excluded (false).

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties pageper_pageinclude_totalsenabledfieldsinclude_fields