Get User Groups

Retrieve user groups associated with the realm for a given schema. This feature is supported only for Encompass product.

Usage Notes

Pagination

  • Request Parameters “startIndex” and “count” will allow you to specify which user group record is the starting record, and how many user group records to return.
  • If you do not include these parameters, the first 10 user group records will be returned.

Response

  • totalResults = The total number of Encompass user groups in your instance.
  • itemsPerPage = Default is 10. Or, if “count” parameter is provided, is equal to the number of user group records requested. Max is 100.
  • startIndex = Default is 1. Or, if “startIndex” parameter is provided, is equal to the starting user group record you specified.
Query Params
string

Page start value.

string

Count that will be returned, starting with the identified start value in the startIndex parameter. Non-negative integer.

string
required

The 'schema' query parameter is required, and one ICE MT product schema has to be provided per request. This parameter returns all the groups for the provided schema. This feature is supported only for Encompass product.

Headers
string
required

Bearer token

Responses

Language
URL
Response
Choose an example:
application/json