Permissions API
Endpoints for managing permissions in the system.
Get Permissions List
Get the complete list of permissions.
Request
GET /api/permissions
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Response
{
"permissions": [
{
"id": 1,
"name": "admin.users",
"description": "User management"
},
{
"id": 2,
"name": "admin.roles",
"description": "Role management"
},
{
"id": 3,
"name": "admin.pages",
"description": "Page management"
}
]
}
Response Fields
Field | Type | Description |
---|---|---|
permissions | array | Array of permissions |
id | integer | Permission ID |
name | string | Permission name |
description | string | Permission description |
Response Codes
Code | Description |
---|---|
200 | Successful request |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
Get Permission Data
Get detailed information about a specific permission.
Request
GET /api/permissions/{id}
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Permission ID |
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Response
{
"permission": {
"id": 1,
"name": "admin.users",
"description": "User management"
}
}
Response Fields
Field | Type | Description |
---|---|---|
permission | object | Permission object |
id | integer | Permission ID |
name | string | Permission name |
description | string | Permission description |
Response Codes
Code | Description |
---|---|
200 | Successful request |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
404 | Permission not found |
Create Permission
Create a new permission in the system.
Request
POST /api/permissions
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Content-Type | string | Required. application/json |
Request Body
{
"name": "admin.settings",
"description": "System settings management"
}
Request Body Parameters
Name | Type | Description |
---|---|---|
name | string | Required. Permission name |
description | string | Optional. Permission description |
Response
{
"message": "Permission created successfully",
"permission": {
"id": 4,
"name": "admin.settings",
"description": "System settings management"
}
}
Response Codes
Code | Description |
---|---|
201 | Permission successfully created |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
422 | Invalid request parameters |
Update Permission
Update data of an existing permission.
Request
PUT /api/permissions/{id}
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Permission ID |
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Content-Type | string | Required. application/json |
Request Body
{
"name": "admin.system-settings",
"description": "System settings management"
}
Request Body Parameters
Name | Type | Description |
---|---|---|
name | string | Optional. Permission name |
description | string | Optional. Permission description |
Response
{
"message": "Permission updated successfully",
"permission": {
"id": 4,
"name": "admin.system-settings",
"description": "System settings management"
}
}
Response Codes
Code | Description |
---|---|
200 | Permission successfully updated |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
404 | Permission not found |
422 | Invalid request parameters |
Delete Permission
Delete a permission from the system.
Request
DELETE /api/permissions/{id}
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Permission ID |
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Response
{
"message": "Permission deleted successfully"
}
Response Codes
Code | Description |
---|---|
200 | Permission successfully deleted |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
404 | Permission not found |