Skip to main content
Version: cidaas 3.102.2

Find User Groups

POST 
/groups-srv/graph/usergroups

This API call finds user groups using a graph filter to select the user groups you want and limit the fields you would like to retrieve.

Filter Syntax:

  • Use attributes with prefix object_ to filter by user group properties
  • Use object_groupIds to filter by specific group IDs (array)
  • Use object_groupOwners to filter by group owners (array)
  • Supports MongoDB query syntax including equality, regex, comparison, and logical operators

Field Selection:

  • Use the fields array to specify which fields to return
  • If fields is not specified, all fields are returned
  • Available fields include: groupId, groupName, groupType, parentId, groupOwner, customFields, etc.

Pagination and Sorting:

  • Use from and size for pagination
  • Use sortfield and descending for sorting results

Validation Rules:

  • Filter object must be valid MongoDB query syntax
  • Field names in fields array must be valid user group properties
  • from must be a non-negative integer
  • size must be a positive integer

Request​

Responses​

OK - User groups found matching the filter criteria