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

# Replace user group

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

Replace 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](/api/user-groups/update-user-group) endpoint, which performs a partial update via `PATCH`.

## Path parameters

- `userGroupId` string, required

## Request body

- object
  - `displayName` string, required — The name of the group. Names must be 64 characters or less.
  - `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.
    - `value` string — The user's unique identifier
    - `display` string — The user's email address

## Response `200`

Group replaced 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 request body
- `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)