Get Group by displayname

By default, this endpoint WILL return data for the “members” property unless explicitly defined that it should be excluded. This means that if you have a lot of users connected to a group, this response will be large.
See the section below for more information on how to exclude the “members” property from returning data

Endpoint

Method

/scim/Groups?filter=displayName eq "[GROUP-DISPLAYNAME]"

GROUP-DISPLAYNAME is the displayname for the group

Excluding “members” from the response
In order to exclude data in the “members” property of the response, you can add &excludedAttributes=members to the request:

scim/Groups?filter=displayName%20eq%20%22[GROUP-DISPLAYNAME]%22&excludedAttributes=members

GET

Sample-Request:

curl --location --request GET '[API-URL]/scim/Groups?filter=displayName eq "[GROUP-DISPLAYNAME]"' \
--header 'Authorization: Bearer [AUTH-TOKEN]'

Responses:

200-OK

Statuscode

200

Sample response:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 1,
    "itemsPerPage": 1,
    "startIndex": 1,
    "Resources": [
        {
            "meta": {
                "resourceType": "Group"
            },
            "displayName": "Group1DisplayName4",
            "members": [
                {
                    "value": "6dec03a9-dedd-4940-8763-6201761d022e"
                }
            ],
            "externalId": "07a68030-746b-4a1d-b01e-f3e1f8602526",
            "id": "68cba83b-56f8-442c-9044-72f2674a738c",
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:Group"
            ]
        }
    ]
}