Update Organization Roles

PATCH /api/v1/orgs/current/roles/{role_id}

Error

A valid request URL is required to generate request examples

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "permissions": [
    "<string>"
  ],
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_restricted": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyOrganization IDBearer Auth

X-API-Key · string · header · required

Path Parameters

role_id · string<uuid> · required

Body

application/json

display_name · string · required

description · string · required

permissions · string[] · required

Response

200

application/json

Successful Response

id · string<uuid> · required

name · string · required

display_name · string · required

description · string · required

permissions · string[] · required

organization_id · string<uuid> | null

access_scope · enum<string> | null

Available options: organization, workspace

is_restricted · boolean · default: false