Generic SCIM Endpoint - List Groups

The List Groups endpoint returns either all groups within an organization matching the given filter or all groups if no filter is provided.

Request

Endpoint

/provisioning/generic/v2/Groups

HTTP method

GET

Path parameters

Parameter
Requirement
Description
Example

count

Optional

Allows the response to be paginated per the specified number of rows

5

filter

Optional

Filters the response results; must be in the form displayName%20eq%20%22…%22 where is the desired display name

roleName

startIndex

Optional

Allows further results to be provided incrementally

1

Example requests

Example request with filter

GET app.strongdm.com/provisioning/generic/v2/Groups?filter=displayName%20eq%20%22myRole%22

Example request without filter

GET app.strongdm.com/provisioning/generic/v2/Groups?startIndex=1&count=5

Response

Example success response

(Status 200)
{
  "Resources": [
    {
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
      "displayName": "group3",
      "id": "r-0fd1be8f617193e7",
      "members": [],
      "meta": {
        "resourceType": "Group",
        "location": "Groups/r-0fd1be8f617193e7"
      }
    },
    {
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
      "displayName": "group0",
      "id": "r-13fb3d52617193e7",
      "members": [{"value":"a-558235b6617193e9","display":"Firstname Lastname"}],
      "meta": {
        "resourceType": "Group",
        "location": "Groups/r-13fb3d52617193e7"
      }
    },
    {
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
      "displayName": "group1",
      "id": "r-368672b8617193e7",
      "members": [],
      "meta": {
        "resourceType": "Group",
        "location": "Groups/r-368672b8617193e7"
      }
    },
    {
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
      "displayName": "group2",
      "id": "r-6bd3e96d617193e7",
      "members": [],
      "meta": {
        "resourceType": "Group",
        "location": "Groups/r-6bd3e96d617193e7"
      }
    },
    {
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
      "displayName": "group4",
      "id": "r-7392b18b617193e7",
      "members": [],
      "meta": {
        "resourceType": "Group",
        "location": "Groups/r-7392b18b617193e7"
      }
    }
  ],
  "itemsPerPage": 100,
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "startIndex": 1,
  "totalResults": 5
}

Last updated

Was this helpful?