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 PUT \
--url https://{instance}.omniapp.co/api/scim/v2/groups/{userGroupId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "Blob SEs",
"members": [
{
"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"
}
]
}Replace user group
Replaces the specified user group. Per the SCIM 2.0 specification, PUT replaces the entire group resource, including its membership.
To add or remove individual members without replacing the full membership list, use the Update user group endpoint, which performs a partial update via PATCH.
curl --request PUT \
--url https://{instance}.omniapp.co/api/scim/v2/groups/{userGroupId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "Blob SEs",
"members": [
{
"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 replaced
Body
The name of the group. Names must be 64 characters or less.
"Blob SEs"
A list of users that defines the group membership. Note: This will overwrite the existing membership. Include existing members to retain their membership.
Show child attributes
Show child attributes
[
{
"display": "blob.ross@blobsrus.co",
"value": "9e8719d9-276a-4964-9395-a493189a247c"
}
]Was this page helpful?