Get Groups
Queries for a list of groups using a list of parameters. The size of the result set can be retrieved by using the Get Group Count method.
Method
GET /group
Parameters
Query Parameters
| Name | Description |
|---|---|
| id | Filter by the id of the group. |
| idIn | Filter by a comma-separated list of group ids. |
| name | Filter by the name of the group. |
| nameLike | Filter by the name that the parameter is a substring of. |
| type | Filter by the type of the group. |
| member | Only retrieve groups which the given user id is a member of. |
| memberOfTenant | Only retrieve groups which are members of the given tenant. |
| sortBy | Sort the results lexicographically by a given criterion. Valid values are
id, name and type.
Must be used in conjunction with the sortOrder parameter. |
| sortOrder | Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter. |
| firstResult | Pagination of results. Specifies the index of the first result to return. |
| maxResults | Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. |
Result
A JSON array of group objects. Each group object has the following properties:
| Name | Type | Description |
|---|---|---|
| id | String | The id of the group. |
| name | String | The name of the group. |
| type | String | The type of the group. |
Response Codes
| Code | Media type | Description |
|---|---|---|
| 200 | application/json | Request successful. |
| 400 | application/json | Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no sortBy is specified. See the Introduction for the error response format. |
Example
Request
GET /group?name=Sales
Response
Status 200.
[{"id":"sales",
"name":"Sales",
"type":"Organizational Unit"}]