• management
• Management
• ListClientsRequestParameters

Interface ListClientsRequestParameters

Example

{ * fields: "fields", * include_fields: true, * page: 1, * per_page: 1, * include_totals: true, * is_global: true, * is_first_party: true, * app_type: "app_type", * external_client_id: "external_client_id", * q: "q" * }Copy

interface ListClientsRequestParameters {
fields?: string | null;
include_fields?: boolean | null;
page?: number | null;
per_page?: number | null;
include_totals?: boolean | null;
is_global?: boolean | null;
is_first_party?: boolean | null;
app_type?: string | null;
external_client_id?: string | null;
q?: string | null;
}

Index

Properties

fields?include_fields?page?per_page?include_totals?is_global?is_first_party?app_type?external_client_id?q?

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 (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. Default value is 50, maximum value is 100

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).

Optionalis_global

is_global?: boolean | null

Optional filter on the global client parameter.

Optionalis_first_party

is_first_party?: boolean | null

Optional filter on whether or not a client is a first-party client.

Optionalapp_type

app_type?: string | null

Optional filter by a comma-separated list of application types.

Optionalexternal_client_id

external_client_id?: string | null

Optional filter by the Client ID Metadata Document URI for CIMD-registered clients.

Optionalq

q?: string | null

Advanced Query in Lucene syntax.
Permitted Queries :

• client_grant.organization_id:{organization_id}
• client_grant.allow_any_organization:true

Additional Restrictions :

• Cannot be used in combination with other filters
• Requires use of the from and take paging parameters (checkpoint paginatinon)
• Reduced rate limits apply. See Rate Limit Configurations

_ Note : Recent updates may not be immediately reflected in query results_

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties fieldsinclude_fieldspageper_pageinclude_totalsis_globalis_first_partyapp_typeexternal_client_idq