Auth0 Node.js SDK - v5.1.0
    Preparing search index...

    Interface ListUsersRequestParameters

    {
     *         page: 1,
     *         per_page: 1,
     *         include_totals: true,
     *         sort: "sort",
     *         connection: "connection",
     *         fields: "fields",
     *         include_fields: true,
     *         q: "q",
     *         search_engine: "v1",
     *         primary_order: true
     *     }
    interface ListUsersRequestParameters {
        page?: number | null;
        per_page?: number | null;
        include_totals?: boolean | null;
        sort?: string | null;
        connection?: string | null;
        fields?: string | null;
        include_fields?: boolean | null;
        q?: string | null;
        search_engine?: Management.SearchEngineVersionsEnum | null;
        primary_order?: boolean | null;
    }
    Index

    Properties

    page? per_page? include_totals? sort? connection? fields? include_fields? q? search_engine? primary_order?

    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.

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

    sort?: string | null

    Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1

    connection?: string | null

    Connection filter. Only applies when using search_engine=v1. To filter by connection with search_engine=v2|v3, use q=identities.connection:"connection_name"

    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.

    include_fields?: boolean | null

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

    q?: string | null

    Query in Lucene query string syntax. Some query types cannot be used on metadata fields, for details see Searchable Fields.

    search_engine?: Management.SearchEngineVersionsEnum | null

    The version of the search engine

    primary_order?: boolean | null

    If true (default), results are returned in a deterministic order. If false, results may be returned in a non-deterministic order, which can enhance performance for complex queries targeting a small number of users. Set to false only when consistent ordering and pagination is not required.

    Settings

    Member Visibility

    On This Page

    Properties