> For the complete documentation index, see [llms.txt](https://docs.api.intratool.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.api.intratool.de/api-reference/permissions.md).
# Permissions
## Introduction
`Permissions` are module-level abilities assigned to [Roles](/api-reference/roles.md). Use their IDs in a role's `permission_ids` request key.
The [Available Permissions](#available-permissions) catalog contains every configured permission.
## Model Definition
**Alias**
`permission`
**Attributes**
| Key | Type | Description |
| ------------- | --------- | ---------------------------------------------------------- |
| `id` | `integer` | Stable configured Permission ID. |
| `type` | `string` | Module group defined for the permission. |
| `name` | `string` | Permission key used by authorization checks. |
| `sort_number` | `integer` | Global order derived from the permission definition order. |
**Available Permissions**
The following configured permissions are ordered by `sort_number`. Each row contains its stable ID, permission key, module type, derived sort number, and meaning.
| ID | Key | Type | Sort | Meaning |
| ------ | ------------------------------------------------------------ | ----------------------------------- | ----- | ------------------------------------------- |
| `12` | `infoboard-show` | `infoboard` | `1` | Infoboard |
| `1` | `infoboard-administration-rights` | `infoboard` | `2` | Administration rights |
| `2` | `infoboard-create-entries` | `infoboard` | `3` | Create entries |
| `19` | `infoboard-see-all-entry-seen-users` | `infoboard` | `4` | View all "Viewed users" for entries |
| `20` | `infoboard-see-all-entry-read-users` | `infoboard` | `5` | View all "read users" for entries |
| `3` | `infoboard-edit-own-entries` | `infoboard` | `6` | Edit your own entries |
| `14` | `infoboard-pin-own-entries` | `infoboard` | `7` | Attach your own entries |
| `15` | `infoboard-schedule-own-entries` | `infoboard` | `8` | Schedule your own entries |
| `21` | `infoboard-reset-own-entries` | `infoboard` | `9` | Reset statistics/comments for own entries |
| `4` | `infoboard-delete-own-entries` | `infoboard` | `10` | Delete own entries |
| `5` | `infoboard-edit-all-entries` | `infoboard` | `11` | Edit all entries |
| `16` | `infoboard-pin-all-entries` | `infoboard` | `12` | Pin all entries |
| `17` | `infoboard-schedule-all-entries` | `infoboard` | `13` | Schedule all entries |
| `22` | `infoboard-reset-all-entries` | `infoboard` | `14` | Reset statistics/comments for all entries |
| `6` | `infoboard-delete-all-entries` | `infoboard` | `15` | Delete all entries |
| `7` | `infoboard-create-comments` | `infoboard` | `16` | Create comments |
| `8` | `infoboard-edit-own-comments` | `infoboard` | `17` | Edit your own comments |
| `9` | `infoboard-delete-own-comments` | `infoboard` | `18` | Delete own comments |
| `10` | `infoboard-edit-all-comments` | `infoboard` | `19` | Edit all comments |
| `11` | `infoboard-delete-all-comments` | `infoboard` | `20` | Delete all comments |
| `18` | `infoboard-see-private-comments` | `infoboard` | `21` | View private comments via "Extended access" |
| `23` | `infoboard-show-administration` | `infoboard` | `22` | Show administration |
| `24` | `infoboard-create-channels` | `infoboard` | `23` | Create channels |
| `25` | `infoboard-edit-own-channels` | `infoboard` | `24` | Edit your own channels |
| `26` | `infoboard-delete-own-channels` | `infoboard` | `25` | Delete own channels |
| `27` | `infoboard-edit-permitted-channels` | `infoboard` | `26` | Edit shared channels |
| `28` | `infoboard-delete-permitted-channels` | `infoboard` | `27` | Delete shared channels |
| `29` | `infoboard-edit-all-channels` | `infoboard` | `28` | Edit all channels |
| `30` | `infoboard-delete-all-channels` | `infoboard` | `29` | Delete all channels |
| `31` | `infoboard-channels-create-folders` | `infoboard` | `30` | Create folders in channels |
| `32` | `infoboard-channels-edit-own-folders` | `infoboard` | `31` | Edit own folders in channels |
| `33` | `infoboard-channels-delete-own-folders` | `infoboard` | `32` | Delete own folders in channels |
| `34` | `infoboard-channels-edit-all-folders` | `infoboard` | `33` | Edit all folders in channels |
| `35` | `infoboard-channels-delete-all-folders` | `infoboard` | `34` | Delete all folders in channels |
| `36` | `infoboard-edit-department-settings` | `infoboard` | `35` | Edit user group settings |
| `101` | `manual-show` | `manual` | `36` | Manuals |
| `100` | `manual-administration-rights` | `manual` | `37` | Administration rights |
| `108` | `manual-show-on-menu` | `manual` | `38` | Show in menu |
| `111` | `manual-show-administration` | `manual` | `39` | Show administration |
| `112` | `manual-create-chapters` | `manual` | `40` | Create chapter |
| `114` | `manual-edit-own-chapters` | `manual` | `41` | Edit your own chapters |
| `115` | `manual-delete-own-chapters` | `manual` | `42` | Delete own chapters |
| `116` | `manual-edit-permitted-chapters` | `manual` | `43` | Edit released chapters |
| `117` | `manual-delete-permitted-chapters` | `manual` | `44` | Delete released chapters |
| `118` | `manual-edit-all-chapters` | `manual` | `45` | Edit all chapters |
| `119` | `manual-delete-all-chapters` | `manual` | `46` | Delete all chapters |
| `102` | `manual-create-entries` | `manual` | `47` | Create entries |
| `125` | `manual-see-all-entry-seen-users` | `manual` | `48` | View all "Viewed users" for entries |
| `126` | `manual-see-all-entry-read-users` | `manual` | `49` | View all "Read users" for entries |
| `103` | `manual-edit-own-entries` | `manual` | `50` | Edit your own entries |
| `109` | `manual-reset-own-entries` | `manual` | `51` | Reset statistics for own entries |
| `104` | `manual-delete-own-entries` | `manual` | `52` | Delete your own entries |
| `121` | `manual-edit-permitted-entries` | `manual` | `53` | Edit released entries |
| `123` | `manual-reset-permitted-entries` | `manual` | `54` | Reset statistics for assigned entries |
| `124` | `manual-delete-permitted-entries` | `manual` | `55` | Delete released entries |
| `105` | `manual-edit-all-entries` | `manual` | `56` | Edit all entries |
| `110` | `manual-reset-all-entries` | `manual` | `57` | Reset statistics for all entries |
| `106` | `manual-delete-all-entries` | `manual` | `58` | Delete all entries |
| `150` | `contact-lists-show` | `contact-lists` | `59` | Contact lists |
| `151` | `contact-lists-administration-rights` | `contact-lists` | `60` | Administration rights |
| `152` | `contact-lists-create-contact-lists` | `contact-lists` | `61` | Create contact lists |
| `153` | `contact-lists-edit-own-contact-lists` | `contact-lists` | `62` | Edit your own contact lists |
| `154` | `contact-lists-delete-own-contact-lists` | `contact-lists` | `63` | Delete your own contact lists |
| `155` | `contact-lists-edit-all-contact-lists` | `contact-lists` | `64` | Edit all contact lists |
| `156` | `contact-lists-delete-all-contact-lists` | `contact-lists` | `65` | Delete all contact lists |
| `157` | `contact-lists-create-contacts` | `contact-lists` | `66` | Create contacts |
| `158` | `contact-lists-edit-own-contacts` | `contact-lists` | `67` | Edit your own contacts |
| `159` | `contact-lists-delete-own-contacts` | `contact-lists` | `68` | Delete own contacts |
| `160` | `contact-lists-edit-all-contacts` | `contact-lists` | `69` | Edit all contacts |
| `161` | `contact-lists-delete-all-contacts` | `contact-lists` | `70` | Delete all contacts |
| `204` | `tasks-show` | `tasks` | `71` | Tasks |
| `200` | `tasks-administration-rights` | `tasks` | `72` | Administration rights |
| `201` | `tasks-show-administration` | `tasks` | `73` | Show administration |
| `205` | `tasks-show-reports-group-account` | `tasks` | `74` | Show reports for group account |
| `202` | `tasks-show-reports-users` | `tasks` | `75` | Display reports for users |
| `206` | `tasks-reports-show-all` | `tasks` | `76` | Show all reports |
| `203` | `tasks-show-automated-reports` | `tasks` | `77` | Display automated reports |
| `250` | `tasks-2-show` | `tasks-2` | `78` | Tasks 2.0 |
| `251` | `tasks-2-administration-rights` | `tasks-2` | `79` | Administration rights |
| `277` | `tasks-2-show-on-menu` | `tasks-2` | `80` | Show in menu |
| `252` | `tasks-2-show-administration` | `tasks-2` | `81` | Show administration |
| `253` | `tasks-2-create-templates` | `tasks-2` | `82` | Create templates |
| `254` | `tasks-2-edit-own-templates` | `tasks-2` | `83` | Edit your own templates |
| `255` | `tasks-2-delete-own-templates` | `tasks-2` | `84` | Delete your own templates |
| `256` | `tasks-2-edit-permitted-templates` | `tasks-2` | `85` | Editing released templates |
| `257` | `tasks-2-delete-permitted-templates` | `tasks-2` | `86` | Delete released templates |
| `258` | `tasks-2-edit-all-templates` | `tasks-2` | `87` | Edit all templates |
| `259` | `tasks-2-delete-all-templates` | `tasks-2` | `88` | Delete all templates |
| `260` | `tasks-2-create-template-folders` | `tasks-2` | `89` | Create template folder |
| `261` | `tasks-2-edit-own-template-folders` | `tasks-2` | `90` | Edit your own templates folder |
| `262` | `tasks-2-delete-own-template-folders` | `tasks-2` | `91` | Delete own templates folder |
| `263` | `tasks-2-edit-all-template-folders` | `tasks-2` | `92` | Edit all templates folder |
| `264` | `tasks-2-delete-all-template-folders` | `tasks-2` | `93` | Delete all template folders |
| `265` | `tasks-2-create-assignments` | `tasks-2` | `94` | Create assignments |
| `266` | `tasks-2-edit-own-assignments` | `tasks-2` | `95` | Edit your own assignments |
| `267` | `tasks-2-delete-own-assignments` | `tasks-2` | `96` | Delete your own assignments |
| `268` | `tasks-2-edit-permitted-assignments` | `tasks-2` | `97` | Edit released assignments |
| `269` | `tasks-2-delete-permitted-assignments` | `tasks-2` | `98` | Delete released assignments |
| `278` | `tasks-2-create-quick-assignments` | `tasks-2` | `99` | Create quick tasks |
| `270` | `tasks-2-edit-all-assignments` | `tasks-2` | `100` | Edit all assignments |
| `271` | `tasks-2-delete-all-assignments` | `tasks-2` | `101` | Delete all assignments |
| `272` | `tasks-2-create-assignment-folders` | `tasks-2` | `102` | Create assignment folder |
| `273` | `tasks-2-edit-own-assignment-folders` | `tasks-2` | `103` | Edit your own assignment folders |
| `274` | `tasks-2-delete-own-assignment-folders` | `tasks-2` | `104` | Delete own assignment folders |
| `275` | `tasks-2-edit-all-assignment-folders` | `tasks-2` | `105` | Edit all assignment folders |
| `276` | `tasks-2-delete-all-assignment-folders` | `tasks-2` | `106` | Delete all assignment folders |
| `306` | `calendar-show` | `calendar` | `107` | Calendar |
| `300` | `calendar-administration-rights` | `calendar` | `108` | Administration rights |
| `301` | `calendar-create-events` | `calendar` | `109` | Create Events |
| `302` | `calendar-edit-own-events` | `calendar` | `110` | Edit your own Events |
| `303` | `calendar-delete-own-events` | `calendar` | `111` | Delete your own Events |
| `304` | `calendar-edit-all-events` | `calendar` | `112` | Edit all Events |
| `305` | `calendar-delete-all-events` | `calendar` | `113` | Delete all Events |
| `411` | `filemanager-show` | `filemanager` | `114` | File manager |
| `400` | `filemanager-administration-rights` | `filemanager` | `115` | Administration rights |
| `412` | `filemanager-show-on-menu` | `filemanager` | `116` | Show in menu |
| `401` | `filemanager-upload-files` | `filemanager` | `117` | Upload files |
| `402` | `filemanager-edit-own-files` | `filemanager` | `118` | Edit own files |
| `403` | `filemanager-delete-own-files` | `filemanager` | `119` | Delete own files |
| `409` | `filemanager-edit-all-files` | `filemanager` | `120` | Edit all files |
| `410` | `filemanager-delete-all-files` | `filemanager` | `121` | Delete all files |
| `404` | `filemanager-create-directories` | `filemanager` | `122` | Create folder |
| `405` | `filemanager-edit-own-directories` | `filemanager` | `123` | Edit your own folders |
| `406` | `filemanager-delete-own-directories` | `filemanager` | `124` | Delete own folders |
| `407` | `filemanager-edit-all-directories` | `filemanager` | `125` | Edit all folders |
| `408` | `filemanager-delete-all-directories` | `filemanager` | `126` | Delete all folders |
| `450` | `forms-show` | `forms` | `127` | Forms |
| `451` | `forms-administration-rights` | `forms` | `128` | Administration rights |
| `453` | `forms-show-on-menu` | `forms` | `129` | Show in menu |
| `452` | `forms-show-administration` | `forms` | `130` | Show administration |
| `454` | `forms-messages-show-all` | `forms` | `131` | View all sent forms |
| `455` | `forms-create-forms` | `forms` | `132` | Create forms |
| `456` | `forms-edit-own-forms` | `forms` | `133` | Edit your own forms |
| `457` | `forms-delete-own-forms` | `forms` | `134` | Delete own forms |
| `458` | `forms-edit-permitted-forms` | `forms` | `135` | Edit released forms |
| `459` | `forms-delete-permitted-forms` | `forms` | `136` | Delete released forms |
| `460` | `forms-edit-all-forms` | `forms` | `137` | Edit all forms |
| `461` | `forms-delete-all-forms` | `forms` | `138` | Delete all forms |
| `462` | `forms-create-folders` | `forms` | `139` | Create folder |
| `463` | `forms-edit-own-folders` | `forms` | `140` | Edit own folders |
| `464` | `forms-delete-own-folders` | `forms` | `141` | Delete own folders |
| `465` | `forms-edit-all-folders` | `forms` | `142` | Edit all folders |
| `466` | `forms-delete-all-folders` | `forms` | `143` | Delete all folders |
| `467` | `forms-messages-delete` | `forms` | `144` | Delete sent forms |
| `468` | `forms-message-confirmations-reset` | `forms` | `145` | Request confirmation of receipt again |
| `1000` | `reports-show` | `reports` | `146` | Reports |
| `1001` | `reports-administration-rights` | `reports` | `147` | Administration rights |
| `1002` | `reports-show-administration` | `reports` | `148` | Show administration |
| `1200` | `chat-show` | `chat` | `149` | Messages |
| `1201` | `chat-administration-rights` | `chat` | `150` | Administration rights |
| `1202` | `chat-show-on-menu` | `chat` | `151` | Show in menu |
| `1203` | `chat-show-administration` | `chat` | `152` | Show administration |
| `1204` | `chat-create-group-conversation` | `chat` | `153` | Create group chat |
| `1205` | `chat-create-unrelated-conversation` | `chat` | `154` | Create chat without topic |
| `1206` | `chat-create-infoboard-post-related-conversation` | `chat` | `155` | Create chat for infoboard entry |
| `1207` | `chat-create-infoboard-comment-related-conversation` | `chat` | `156` | Create chat for infoboard comment |
| `1208` | `chat-create-form-related-conversation` | `chat` | `157` | Create chat to form |
| `1209` | `chat-create-form-message-related-conversation` | `chat` | `158` | Create chat for sent form |
| `1210` | `chat-create-manual-chapter-related-conversation` | `chat` | `159` | Chat to create manual chapter |
| `1211` | `chat-create-manual-entry-related-conversation` | `chat` | `160` | Create chat for manual entry |
| `1212` | `chat-create-task-execution-related-conversation` | `chat` | `161` | Create chat for task |
| `1213` | `chat-create-task-template-related-conversation` | `chat` | `162` | Create chat for task template |
| `1214` | `chat-create-task-template-composition-related-conversation` | `chat` | `163` | Chat to create task list |
| `1215` | `chat-create-task-assignment-related-conversation` | `chat` | `164` | Create chat for task assignment |
| `1216` | `chat-create-filemanager-directory-related-conversation` | `chat` | `165` | Create chat for file manager folder |
| `1217` | `chat-create-filemanager-file-related-conversation` | `chat` | `166` | Create chat for file manager file |
| `1218` | `chat-create-report-related-conversation` | `chat` | `167` | Chat to create report |
| `1219` | `chat-create-voice-message` | `chat` | `168` | Create voice messages |
| `475` | `dashboard-show` | `dashboard` | `169` | Dashboard |
| `476` | `dashboard-administration-rights` | `dashboard` | `170` | Administration rights |
| `477` | `dashboard-infoboard-item` | `dashboard` | `171` | Show infoboard element |
| `478` | `dashboard-tasks-item` | `dashboard` | `172` | Show task element |
| `479` | `dashboard-filemanager-item` | `dashboard` | `173` | Show file manager element |
| `501` | `settings-show` | `settings` | `174` | Settings |
| `500` | `settings-administration-rights` | `settings` | `175` | Administration rights |
| `1600` | `translations-show` | `translations` | `176` | Language |
| `1601` | `translations-set-own-language` | `translations` | `177` | Set your own language |
| `1602` | `translations-request-automatic-translations` | `translations` | `178` | Request automatic translations |
| `701` | `departments-show` | `departments` | `179` | User groups |
| `700` | `departments-administration-rights` | `departments` | `180` | Administration rights |
| `801` | `roles-show` | `roles` | `181` | Roles |
| `800` | `roles-administration-rights` | `roles` | `182` | Administration rights |
| `604` | `users-show` | `users` | `183` | Users |
| `600` | `users-administration-rights` | `users` | `184` | Administration rights |
| `601` | `users-create-users` | `users` | `185` | Create user |
| `602` | `users-edit-users` | `users` | `186` | Edit user |
| `605` | `users-create-login-tokens` | `users` | `187` | Create auto-login URLs for users |
| `603` | `users-delete-users` | `users` | `188` | Delete user |
| `1500` | `surveys-show` | `surveys` | `189` | Surveys |
| `1501` | `surveys-administration-rights` | `surveys` | `190` | Administration rights |
| `1502` | `surveys-show-on-menu` | `surveys` | `191` | Show in menu |
| `1503` | `surveys-show-administration` | `surveys` | `192` | Show administration |
| `1504` | `surveys-create-survey` | `surveys` | `193` | Create survey |
| `1505` | `surveys-edit-own-survey` | `surveys` | `194` | Edit your own surveys |
| `1506` | `surveys-delete-own-survey` | `surveys` | `195` | Delete your own surveys |
| `1507` | `surveys-edit-permitted-survey` | `surveys` | `196` | Edit released surveys |
| `1508` | `surveys-delete-permitted-survey` | `surveys` | `197` | Delete released surveys |
| `1509` | `surveys-edit-all-survey` | `surveys` | `198` | Edit all surveys |
| `1510` | `surveys-delete-all-survey` | `surveys` | `199` | Delete all surveys |
| `1511` | `surveys-create-folders` | `surveys` | `200` | Create folder |
| `1512` | `surveys-edit-own-folders` | `surveys` | `201` | Edit your own folders |
| `1513` | `surveys-delete-own-folders` | `surveys` | `202` | Delete own folders |
| `1514` | `surveys-edit-all-folders` | `surveys` | `203` | Edit all folders |
| `1515` | `surveys-delete-all-folders` | `surveys` | `204` | Delete all folders |
| `1400` | `shared-items-show` | `shared-items` | `205` | Shared items |
| `1401` | `shared-items-administration-rights` | `shared-items` | `206` | Administration rights |
| `1402` | `shared-items-show-administration` | `shared-items` | `207` | Show administration |
| `13` | `shared-items-create-infoboard-post-items` | `shared-items` | `208` | Share infoboard entries |
| `1404` | `shared-items-create-infoboard-comment-items` | `shared-items` | `209` | Share infoboard comments |
| `113` | `shared-items-create-manual-chapter-items` | `shared-items` | `210` | Share manual chapter |
| `107` | `shared-items-create-manual-entry-items` | `shared-items` | `211` | Share manual entries |
| `307` | `shared-items-create-calendar-event-items` | `shared-items` | `212` | Share calendar events |
| `414` | `shared-items-create-filemanager-directory-items` | `shared-items` | `213` | Share file manager folder |
| `413` | `shared-items-create-filemanager-file-items` | `shared-items` | `214` | Share file manager files |
| `1405` | `shared-items-create-form-items` | `shared-items` | `215` | Share forms |
| `1411` | `shared-items-create-form-message-items` | `shared-items` | `216` | Share form submissions |
| `1410` | `shared-items-create-task-execution-items` | `shared-items` | `217` | Share task executions |
| `1406` | `shared-items-edit-own-items` | `shared-items` | `218` | Edit your own shared items |
| `1407` | `shared-items-delete-own-items` | `shared-items` | `219` | Delete your own shared items |
| `1408` | `shared-items-edit-all-items` | `shared-items` | `220` | Edit all shared items |
| `1409` | `shared-items-delete-all-items` | `shared-items` | `221` | Delete all shared items |
| `1700` | `additional-attributes-show` | `additional-attributes` | `222` | Additional attributes |
| `1701` | `additional-attributes-administration-rights` | `additional-attributes` | `223` | Administration rights |
| `900` | `tags-show` | `tags` | `224` | Tags |
| `901` | `tags-administration-rights` | `tags` | `225` | Administration rights |
| `650` | `profile-edit-personal-information-show` | `profile-edit-personal-information` | `226` | Edit personal profile details |
| `1100` | `code-scanner-show` | `code-scanner` | `227` | Code scanner |
| `1101` | `code-scanner-show-on-header` | `code-scanner` | `228` | Show in header |
| `1102` | `code-scanner-show-on-menu` | `code-scanner` | `229` | Show in menu |
| `1103` | `code-scanner-allow-external-redirects` | `code-scanner` | `230` | Allow external redirects |
## List
List available permissions.
**Definition**
`GET` `/api/permissions`
**Request Keys**
| Key | Type | Default | Description |
| --------- | --------- | ---------------- | ------------------------------------- |
| `selects` | `string` | All fields | Comma-separated fields to return. |
| `limit` | `integer` | No limit | Maximum number of permissions. |
| `filter` | `object` | No filters | Value filters applied to permissions. |
| `sort` | `string` | Repository order | Sort expression. |
**Behavior**
The authenticated user requires the `roles-show` module permission.
**Example Request**
{% tabs %}
{% tab title="PHP" %}
```php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/permissions', [
'headers' => ['Authorization' => "Bearer {accessToken}"],
'query' => [
'filter' => [
'id' => ['in' => '12,101']
],
'sort' => 'sort_number',
'limit' => 2
]
]);
```
{% endtab %}
{% endtabs %}
**Example Response**
```json
[
{
"id": 12,
"type": "infoboard",
"name": "infoboard-show",
"sort_number": 1
},
{
"id": 101,
"type": "manual",
"name": "manual-show",
"sort_number": 36
}
]
```
## Show
Show one permission.
**Definition**
`GET` `/api/permissions/{permission}`
**Route Parameters**
| Parameter | Type | Description |
| ------------ | --------- | -------------- |
| `permission` | `integer` | Permission ID. |
**Request Keys**
| Key | Type | Default | Description |
| --------- | -------- | ---------- | --------------------------------- |
| `selects` | `string` | All fields | Comma-separated fields to return. |
**Behavior**
The authenticated user requires the `roles-show` module permission.
**Example Request**
{% tabs %}
{% tab title="PHP" %}
```php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/permissions/101', [
'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
```
{% endtab %}
{% endtabs %}
**Example Response**
```json
{
"id": 101,
"type": "manual",
"name": "manual-show",
"sort_number": 36
}
```