Перейти к содержимому
LegalStack
API

Безопасность и доступ

REST API раздела «Безопасность и доступ»: 139 операций.

Базовый адрес: https://api.legalstack.ru. Спецификация: openapi/security.json.

Аутентификация

Регистрация, вход, восстановление пароля, верификация e-mail.

Пользователи

Управление пользователями.

Устройства и сессии

Активные сессии и устройства пользователя.

Команды

Управление командами.

Группы

Группы пользователей.

Оргструктура

Оргструктура: подразделения, руководители, место сотрудников и агентов.

Приглашения

Приглашения пользователей в команду.

OAuth 2.0

OAuth 2.0: авторизация, выдача, отзыв и проверка токенов.

OAuth-приложения

Управление OAuth-приложениями.

Персональные токены

Персональные API-токены.

Каталог OAuth-scopes

Каталог OAuth-scopes платформы.

Единый вход (SSO)

Единый вход (SSO): подключения SAML и OIDC для команды.

Вебхуки

Подписки на вебхуки и проверка подписей.

Ключи JWKS

Публичные ключи (JWKS) для проверки подписи JWT.

Контроль доступа

Контроль доступа: правила, проверки, матрицы.

Агенты

Агенты команды: настройки, история версий и откат.

Доступ к агентам

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

Лимиты агентов

Лимиты работы агентов: месячный расход команды и сотрудников, лимиты на сотрудника.

Аудит безопасности

Журнал аудита событий безопасности.

Защита от ботов

Защита от ботов: задачи proof-of-work (ALTCHA).

Поддержка

Обращения пользователей в поддержку.

Операции

Всего операций: 139. У каждой операции своя страница со схемами запроса и ответа и примерами вызова.

Аутентификация

МетодПутьОперация
POST/api/v1/security/auth/2fa/disableОтключить 2FA
POST/api/v1/security/auth/2fa/enable-confirmПодтвердить настройку 2FA первым кодом
POST/api/v1/security/auth/2fa/enable-initЗапустить настройку 2FA (TOTP)
POST/api/v1/security/auth/2fa/regenerate-codesПеревыпустить резервные коды
PUT/api/v1/security/auth/change-passwordСмена пароля
POST/api/v1/security/auth/loginВход
POST/api/v1/security/auth/logoutВыход
DELETE/api/v1/security/auth/profileУдалить текущий аккаунт
GET/api/v1/security/auth/profileПрофиль текущего пользователя
PUT/api/v1/security/auth/profileОбновить профиль
POST/api/v1/security/auth/refreshОбновить токен доступа
POST/api/v1/security/auth/registerРегистрация
POST/api/v1/security/auth/request-password-resetЗапрос сброса пароля
POST/api/v1/security/auth/resend-verificationПовторно отправить письмо подтверждения
POST/api/v1/security/auth/reset-passwordСброс пароля
POST/api/v1/security/auth/verify-emailПодтвердить e-mail
POST/api/v1/security/auth/verify-totpПодтверждение 2FA при входе

Пользователи

МетодПутьОперация
GET/api/v1/security/usersСписок пользователей команды
POST/api/v1/security/users/link-telegramПривязать Telegram-аккаунт
DELETE/api/v1/security/users/me/awayСнять отметку об отсутствии
PUT/api/v1/security/users/me/awayОтметить отсутствие текущего пользователя
DELETE/api/v1/security/users/me/favoritesУбрать из избранного
GET/api/v1/security/users/me/favoritesИзбранное текущего пользователя
POST/api/v1/security/users/me/favoritesДобавить в избранное
PATCH/api/v1/security/users/me/onboardingЗавершить онбординг текущего пользователя
GET/api/v1/security/users/search-by-emailНайти пользователя по e-mail
GET/api/v1/security/users/teamСписок участников команды
POST/api/v1/security/users/telegram/generate-codeСгенерировать код привязки Telegram
GET/api/v1/security/users/telegram/statusСтатус привязки Telegram для текущего пользователя
DELETE/api/v1/security/users/telegram/unlinkОтвязать Telegram текущего пользователя
POST/api/v1/security/users/unlink-telegramОтвязать Telegram-аккаунт
GET/api/v1/security/users/with-telegramСписок пользователей с привязанным Telegram
DELETE/api/v1/security/users/{id}Удалить пользователя
PUT/api/v1/security/users/{id}/groupsОбновить группы пользователя
GET/api/v1/security/users/{id}/handoverЧто перейдёт преемнику при удалении участника
PUT/api/v1/security/users/{id}/roleОбновить роль пользователя

Устройства и сессии

МетодПутьОперация
DELETE/api/v1/security/me/devicesОтозвать все устройства, кроме текущего
GET/api/v1/security/me/devicesАктивные устройства текущего пользователя
DELETE/api/v1/security/me/devices/{deviceId}Отозвать устройство

Команды

