Returns the list of all available permissions in the system. Requires the usermanagement.read or secret.read permission.
GET /permissions
| Header | Value |
|---|
Authorization | Bearer <token> |
| Parameter | Type | Required | Description |
|---|
showAll | boolean | No | When true, returns all permissions including those not assigned to any role. Defaults to false. |
type | string | No | Filter permissions by type. Accepted values: all (default), action, resource. |
GET /permissions?type=action
Authorization: Bearer <token>
Returns a JSON array of permission objects. The X-Total-Count response header contains the total number of permissions returned.
| Header | Description |
|---|
X-Total-Count | Total number of permissions in the response. |
Array of permission objects. Each object typically contains:
| Field | Type | Description |
|---|
id | string | Permission identifier (e.g. usermanagement.read). |
type | string | Permission type (action or resource). |
description | string | Human-readable description of the permission. |
[
{
"id": "usermanagement.read",
"type": "action",
"description": "Read access to user management"
},
{
"id": "usermanagement.write",
"type": "action",
"description": "Write access to user management"
}
]
| Status | Description |
|---|
400 | Unknown type parameter value. |
403 | Insufficient permissions. |