Get Group by Filter

Description: This API will fetch the group details, searched by the filter query parameter. When a filter is not provided, the response will contain all groups. For more information, see Get Groups

Usage: GET/api/v1/scim/v2/Groups?filter = displayName eq “groupName”

Produces: application/scim+json; charset=UTF-8

Header parameter:Authorization: Bearer

Sample response:

200 - OK - group exists

[
  {
    "totalResults": 1,
    "itemsPerPage": 20,
    "startIndex": 1,
    "Resources": [
      {
        "displayName": "readers",
        "id": "readers",
        "description": "A group for read-only users",
        "members": [],
        "schemas": [
          "urn:ietf:params:scim:schemas:core:2.0:Group"
        ],
        "meta": null,
        "resourceType": "Group"
      }
    ],
    "schemas": [
      "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ]
  }
]

Sample response when group does not exist:

200 - OK - Group does not exist

{
   "totalResults": 0,
   "itemsPerPage": 20,
   "startIndex": 1,
   "Resources": [],
   "schemas": [
       "urn:ietf:params:scim:api:messages:2.0:ListResponse"
   ]
}