Retrieve user group

curl --request GET \
  --url https://{instance}.omniapp.co/api/scim/v2/groups/{userGroupId} \
  --header 'Authorization: Bearer <token>'

{
  "displayName": "Blob Sales",
  "id": "mEhXj6ZI",
  "meta": {
    "created": "2024-08-29T20:33:36.626Z",
    "lastModified": "2024-08-29T20:33:36.626Z",
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "members": [
    {
      "display": "blob.ross@blobsrus.co",
      "value": "9e8719d9-276a-4964-9395-a493189a247c"
    }
  ]
}

GET

scim

groups

{userGroupId}

Retrieve user group

curl --request GET \
  --url https://{instance}.omniapp.co/api/scim/v2/groups/{userGroupId} \
  --header 'Authorization: Bearer <token>'

{
  "displayName": "Blob Sales",
  "id": "mEhXj6ZI",
  "meta": {
    "created": "2024-08-29T20:33:36.626Z",
    "lastModified": "2024-08-29T20:33:36.626Z",
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "members": [
    {
      "display": "blob.ross@blobsrus.co",
      "value": "9e8719d9-276a-4964-9395-a493189a247c"
    }
  ]
}

Authorizations

Authorization

string

header

required

Requires an Organization API Key. Personal Access Tokens (PATs) are not supported for this endpoint.

Include in the Authorization header as: Bearer ORGANIZATION_API_KEY

Path Parameters

userGroupId

string

required

The ID of the group to be retrieved

Response

User group details

string

Unique identifier for the group

displayName

string

The name of the group

members

object[]

The list of users in the group

Show child attributes