Скачать бесплатно

API: пользователи и аудит

Методы API PCDesk для управления сотрудниками организации и выгрузки журнала аудита, включая экспорт в CSV.

Обновлено 31 августа 2026 г.


Все примеры подразумевают заголовок X-API-Key из статьи API: обзор и авторизация. Методы этого раздела требуют роль «Техник» или «Администратор» - под ролью «Наблюдатель» они недоступны даже при отмеченных правах.

Список сотрудников

Запрос

GET /api/v1/users

Право: чтение пользователей.

Возвращает сотрудников организации с ролями и состоянием: приглашён, активен, заблокирован.

Пример

curl -H "X-API-Key: ВАШ_КЛЮЧ" \
  https://pcdesk.ru/api/v1/users

Приглашение сотрудника

Создаёт сотрудника и отправляет ему письмо со ссылкой. Пароль в запросе не передаётся: человек задаёт его сам по ссылке из письма, и администратор чужой пароль не видит.

Запрос

POST /api/v1/users

Право: изменение пользователей.

Тело

ПолеТипОбязательноеОписание
emailстрокадаАдрес почты сотрудника
roleVIEWER, TECHNICIAN или ADMINнетРоль, по умолчанию VIEWER

Пример

curl -X POST -H "X-API-Key: ВАШ_КЛЮЧ" \
  -H "Content-Type: application/json" \
  -d '{"email":"ivanov@example.ru","role":"TECHNICIAN"}' \
  https://pcdesk.ru/api/v1/users

Так удобно завести сотрудников из своей кадровой системы: при приёме на работу создаёте учётную запись сразу с нужной ролью.

Повторная отправка приглашения

Запрос

POST /api/v1/users/{id}/invite/resend

Право: изменение пользователей.

Нужен, когда письмо не дошло или ссылка просрочена.

Изменение сотрудника

Запрос

PATCH /api/v1/users/{id}

Право: изменение пользователей. Так меняется роль и состояние сотрудника - например, блокировка на время отпуска.

Последнего активного администратора организации заблокировать нельзя: запрос будет отклонён, иначе организация осталась бы без управления.

Удаление сотрудника

Запрос

DELETE /api/v1/users/{id}

Право: изменение пользователей.

Действия сотрудника остаются в журнале аудита и после удаления учётной записи - иначе журнал перестал бы отвечать на вопрос, кто именно что сделал.

Журнал аудита

Возвращает события безопасности организации: входы, изменения устройств и политик, работу с записями, выпуск и отзыв ключей. Типов событий больше шестидесяти; как они сгруппированы - в статье Аудит.

Запрос

GET /api/v1/audit

Право: чтение журнала аудита.

Параметры

ПараметрТипОписание
eventTypeстрокаОдин тип события
userIdстрокаСобытия одного сотрудника
fromдатаНачало периода в формате ISO 8601
toдатаКонец периода
limitчислоСколько записей вернуть

Пример

curl -H "X-API-Key: ВАШ_КЛЮЧ" \
  "https://pcdesk.ru/api/v1/audit?from=2026-08-01T00:00:00Z&limit=500"

Выгрузка аудита в CSV

Запрос

GET /api/v1/audit/export.csv

Право: чтение журнала аудита.

Отдаёт файл потоком, с теми же параметрами фильтрации, что и обычный список. Подходит для ежедневной выгрузки в хранилище или для передачи журнала в систему сбора событий.

Пример

curl -H "X-API-Key: ВАШ_КЛЮЧ" \
  "https://pcdesk.ru/api/v1/audit/export.csv?from=2026-08-01T00:00:00Z" \
  -o audit-avgust.csv

Файл сохраняется в кодировке, которую Excel открывает без дополнительных настроек.

Смежные статьи