API разрешений
Эндпоинты для управления разрешениями в системе.
Получение списка разрешений
Получение полного списка разрешений.
Запрос
GET /api/permissions
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Ответ
{
"permissions": [
{
"id": 1,
"name": "admin.users",
"description": "Управление пользователями"
},
{
"id": 2,
"name": "admin.roles",
"description": "Управление ролями"
},
{
"id": 3,
"name": "admin.pages",
"description": "Управление страницами"
}
]
}
Поля ответа
Поле | Тип | Описание |
---|---|---|
permissions | array | Массив разрешений |
id | integer | ID разрешения |
name | string | Имя разрешения |
description | string | Описание разрешения |
Коды ответов
Код | Описание |
---|---|
200 | Успешный запрос |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
Получение данных разрешения
Получение детальной информации о конкретном разрешении.
Запрос
GET /api/permissions/{id}
Параметры пути
Название | Тип | Описание |
---|---|---|
id | integer | ID разрешения |
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Ответ
{
"permission": {
"id": 1,
"name": "admin.users",
"description": "Управление пользователями"
}
}
Поля ответа
Поле | Тип | Описание |
---|---|---|
permission | object | Объект разрешения |
id | integer | ID разрешения |
name | string | Имя разрешения |
description | string | Описание разрешения |
Коды ответов
Код | Описание |
---|---|
200 | Успешный запрос |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
404 | Разрешение не найдено |
Создание разрешения
Создание нового разрешения в системе.
Запрос
POST /api/permissions
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Content-Type | string | Обязательный. application/json |
Тело запроса
{
"name": "admin.settings",
"description": "Управление настройками системы"
}
Параметры тела запроса
Название | Тип | Описание |
---|---|---|
name | string | Обязательный. Имя разрешения |
description | string | Необязательный. Описание разрешения |
Ответ
{
"message": "Permission created successfully",
"permission": {
"id": 4,
"name": "admin.settings",
"description": "Управление настройками системы"
}
}
Коды ответов
Код | Описание |
---|---|
201 | Разрешение успешно создано |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
422 | Неверные параметры запроса |
Обновление разрешения
Обновление данных существующего разрешения.
Запрос
PUT /api/permissions/{id}
Параметры пути
Название | Тип | Описание |
---|---|---|
id | integer | ID разрешения |
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Content-Type | string | Обязательный. application/json |
Тело запроса
{
"name": "admin.system-settings",
"description": "Управление системными настройками"
}
Параметры тела запроса
Название | Тип | Описание |
---|---|---|
name | string | Необязательный. Имя разрешения |
description | string | Необязательный. Описание разрешения |
Ответ
{
"message": "Permission updated successfully",
"permission": {
"id": 4,
"name": "admin.system-settings",
"description": "Управление системными настройками"
}
}
Коды ответов
Код | Описание |
---|---|
200 | Разрешение успешно обновлено |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
404 | Разрешение не найдено |
422 | Неверные параметры запроса |
Удаление разрешения
Удаление разрешения из системы.
Запрос
DELETE /api/permissions/{id}
Параметры пути
Название | Тип | Описание |
---|---|---|
id | integer | ID разрешения |
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Ответ
{
"message": "Permission deleted successfully"
}
Коды ответов
Код | Описание |
---|---|
200 | Разрешение успешно удалено |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
404 | Разрешение не найдено |