Function getGroups

  • Returns a list of groups with cursor-based pagination.

    Parameters

    • query: {
          filter?: string;
          limit?: number;
          next?: string;
          prev?: string;
          sort?: string;
          systemGroups?: boolean;
          totalResults?: boolean;
      }

      an object with query parameters

      • Optionalfilter?: string

        The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive.

      • Optionallimit?: number
      • Optionalnext?: string
      • Optionalprev?: string
      • Optionalsort?: string
      • OptionalsystemGroups?: boolean
      • OptionaltotalResults?: boolean
    • Optionaloptions: ApiCallOptions

    Returns Promise<GetGroupsHttpResponse>

    GetGroupsHttpError