Skip to main content
PUT
/
scim
/
v2
/
groups
/
{userGroupId}
Update user group
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": "[email protected]",
      "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": "[email protected]",
      "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 updated

Body

application/json
​
displayName
string
required

The name of the group. Names must be 64 characters or less.

Example:

"Blob SEs"

​
members
object[]
required

A list of users that defines the group membership. Note: This will overwrite the existing membership. Include existing members to retain their membership.

Example:
[
  {
    "display": "[email protected]",
    "value": "9e8719d9-276a-4964-9395-a493189a247c"
  }
]

Response

Group updated successfully

​
id
string

Unique identifier for the group

​
displayName
string

The name of the group

​
members
object[]

The list of users in the group

​
meta
object

Metadata about the group resource

​
schemas
string[]

SCIM schema information for the group