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

# Update a Group

`PATCH /Groups/{groupId}`

## Request

- Base URL: `https://ironcladapp.com/scim/v2`
- URL: `https://ironcladapp.com/scim/v2/Groups/{groupId}`
- Auth: API key in header `Authorization`

Documentation on updating a Group via SCIM. This includes updating group membership. 

**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
  - `Operations` object[], required: Operations for updating groups. See snippets below for more details.
    - `op` string, required: "add" or "remove"
    - `path` string, required
    - `value` object[]: An array of User Ids. User Ids can be found by filtering results from the Retrieve all Users endpoint.
      - `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

- `204`: 204 No Content
- `400`: 400 Bad Request
- `403`: 403 Forbidden
- `404`: 404 Not Found
- `500`: 500 Internal Server Error

---

[API](https://skmtc.dev/ironcladapp/apis/ironclad-scim-api.md) - [All operations](https://skmtc.dev/ironcladapp/apis/ironclad-scim-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcladapp/apis/ironclad-scim-api/revisions/ee9d1adddc38?raw)