Need help? Get answers from the docs with Omni's in-app AI! Log in to your Omni instance and open the Omni Agent in the sidebar.
curl --request PATCH \
--url https://{instance}.omniapp.co/api/scim/v2/groups/{userGroupId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "add",
"path": "members",
"value": [
{
"display": "blob.ross@blobsrus.co",
"value": "9e8719d9-276a-4964-9395-a493189a247c"
}
]
}
]
}
'{
"displayName": "Blob SEs",
"id": "mEhXj6ZI",
"meta": {
"created": "2024-12-04T00:08:03.250Z",
"lastModified": "2024-12-04T00:20:47.346Z",
"resourceType": "Group"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"members": [
{
"display": "blob.ross@blobsrus.co",
"value": "9e8719d9-276a-4964-9395-a493189a247c"
}
]
}Update user group
Updates the specified user group by applying a list of SCIM 2.0 patch operations. Use PATCH to add or remove individual members, or to rename the group, without affecting other attributes.
To replace the entire group resource (including the full membership list) in a single request, use the Replace user group endpoint.
curl --request PATCH \
--url https://{instance}.omniapp.co/api/scim/v2/groups/{userGroupId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "add",
"path": "members",
"value": [
{
"display": "blob.ross@blobsrus.co",
"value": "9e8719d9-276a-4964-9395-a493189a247c"
}
]
}
]
}
'{
"displayName": "Blob SEs",
"id": "mEhXj6ZI",
"meta": {
"created": "2024-12-04T00:08:03.250Z",
"lastModified": "2024-12-04T00:20:47.346Z",
"resourceType": "Group"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"members": [
{
"display": "blob.ross@blobsrus.co",
"value": "9e8719d9-276a-4964-9395-a493189a247c"
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.omni.co/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
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
The ID of the group to be updated
Body
The SCIM schema URIs for the request. Must include urn:ietf:params:scim:api:messages:2.0:PatchOp.
urn:ietf:params:scim:api:messages:2.0:PatchOp [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
]The list of patch operations to apply to the group. Supported operations:
| Operation | Description |
|---|---|
add with path: "members" | Add one or more users to the group |
remove with path: 'members[value eq "{userId}"]' | Remove a single user from the group |
replace with path: "displayName" | Rename the group |
replace with path: "members" | Replace the entire membership list |
replace without a path | Replace top-level attributes (for example, displayName) |
1Show child attributes
Show child attributes
Was this page helpful?