List permissions

Returns the list of all available permissions in the system. Requires the usermanagement.read or secret.read permission.

Request

GET /permissions

Headers

HeaderValue
AuthorizationBearer <token>

Query Parameters

ParameterTypeRequiredDescription
showAllbooleanNoWhen true, returns all permissions including those not assigned to any role. Defaults to false.
typestringNoFilter permissions by type. Accepted values: all (default), action, resource.

Example Request

GET /permissions?type=action
Authorization: Bearer <token>

Response

Returns a JSON array of permission objects. The X-Total-Count response header contains the total number of permissions returned.

Response Headers

HeaderDescription
X-Total-CountTotal number of permissions in the response.

Response Body

Array of permission objects. Each object typically contains:

FieldTypeDescription
idstringPermission identifier (e.g. usermanagement.read).
typestringPermission type (action or resource).
descriptionstringHuman-readable description of the permission.

Example Response

[
  {
    "id": "usermanagement.read",
    "type": "action",
    "description": "Read access to user management"
  },
  {
    "id": "usermanagement.write",
    "type": "action",
    "description": "Write access to user management"
  }
]

Error Responses

StatusDescription
400Unknown type parameter value.
403Insufficient permissions.