APIСправочник
Пользователи
Свой профиль и управление аккаунтами для администратора.
Файл сгенерирован командой
yarn nx run api:export-openapiиз декораторов API и Zod-схем. Вручную не редактируется.
Свой профиль и управление аккаунтами для администратора.
GET /account-usage/{id}
Политика и активность аккаунта
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | AccountUsageView |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
PUT /account-usage/{id}
Изменить опциональные ограничения аккаунта
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Тело запроса
application/json— AccountPolicy
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | AccountUsageView |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
GET /account-usage/me
Своя активность и включённые ограничения
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | AccountUsageView |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
GET /users
Все аккаунты Только администратор.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | array<Account> |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
POST /users
Создать аккаунт Самостоятельной регистрации нет: аккаунты заводит администратор.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Тело запроса
application/json— AccountInput
Ответы
| Код | Описание | Схема |
|---|---|---|
| 201 | Создано или запущено. | Account |
| 400 | Неверный запрос: тело или параметры не прошли проверку. | ApiError |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 409 | Конфликт состояния: действие сейчас невозможно. | ApiError |
DELETE /users/{id}
Удалить аккаунт Вместе со всем, что он создал. Себя и последнего администратора удалить нельзя.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
id | path | да |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 204 | Аккаунт и его данные удалены. | — |
| 400 | Неверный запрос: тело или параметры не прошли проверку. | ApiError |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
PATCH /users/{id}
Изменить аккаунт Почта, имя, пароль, роль или отключение. Себя понизить или отключить нельзя.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
id | path | да |
Тело запроса
application/json— AccountPatch
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | Account |
| 400 | Неверный запрос: тело или параметры не прошли проверку. | ApiError |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
| 409 | Конфликт состояния: действие сейчас невозможно. | ApiError |
POST /users/{id}/revoke-sessions
Отозвать все сессии аккаунта
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 204 | Готово, тела нет. | — |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
GET /users/me
Свой аккаунт
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | Account |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
PATCH /users/me
Изменить свой профиль Картинку и пароль меняет каждый сам; для смены пароля нужен текущий.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Тело запроса
application/json— ProfilePatch