---
title: "Update user group"
method: PATCH
path: "/scim/v2/groups/{userGroupId}"
tags: ["User groups"]
---

# Update user group

`PATCH /scim/v2/groups/{userGroupId}`

Update the specified user group by applying a list of [SCIM 2.0 patch operations](https://datatracker.ietf.org/doc/html/rfc7644#section-3.5.2). 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](/api/user-groups/replace-user-group) endpoint.

## Path parameters

- `userGroupId` string, required

## Request body

- object
  - `schemas` string[], required — The SCIM schema URIs for the request. Must include `urn:ietf:params:scim:api:messages:2.0:PatchOp`.
  - `Operations` object[], required — 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`) |
    - `op` 'add' | 'replace' | 'remove', required — The operation to perform.
    - `path` string — The attribute path the operation targets. For member removal, use the filter syntax `members[value eq "{userId}"]`. Omit to apply the operation to the resource as a whole.
    - `value` unknown

## Response `200`

Group updated successfully

- ScimGroup
  - `id` string — Unique identifier for the group
  - `displayName` string — The name of the group
  - `members` object[] — The list of users in the group
    - `value` string — The user's unique identifier
    - `display` string — The user's email address
  - `meta` object — Metadata about the group resource
    - `resourceType` string — The type of resource. This will be `Group`.
    - `created` string, date-time — The time the group was created
    - `lastModified` string, date-time — The time the group was last updated
  - `schemas` string[] — SCIM schema information for the group

## Other responses

- `400` — Invalid patch operations
- `429` — Too Many Requests - Rate limit exceeded (60 requests/minute)

---

[API](https://skmtc.net/omni/apis/omni-api.md) · [All operations](https://skmtc.net/omni/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omni/omni-api/versions/6b02f7349d0e/schema)