---
title: "Update a group"
method: PATCH
path: "/authorization/groups/{groupId}"
tags: ["Authorization"]
---

# Update a group

`PATCH /authorization/groups/{groupId}`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/authorization/groups/{groupId}`
- Auth: none declared

Updates a group.

## Path parameters

- `groupId` string, required: String representation of a MongoDB ObjectId

## Request body

- object
  - `updates` AuthorizationGroupsGroupIdPatchRequestBodyContentApplicationJsonSchemaUpdates
    - `description` string: Description of group
    - `inactive` boolean: Setting for whether group is active or not
    - `memberOf` IapGroupsSchemaMemberOfItems[]: Parent groups which this group is a part of
      - `aaaManaged` boolean: Whether group comes from an external AAA or not
      - `groupId` string: String representation of a MongoDB ObjectId
    - `assignedRoles` IapGroupsSchemaAssignedRolesItems[]: Roles assigned to this group
      - `roleId` string: String representation of a MongoDB ObjectId

## Response `200`

The output of the group update.

- AuthorizationUpdateGroupResponse200
  - `status` 'OK' | 'Created': The status of the API request.
  - `message` string: Message containing either confirmation of the operation or the reason for the failure of the operation.
  - `data` IapGroupsSchema: This is the schema for an IAP group stored in Mongo
    - `provenance` string, required: AAA provider where group originated
    - `name` string, required: Name of group
    - `description` string, required: Description of group
    - `memberOf` IapGroupsSchemaMemberOfItems[], required: Parent groups which this group is a part of
      - `aaaManaged` boolean: Whether group comes from an external AAA or not
      - `groupId` string: String representation of a MongoDB ObjectId
    - `assignedRoles` IapGroupsSchemaAssignedRolesItems[], required: Roles assigned to this group
      - `roleId` string: String representation of a MongoDB ObjectId
    - `inactive` boolean, required: Setting for whether group is active or not
    - `_meta` IapGroupsSchemaMeta: Metadata for group
      - `created` string: When the group was created
      - `updated` string: When the group was last updated

## Other responses

- `500`: Error response from API

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)