МетодПутьОперация
GET/api/v1/security/teams/currentПолучить текущую команду
PATCH/api/v1/security/teams/currentОбновить текущую команду
DELETE/api/v1/security/teams/current/ownership-transferОтменить передачу владения командой
POST/api/v1/security/teams/current/ownership-transferЗапросить передачу владения командой
POST/api/v1/security/teams/current/ownership-transfer/acceptПринять владение командой
POST/api/v1/security/teams/current/ownership-transfer/declineОтклонить передачу владения командой
PATCH/api/v1/security/teams/current/slugСменить короткое имя команды (slug)

Группы

МетодПутьОперация
GET/api/v1/security/groupsСписок групп
POST/api/v1/security/groupsСоздать группу
DELETE/api/v1/security/groups/{id}Удалить группу
GET/api/v1/security/groups/{id}Получить группу по id
PATCH/api/v1/security/groups/{id}Обновить группу

Оргструктура

МетодПутьОперация
GET/api/v1/security/orgОргструктура команды
PUT/api/v1/security/org/agents/{agentId}Место агента в структуре
PUT/api/v1/security/org/headРуководитель команды
PUT/api/v1/security/org/members/{userId}Место сотрудника в структуре
POST/api/v1/security/org/unitsСоздать подразделение
DELETE/api/v1/security/org/units/{id}Удалить подразделение
PATCH/api/v1/security/org/units/{id}Изменить подразделение

Приглашения

МетодПутьОперация
GET/api/v1/security/invitesСписок ожидающих приглашений
POST/api/v1/security/invitesСоздать приглашение
DELETE/api/v1/security/invites/{id}Отменить приглашение
GET/api/v1/security/invites/{token}Получить приглашение по токену
POST/api/v1/security/invites/{token}/acceptПринять приглашение как новый пользователь
POST/api/v1/security/invites/{token}/joinПерейти в команду по приглашению

OAuth 2.0

МетодПутьОперация
GET/.well-known/oauth-authorization-serverМетаданные сервера авторизации OAuth 2.0 (RFC 8414)
GET/.well-known/openid-configurationOpenID Connect Discovery 1.0
GET/oauth/authorizeЭндпоинт авторизации OAuth 2.0 (RFC 6749 §3.1, PKCE RFC 7636)
GET/oauth/authorize/contextКонтекст экрана согласия OAuth (имя клиента, scopes, redirect_uri)
POST/oauth/authorize/decisionРешение пользователя по экрану согласия OAuth (выдача кода или отказ)
POST/oauth/introspectИнтроспекция токена (RFC 7662)
POST/oauth/registerДинамическая регистрация клиента OAuth 2.0 (RFC 7591)
POST/oauth/revokeОтзыв токена (RFC 7009)
POST/oauth/tokenЭндпоинт выдачи токенов OAuth 2.0 (RFC 6749 §3.2)
GET/oauth/userinfoЭндпоинт UserInfo (профиль текущего пользователя)

OAuth-приложения

МетодПутьОперация
GET/api/v1/security/oauth/clientsСписок OAuth-клиентов
POST/api/v1/security/oauth/clientsСоздать OAuth-клиента
DELETE/api/v1/security/oauth/clients/{id}Удалить OAuth-клиента
GET/api/v1/security/oauth/clients/{id}Получить OAuth-клиента
PATCH/api/v1/security/oauth/clients/{id}Обновить OAuth-клиента
POST/api/v1/security/oauth/clients/{id}/rotate-secretСгенерировать новый секрет клиента

Персональные токены

МетодПутьОперация
GET/api/v1/security/tokensСписок персональных токенов
POST/api/v1/security/tokensСоздать персональный токен
DELETE/api/v1/security/tokens/{id}Отозвать персональный токен

Каталог OAuth-scopes

МетодПутьОперация
GET/api/v1/security/scopesСписок доступных OAuth-scopes

Единый вход (SSO)

МетодПутьОперация
GET/api/v1/security/admin/sso/providersСписок SSO-провайдеров команды
POST/api/v1/security/admin/sso/providersСоздать SSO-провайдер для команды
DELETE/api/v1/security/admin/sso/providers/{id}Удалить SSO-провайдер
PUT/api/v1/security/admin/sso/providers/{id}Обновить SSO-провайдер
POST/api/v1/security/admin/sso/providers/{id}/domainsПривязать email-домен к SSO-провайдеру
DELETE/api/v1/security/admin/sso/providers/{id}/domains/{domain}Отвязать email-домен от SSO-провайдера
GET/api/v1/security/sso/callbackЗавершение входа через OIDC — обмен кода на токены платформы
GET/api/v1/security/sso/discoverПроверить, настроен ли SSO для домена email
POST/api/v1/security/sso/login/{providerId}Начать вход через OIDC — перенаправление к корпоративному IdP

Вебхуки

