Get Get Groups
Retrieve all groups if no filter is specified, otherwise retrieve all the groups matching the given filter. This endpoint complies with the SCIM specifications; see https://tools.ietf.org/html/rfc7644#page-15
list of attributes to return, separated by comma. When specified, the retrieved group(s) will only contain the minimal set of group attributes plus the attributes or sub-attributes explicitly requested
displayName,urn:scim:schemas:extension:workspace:1.0:email
when specified, only users matching the filter expression will be returned. The filter must comply with the SCIM specification. Only 'eq','co','sw','gt','ge','lt' and 'le' are currently supported as operators
displayName co "test"
offset of the first group to return in the list of found groups
10
the number of found groups to return starting from the given startIndex
50
the attribute to use to sort the found group
displayName
the direction the resources returned should be sorted in. Allowed values are "ascending" and "descending"
successful operation
{
"totalResults": 0,
"startIndex": 0,
"itemsPerPage": 0,
"Resources": [
{
"displayName": "string",
"resourceDescriptor": {
"endpoint": "string",
"description": "string",
"name": "string",
"attributeSchemas": [
"string"
],
"strictMode": false,
"scimObject": {
"schemas": [
"string"
]
},
"meta": {
"lastModified": "string",
"version": "string",
"location": "string",
"created": "string"
},
"externalId": "string",
"attributes": [
{
"subAttributes": [
"AttributeDescriptor Object"
],
"description": "string",
"canonicalValues": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"dataType": "string",
"required": false,
"caseExact": false,
"name": "string",
"readOnly": false,
"multiValuedChildName": "string",
"multiValued": false,
"schema": "string"
}
],
"schema": "string",
"id": "string",
"resourceDescriptor": "ResourceDescriptor Object"
},
"urn:scim:schemas:extension:workspace:1.0": {
"distinguishedName": "CN=all-admin-users,CN=Users,DC=acme,DC=com",
"internalGroupType": "EXTERNAL",
"domain": "acme.com",
"description": "The group for all admin users",
"compositionRules": "{\n \"addedUserIds\" : [ ],\n \"excludedUserIds\" : [ ],\n \"rule\" : {\n \"type\" : \"internalGroup\",\n \"groupId\" : \"53cc45f9-2e21-4fa4-ae81-32e6fb15bd91\"\n }\n}",
"userStoreUuid": "acme.com",
"parents": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"compositionRulesV2": false,
"email": "[email protected]"
},
"scimObject": {
"schemas": [
"string"
]
},
"meta": {
"lastModified": "string",
"version": "string",
"location": "string",
"created": "string"
},
"externalId": "string",
"members": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"id": "string",
"schemas": [
"string"
]
}
]
}
totalResults
startIndex
itemsPerPage
The specified filter operation is invalid or the specified "attributes" are invalid or the "sortBy" parameter is invalid
If the query parameter values are invalid for "count" or "startIndex"