For the complete documentation index, see llms.txt. This page is also available as Markdown.

Permission Groups

List permission groups

get

Returns every permission group known by the authorization service.

Responses
200

Permission groups list

application/json
get/api/permission_groups
GET /api/permission_groups HTTP/1.1
Accept: */*
{
  "data": [
    {
      "id": 3,
      "name": "data_dictionary"
    }
  ]
}

Create permission group

post

Creates a custom permission group.

Requires administrator access.

The group name must start with the configured custom prefix. Names without the prefix are rejected with 422.

Group names are unique: sending an existing name returns 422 with a "taken" error on name.

The response includes a Location header pointing at the newly created group.

Body

Payload for creating a permission group.

The name must start with the configured custom prefix. Names without the prefix are rejected with 422.

Responses
201

Permission group created

application/json
post/api/permission_groups
POST /api/permission_groups HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "permission_group": {
    "name": "custom_my_group"
  }
}
{
  "data": {
    "id": 3,
    "name": "data_dictionary"
  }
}

Get permission group

get

Returns the specified permission group.

Path parameters
idintegerRequired

Permission group ID.

Responses
200

Permission group detail

application/json
get/api/permission_groups/{id}
GET /api/permission_groups/{id} HTTP/1.1
Accept: */*
{
  "data": {
    "id": 3,
    "name": "data_dictionary"
  }
}

Update permission group

put

Updates the name of the specified permission group.

Requires administrator access.

The new name must start with the configured custom prefix. Names without the prefix are rejected with 422.

Path parameters
idintegerRequired

Permission group ID.

Body

Payload for updating a permission group.

The new name must start with the configured custom prefix. Names without the prefix are rejected with 422.

Responses
200

Permission group updated

application/json
put/api/permission_groups/{id}
PUT /api/permission_groups/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "permission_group": {
    "name": "custom_new_name"
  }
}
{
  "data": {
    "id": 3,
    "name": "data_dictionary"
  }
}

Delete permission group

delete

Permanently deletes the specified permission group.

Requires administrator access.

A permission group that still has permissions attached cannot be deleted: the request is rejected with 422.

Path parameters
idintegerRequired

Permission group ID.

Responses
204

Permission group deleted

No content

delete/api/permission_groups/{id}
DELETE /api/permission_groups/{id} HTTP/1.1
Accept: */*

No content

Update permission group

patch

Updates the name of the specified permission group.

Requires administrator access.

The new name must start with the configured custom prefix. Names without the prefix are rejected with 422.

Path parameters
idintegerRequired

Permission group ID.

Body

Payload for updating a permission group.

The new name must start with the configured custom prefix. Names without the prefix are rejected with 422.

Responses
200

Permission group updated

application/json
patch/api/permission_groups/{id}
PATCH /api/permission_groups/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "permission_group": {
    "name": "custom_new_name"
  }
}
{
  "data": {
    "id": 3,
    "name": "data_dictionary"
  }
}

Last updated