# Choose the role a SCIM group gives

> Page: https://docs.plotwork.dev/api/patch-orgs-org-scim-groups-group. Index of every page: https://docs.plotwork.dev/llms.txt

admin, member, reader, or null.

`PATCH /orgs/{org}/scim/groups/{group}`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Choose the role a SCIM group gives. |
| What does it take? | A JSON body of type [`ScimGroupRoleBody`](https://docs.plotwork.dev/api/schemas.md#scimgrouprolebody). |
| What does it return? | Status 200 with a body of type [`ScimGroupView`](https://docs.plotwork.dev/api/schemas.md#scimgroupview). |
| What can go wrong? | `400` the body is not valid; `401` not signed in; `403` a member or a reader (orgs.forbidden), a plan without scim (plan.sso_not_included), or the request came from an origin that may not make changes; `404` no such organisation, or the caller is not a member of it; `429` too many requests; `503` organisations are not set up on this server. Every failure uses the one error envelope. |

## What it does

admin, member, reader, or null. Once any group gives a role, provisioned people's roles follow their groups. The owner is never changed. Enterprise; the owner and admins.

## Path parameters

| Field | Type | Required | Description |
|---|---|---|---|
| `org` | `string` | yes | The organisation's id or its slug. |
| `group` | `string` | yes |  |

## Request body

The body has the type [`ScimGroupRoleBody`](https://docs.plotwork.dev/api/schemas.md#scimgrouprolebody).

| Field | Type | Required | Description |
|---|---|---|---|
| `role` | `"admin" \| "member" \| "reader" \| null` | yes |  |

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | The group. | [`ScimGroupView`](https://docs.plotwork.dev/api/schemas.md#scimgroupview) |
| 400 | The body is not valid. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 401 | Not signed in. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 403 | A member or a reader (orgs.forbidden), a plan without SCIM (plan.sso_not_included), or the request came from an origin that may not make changes. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 404 | No such organisation, or the caller is not a member of it. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 429 | Too many requests. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 503 | Organisations are not set up on this server. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |

## Response body

A 200 answer has the type [`ScimGroupView`](https://docs.plotwork.dev/api/schemas.md#scimgroupview).

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | `string` | yes |  |
| `displayName` | `string` | yes |  |
| `role` | `"admin" \| "member" \| "reader" \| null` | yes | The role the group gives its members, or null when it gives none. |
| `members` | `integer` | yes |  |

## See also

| Doc | Why |
|---|---|
| [API reference](https://docs.plotwork.dev/api/reference.md) | Every endpoint, and the error envelope |
| [Schemas](https://docs.plotwork.dev/api/schemas.md) | Every request and response type |
| [Tool reference](https://docs.plotwork.dev/mcp/tools.md) | The operations as callable tools |