Back to Node Auth0

Interface ListAculsRequestParameters

docs/interfaces/management.Management.ListAculsRequestParameters.html

5.9.12.5 KB
Original Source

Interface ListAculsRequestParameters

Example

{ * fields: "fields", * include_fields: true, * page: 1, * per_page: 1, * include_totals: true, * prompt: "prompt", * screen: "screen", * rendering_mode: "advanced" * }Copy

interface ListAculsRequestParameters {
fields?: string | null;
include_fields?: boolean | null;
page?: number | null;
per_page?: number | null;
include_totals?: boolean | null;
prompt?: string | null;
screen?: string | null;
rendering_mode?: Management.AculRenderingModeEnum | null;
}

Index

Properties

fields?include_fields?page?per_page?include_totals?prompt?screen?rendering_mode?

Properties

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 (default: true) or excluded (false).

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. Maximum value is 100, default value is 50.

Optionalinclude_totals

include_totals?: boolean | null

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

Optionalprompt

prompt?: string | null

Name of the prompt to filter by

Optionalscreen

screen?: string | null

Name of the screen to filter by

Optionalrendering_mode

rendering_mode?: Management.AculRenderingModeEnum | null

Rendering mode to filter by

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties fieldsinclude_fieldspageper_pageinclude_totalspromptscreenrendering_mode