Update a permission group

PATCH

organizations

permission-groups

{group_id}

Error

A valid request URL is required to generate request examples

{
  "data": "<unknown>",
  "meta": "<unknown>",
  "ok": 1
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "error": {
    "code": "<string>",
    "details": {
      "invalid_items": [
        {
          "actions": [
            "<string>"
          ],
          "resource": "<string>"
        }
      ]
    },
    "message": "<string>"
  },
  "ok": 0
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ORG-ID

string<uuid>

required

Path Parameters

group_id

string<uuid>

required

Body

application/json

access

object[]

Show child attributes

active

boolean

description

string

name

string

project_id

string<uuid> | null

deprecated

project_id is immutable and is rejected when supplied.

Response

Permission group updated

Preferred shape for successful JSON responses is { ok, data, meta } with list metadata (e.g. pagination totals) in top-level meta, not nested under data.

data

any | null

required

Response payload; may be null for no-content successes.

meta

any | null

required

Top-level metadata (e.g. pagination); null when unused.

enum<integer>

required

Available options:

1

List assignments for a permission group

Error

A valid request URL is required to generate request examples

{
  "data": "<unknown>",
  "meta": "<unknown>",
  "ok": 1
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "error": {
    "code": "<string>",
    "details": {
      "invalid_items": [
        {
          "actions": [
            "<string>"
          ],
          "resource": "<string>"
        }
      ]
    },
    "message": "<string>"
  },
  "ok": 0
}

Overview

HTTP API

Update a permission group

Authorizations

Headers

Path Parameters

Body

Response