Function getGroups

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

    The number of groups to retrieve.

  • Optionalnext?: string

    The next page cursor.

  • Optionalprev?: string

    The previous page cursor.

  • Optionalsort?: string

    Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending.

  • OptionalsystemGroups?: boolean

    Return system groups (e.g. Everyone) instead of regular groups. Cannot be combined with any other query parameters.

  • OptionaltotalResults?: boolean

    Whether to return a total match count in the result. Defaults to false.
• Optionaloptions: ApiCallOptions