---
title: "Modify a role by id"
method: PATCH
path: "/api/v1/roles/{id}"
tags: ["role"]
---

# Modify a role by id

`PATCH /api/v1/roles/{id}`

This can only be done by a logged in user who has the required privileges.

## Path parameters

- `id` string, required

## Request body

- MutableRole
  - `name` string
  - `description` string
  - `permissions` Permissions[]
  - `isGlobal` boolean

## Response `200`

successful operation

## Changes

- **2022-08-18** `016871a170fd` — 1 breaking, 1 info
  - api path removed without deprecation
  - endpoint added
- **2021-08-05** `bf593e163365` — 1 warning, 2 info
  - removed the request property `scope`
  - added the new optional request property `description`
  - added the new optional request property `isGlobal`
- **2021-08-05** `c440d3b4a9b9` — 1 breaking, 3 info
  - the request's body type/format changed from ``/`` to `object`/``
  - added the new optional request property `name`
  - added the new optional request property `permissions`
  - added the new optional request property `scope`
- **2019-08-15** `42619b8ccbbe` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/openintegrationhub/apis/iam-api-for-oih/changes/api/v1/roles/:id/patch.md)

---

[API](https://skmtc.dev/openintegrationhub/apis/iam-api-for-oih.md) · [All operations](https://skmtc.dev/openintegrationhub/apis/iam-api-for-oih/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openintegrationhub/iam-api-for-oih/revisions/016871a170fd/schema)