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

    Interface SearchOrganizationsRequestParameters

    {
     *         q: "q",
     *         parser: "scim",
     *         take: 1,
     *         from: "from",
     *         sort: "name"
     *     }
    interface SearchOrganizationsRequestParameters {
        q?: string | null;
        parser?: Management.SearchParserEnum | null;
        take?: number | null;
        from?: string | null;
        sort?: Management.OrganizationSortFieldEnum | null;
    }
    Index
    q? parser? take? from? sort?
    q?: string | null

    Filter expression in SCIM or Lucene syntax (depending on parser parameter, default: Lucene). Lucene examples: name:acme*, display_name:*auth*. SCIM examples: name eq "Auth0", display_name sw "auth" and created_at gt "2024-01-01". SCIM operators: eq, ne, sw, ew, co, pr, gt, ge, lt, le, and, or.

    Supported Fields:

    • id - Organization ID (case-sensitive, exact match)
    • name - Organization name (supports contains, starts-with, ends-with operators; sortable)
    • display_name - Organization display name (supports contains, starts-with, ends-with operators; sortable)
    • created_at - Creation timestamp (supports date range operators; sortable)
    • metadata.{key} - Filter by organization metadata key-value pairs
    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).

    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.OrganizationSortFieldEnum | null

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

    Settings
    Member Visibility

    On This Page
    Properties