---
title: "Replace a Group"
method: PUT
path: "/Groups/{groupId}"
tags: ["Groups"]
---

# Replace a Group

`PUT /Groups/{groupId}`

Documentation on replacing a Group via SCIM. 

**OAuth Scope required:** `scim.groups.updateGroups`

## Path parameters

- `groupId` string, required

## Query parameters

- `excludedAttributes` string

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Request body

- object
  - `schemas` string[], required
  - `displayName` string, required — The name you want to give the group in Ironclad.
  - `members` object[]
    - `value` string, required — The unique id of the user. User Ids can be found by filtering the Retrieve all Users endpoint.

## Response `200`

200 OK

- GroupResponseObject
  - `schemas` string[], required
  - `displayName` string — The name of the group.
  - `id` string, required — The group's identifier.
  - `externalId` string — An optional identifier of the group sourced from the identity provider.
  - `members` object[] — The list of users who are members of this group.
    - `type` 'User' — The type of member for this group. This is usually 'User'.
    - `value` string — The user's identifier.
  - `meta` object — Metadata for the group.
    - `resourceType` 'Group' — Type of the SCIM resource. In this case: 'Group'.
    - `location` string, https-url — The URI of the Group resource being returned.

## Other responses

- `400` — 400 Bad Request
- `403` — 403 Forbidden
- `404` — 404 Not Found
- `500` — 500 Internal Server Error

---

[API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/versions/9459b4cfc1e0/schema)