Auth0 Node.js SDK - v7.6.0
    Preparing search index...

    Interface SearchClientGrantsRequestParameters

    {
     *         q: "q",
     *         parser: "scim",
     *         fields: "fields",
     *         include_fields: true,
     *         take: 1,
     *         from: "from",
     *         sort: "audience"
     *     }
    interface SearchClientGrantsRequestParameters {
        q?: string | null;
        parser?: Management.SearchParserEnum | null;
        fields?: string | null;
        include_fields?: boolean | null;
        take?: number | null;
        from?: string | null;
        sort?: Management.ClientGrantSortFieldEnum | null;
    }
    Index
    q? parser? fields? include_fields? take? from? sort?
    q?: string | null

    Filter expression in SCIM or Lucene syntax (depending on parser parameter). SCIM examples: audience eq "https://api.example.com", client_id eq "cli_abc", subject_type eq "client", allow_any_organization eq true, default_for eq "third_party_clients", audience co "example" and organization_id eq "org_123". SCIM operators: eq, ne, sw, ew, co, pr, gt, ge, lt, le, and, or.

    Supported Fields:

    • audience - Filter by audience (eq, ne, sw, co, ew, pr)
    • client_id - Filter by client ID (eq, ne, sw, pr)
    • subject_type - Filter by subject type (eq, ne, sw, pr)
    • allow_any_organization - Filter by allow_any_organization (eq, ne, pr)
    • organization_id - Filter by organization ID (eq, ne, sw, pr)
    • updated_at - Filter by last update date (eq, ne, gt, ge, lt, le, pr)
    • default_for - Filter by default grant group (eq, ne, sw, pr)
    Maximum 5 filter operations per query. Results are eventually consistent and may not reflect recent updates.

    parser?: Management.SearchParserEnum | null

    Query parser to use for the filter expression. Use "scim" for SCIM filter syntax or "lucene" for Lucene query syntax (default).

    fields?: string | null

    Comma-separated list of fields to include or exclude in the response. Works with the include_fields parameter to control projection mode.

    include_fields?: boolean | null

    Controls field projection mode. Set to true to include only fields specified in the fields parameter. Set to false to exclude fields specified in the fields parameter. Defaults to true if not specified.

    take?: number | null

    Maximum number of results to return per page (1-100). Defaults to 50.

    from?: string | null

    Cursor for the next page of results. Use the value from the next field in the previous response.

    sort?: Management.ClientGrantSortFieldEnum | null

    Field name to sort results by in ascending order. Defaults to insertion order (oldest first) if not provided.

    Settings
    Member Visibility

    On This Page
    Properties