Back to Details

pachca-security

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

pachca-security

pachca-security

Base URL: 
https://api.pachca.com/api/shared/v1
Авторизация: 
Authorization: Bearer <ACCESS_TOKEN>
Токен: бот (Автоматизации → Интеграции → API) или пользователь (Автоматизации → API). Если токен неизвестен — спроси у пользователя перед выполнением запросов.
Base URL: 
https://api.pachca.com/api/shared/v1
授权：
Authorization: Bearer <ACCESS_TOKEN>
令牌：机器人（自动化 → 集成 → API）或用户（自动化 → API）。 如果未知令牌，请在执行请求前询问用户。

Когда использовать

适用场景

  • аудит
  • журнал событий
  • безопасность
  • DLP
  • логи
  • подозрительные входы
  • история входов
  • 审计
  • 事件日志
  • 安全
  • DLP
  • 日志
  • 可疑登录
  • 登录历史

Когда НЕ использовать

不适用场景

  • получить профиль, мой профиль, установить статус → pachca-profile
  • найти сотрудника, создать пользователя, список сотрудников → pachca-users
  • создать канал, создать беседу, создать чат → pachca-chats
  • отправить сообщение, ответить в тред, прикрепить файл → pachca-messages
  • настроить бота, вебхук, webhook → pachca-bots
  • показать форму, интерактивная форма, модальное окно → pachca-forms
  • создать задачу, список задач, напоминание → pachca-tasks
  • 获取个人资料、我的资料、设置状态 → pachca-profile
  • 查找员工、创建用户、员工列表 → pachca-users
  • 创建频道、创建对话、创建聊天 → pachca-chats
  • 发送消息、回复线程、附加文件 → pachca-messages
  • 配置机器人、webhook → pachca-bots
  • 显示表单、交互式表单、模态窗口 → pachca-forms
  • 创建任务、任务列表、提醒 → pachca-tasks

Пошаговые сценарии

分步场景

Получить журнал аудита событий

获取事件审计日志

  1. GET /audit_events с фильтрами (
    event_key
    , период, пагинация)
  2. Доступные типы событий: входы, изменения прав, действия с чатами и т.д.
bash
curl "https://api.pachca.com/api/shared/v1/audit_events?created_at[from]=$DATE_FROM&created_at[to]=$DATE_TO&limit=50" \
  -H "Authorization: Bearer $TOKEN"
Доступно только владельцу пространства.
  1. 使用过滤器（
    event_key
    、时间段、分页）发送GET /audit_events请求
  2. 支持的事件类型：登录、权限变更、聊天操作等
bash
curl "https://api.pachca.com/api/shared/v1/audit_events?created_at[from]=$DATE_FROM&created_at[to]=$DATE_TO&limit=50" \
  -H "Authorization: Bearer $TOKEN"
仅空间所有者可访问。

Мониторинг подозрительных входов

监控可疑登录

  1. GET /audit_events с фильтром 
    "event_key": "user_2fa_fail"
    (или 
    "user_signed_in"
    ) за нужный период
  2. Пагинируй с 
    cursor
    до получения всех записей
  3. Если найдены аномалии (много неудачных 2FA с одного аккаунта) — отправь уведомление администратору через POST /messages
Фильтрация по 
event_key
— строковое совпадение. Доступные ключи — в документации Аудит событий.
  1. 在指定时间段内，使用过滤器
    "event_key": "user_2fa_fail"
    （或
    "user_signed_in"
    ）发送GET /audit_events请求
  2. 使用
    cursor
    进行分页，直至获取所有记录
  3. 如果发现异常（同一账号多次2FA失败），通过POST /messages向管理员发送通知
按
event_key
过滤为精确字符串匹配。可用密钥请参考事件审计文档。

Экспорт логов за период

导出指定时间段的日志

  1. GET /audit_events с параметрами 
    created_at[from]
    и 
    created_at[to]
    (ISO 8601)
  2. Пагинируй с 
    cursor
    до получения всех записей (
    limit
    до 50)
  3. Собери все события в массив → сохрани в файл или отправь во внешнюю систему (SIEM, таблицы)
  1. 使用参数
    created_at[from]
    和
    created_at[to]
    （ISO 8601格式）发送GET /audit_events请求
  2. 使用
    cursor
    进行分页，直至获取所有记录（
    limit
    最大为50）
  3. 将所有事件整理为数组 → 保存到文件或发送至外部系统（SIEM、表格）

Обработка ошибок

错误处理

КодПричинаЧто делать
422Неверные параметрыПроверь обязательные поля, типы данных, допустимые значения enum
429Rate limitПодожди и повтори. Лимит: ~50 req/sec, сообщения ~4 req/sec
403Нет доступаНедостаточно скоупов (
insufficient_scope
), бот не в чате, или endpoint только для админов/владельцев
404Не найденоНеверный id. Проверь что сущность существует
401Не авторизованПроверь токен в заголовке Authorization
代码原因处理方式
422参数错误检查必填字段、数据类型、枚举的有效值
429请求频率限制等待后重试。限制：约50次请求/秒，消息约4次请求/秒
403无权限权限范围不足（
insufficient_scope
）、机器人不在聊天中，或该端点仅对管理员/所有者开放
404未找到ID错误。检查实体是否存在
401未授权检查Authorization头中的令牌

Доступные операции

可用操作

Журнал аудита событий

事件审计日志

GET /audit_events
скоуп: 
audit_events:read
· тариф: Корпорация
GET /audit_events
权限范围：
audit_events:read
· 套餐：企业版

Ограничения и gotchas

限制与注意事项

  • limit
    : максимум 50
  • Пагинация: cursor-based (limit + cursor), НЕ page-based
  • limit
    ：最大为50
  • 分页：基于cursor（limit + cursor），不支持基于page的分页

Подробнее

更多详情

см. references/endpoints.md
请查看 references/endpoints.md