diff --git a/docs/server-api-v1/auth.md b/docs/server-api-v1/auth.md index 8139dc5..479dd7d 100644 --- a/docs/server-api-v1/auth.md +++ b/docs/server-api-v1/auth.md @@ -23,4 +23,23 @@ "status": "error", "message": "Wrong login or password" } + ``` + +--- + +### GET `/api/v1/auth/logout` +Убить токен авторизации, выйти из системы. При этом в заголовке должен присутствовать токен + +### Ответ в случае успеха +```json + { + "status": "ok" + } + ``` + +### Ответ, если что-то пошло не так +```json + { + "status": "error" + } ``` \ No newline at end of file diff --git a/docs/server-api-v1/events.md b/docs/server-api-v1/events.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/server-api-v1/events.md diff --git a/docs/server-api-v1/groups.md b/docs/server-api-v1/groups.md new file mode 100644 index 0000000..8b1ebbd --- /dev/null +++ b/docs/server-api-v1/groups.md @@ -0,0 +1,2 @@ +## Групы пользователей +В основном это нужно для назначения прав пользователям. \ No newline at end of file diff --git a/docs/server-api-v1/logs.md b/docs/server-api-v1/logs.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/server-api-v1/logs.md diff --git a/docs/server-api-v1/users.md b/docs/server-api-v1/users.md new file mode 100644 index 0000000..56422de --- /dev/null +++ b/docs/server-api-v1/users.md @@ -0,0 +1,47 @@ +## Управлениями пользователями. +- Пользователей может добавлять и удалять только супер админ. +- Количество администраторов в системе не ограничено, однако супер админ может быть только один, это первый пользователь зарегистрированный в системе. + +--- + +### POST `/api/v1/users/new_user` +Добавить в систему нового пользователя. +- Нового пользователя может добавить как админ так и суперадмин, но назначить группу прав ниже своей. + +--- + +### GET `/api/v1/users/list` +Получить список пользователей + +--- + +### GET `/api/v1/users/id/{{id}}` +Получить все доступные данные о пользователе. + +--- + +### POST `/api/v1/users/id/{{id}}/update` +Редактирование пользователя + +--- + +### POST `/api/v1/users/id/{{id}}/update/password` +Изменить пароль, от 6 любых символов, больше критериев нет. + +--- + +### GET `/api/v1/users/id/{{id}}/reset_password` +- Доступно только администратору, сбрасывает пароль выбранному пользователю. +- Новый временный пароль будет сгенерирован и вернётся в ответе. +#### Примечания +- Админ может сбросить пароль лишь простым пользователям. +- Админу сбросить пароль может лишь суперадминистратор + +--- + +### GET `/api/v1/users/id/{{id}}/rules` +Вернуть таблицу прав пользователя. +- Это доступно для администраторов, но только в отношении себя и прав обычных пользователей. +- Обычные пользователи не могут получить таблицу своих прав. +- Суперадмин может получить таблицу прав любого пользователя. Сам при этом обладает по умолчанию всеми доступными правами. +- **ВАЖНО!** Это права не отдельно взятого пользователя, а группы в которой состоит пользователь. \ No newline at end of file