REST API Reference

Back Next

Getting SCIM-managed groups

Get details for SCIM-managed groups.

GET request

To get details for SCIM-managed groups, use the following URI:

/scim-service/Groups

The following table describes the request headers:

Header	Description
Content-Type	Media type of the request body. Use application/scim+json.
Authorization	SCIM token to authenticate to the request.

The following table describes optional fields in the request body:

Field	Type	Description
startIndex	Integer	Index of the first result to return using 1-based indexing.
count	Integer	Number of groups to return.
sortOrder	String	Order to sort results. Use "asc" for ascending and "desc" for descending.
schemas	Array of Strings	List of schema URIs for user types.

GET response

If successful, returns the SCIM-managed groups.

GET example

The following sample request gets details for SCIM-managed groups:

GET <serverUrl>/scim-service/Groups
Content-Type: application/scim+json
Authorization: <SCIM token>

{
  "startIndex": 1,
  "count": 1000,
  "sortOrder": "asc",
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ]
}

A successful response might look like the following example:

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 2,
  "itemsPerPage": 2,
  "startIndex": 1,
  "Resources": [
    {
      "id": "1234efgh5678ijkl9012mn",
      "externalId": "ee622900-a8cb-48e3-894a-81009876b9b7",
      "displayName": "IDMC Users",
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "meta": {
        "resourceType": "Group",
        "created": "2024-03-15T15:51:13.000Z",
        "lastModified": "2024-09-09T15:55:37.000Z",
        "location": "http://dm-em.informaticacloud.com:443/scim-service/Groups/1234efgh5678ijkl9012mn"
      }
    },
    {
      "id": "4567mnop7890qrst2345uv",
      "externalId": "1eb94628-9e9c-4b4d-ad3f-a36d8586ab87",
      "displayName": "GroupTwo",
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "meta": {
        "resourceType": "Group",
        "created": "2024-11-29T09:56:11.000Z",
        "lastModified": "2025-01-25T18:36:57.000Z",
        "location": "http://dm-em.informaticacloud.com:443/scim-service/Groups/4567mnop7890qrst2345uv"
      }
    }
  ]
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Getting SCIM-managed groups

Getting SCIM-managed groups

GET request

GET response

GET example