Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

 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

GET

...


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:

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

...