МетодПутьОперация
GET/api/v1/webhooksСписок эндпоинтов вебхуков
POST/api/v1/webhooksСоздать эндпоинт вебхука
DELETE/api/v1/webhooks/{id}Удалить эндпоинт вебхука
GET/api/v1/webhooks/{id}Получить эндпоинт вебхука
PATCH/api/v1/webhooks/{id}Обновить эндпоинт вебхука
GET/api/v1/webhooks/{id}/deliveriesСписок попыток доставки
POST/api/v1/webhooks/{id}/rotate-secretСгенерировать новый секрет вебхука

Ключи JWKS

МетодПутьОперация
GET/.well-known/jwks.jsonПубличные ключи (JWKS) для токенов доступа и обновления — активный и предыдущий
GET/.well-known/witness-jwks.jsonПубличные ключи (JWKS) для witness-токенов (RFC 9068, RFC 9396)

Контроль доступа

МетодПутьОперация
GET/api/v1/security/access-rulesСписок правил доступа
POST/api/v1/security/access-rulesСоздать правило доступа
GET/api/v1/security/access-rules/checkПроверка доступа текущего пользователя
GET/api/v1/security/access-rules/resource/{resourceType}/{resourceId}Правила для конкретного ресурса
DELETE/api/v1/security/access-rules/{id}Удалить правило доступа
PATCH/api/v1/security/access-rules/{id}Обновить правило доступа
POST/api/v1/security/access/check-modulesПакетная проверка доступа к модулям
PUT/api/v1/security/access/groups/{groupId}/modules/{module}Задать группе уровень доступа к разделу
GET/api/v1/security/access/modulesУровни доступа текущего пользователя к разделам

Агенты

МетодПутьОперация
GET/api/v1/security/agentsАгенты команды
POST/api/v1/security/agentsСоздать агента
DELETE/api/v1/security/agents/{agentId}Удалить агента
GET/api/v1/security/agents/{agentId}Агент
PATCH/api/v1/security/agents/{agentId}Изменить агента
POST/api/v1/security/agents/{agentId}/defaultСделать агента основным
POST/api/v1/security/agents/{agentId}/resumeВозобновить работу агента
POST/api/v1/security/agents/{agentId}/suspendПриостановить агента
GET/api/v1/security/agents/{agentId}/versionsИстория версий агента
POST/api/v1/security/agents/{agentId}/versions/{version}/restoreВернуть версию агента

Доступ к агентам

МетодПутьОперация
GET/api/v1/security/agents/{agentId}/accessКому открыт доступ к агенту
GET/api/v1/security/agents/{agentId}/access/meПрава текущего пользователя на агента
DELETE/api/v1/security/agents/{agentId}/access/{subjectType}/{subjectId}Закрыть доступ к агенту
PUT/api/v1/security/agents/{agentId}/access/{subjectType}/{subjectId}Открыть доступ к агенту или изменить роль

Лимиты агентов

МетодПутьОперация
GET/api/v1/security/agent-limits/meМой расход и лимит агента
POST/api/v1/security/agent-limits/me/raiseПопросить администраторов увеличить лимит
GET/api/v1/security/agent-limits/teamРасход и лимиты агентов команды
PUT/api/v1/security/agent-limits/team/defaultЗадать лимит на сотрудника по умолчанию
DELETE/api/v1/security/agent-limits/team/groups/{groupId}Вернуть группе лимит команды
PUT/api/v1/security/agent-limits/team/groups/{groupId}Задать лимит на каждого участника группы
DELETE/api/v1/security/agent-limits/team/members/{userId}Вернуть сотруднику лимит по умолчанию
PUT/api/v1/security/agent-limits/team/members/{userId}Задать сотруднику личный лимит

Аудит безопасности

МетодПутьОперация
POST/api/v1/security/audit/documents/verifyПроверить целостность аудита документов команды (только владелец)
GET/api/v1/security/audit/meСобытия безопасности текущего пользователя
GET/api/v1/security/audit/teamСобытия безопасности команды (только владелец)
POST/api/v1/security/audit/verifyПроверить целостность цепочки хешей (только владелец)

Защита от ботов

МетодПутьОперация
GET/api/v1/security/altcha/challengeВыдать задачу защиты от ботов (proof-of-work)

Поддержка

МетодПутьОперация
POST/api/v1/security/support/contactОтправить обращение в поддержку

POSTАутентификация Telegram WebApp по initData и выдача токенов

Назад

Аутентификация

Регистрация, вход, восстановление пароля, верификация e-mail.

На этой странице

ОперацииАутентификацияПользователиУстройства и сессииКомандыГруппыОргструктураПриглашенияOAuth 2.0OAuth-приложенияПерсональные токеныКаталог OAuth-scopesЕдиный вход (SSO)ВебхукиКлючи JWKSКонтроль доступаАгентыДоступ к агентамЛимиты агентовАудит безопасностиЗащита от ботовПоддержка