Описание структур данных API аудита системы

Содержание

1. Типы событий
   • WorkspaceCreated
   • WorkspaceMemberInvited
   • WorkspaceMemberJoined
   • ChatMemberJoined
   • WorkspaceMemberRoleChanged
   • ChatMessageSent
   • CallStarted
   • AnonymousCallStarted
   • RegistrationEvent
   • LoginAttemptEvent
   • SharedLinkEvent
   • DashboardLoginAttemptEvent
   • DashboardUserSystemAdminRoleChangedEvent
   • DashboardUserOrgAdminRoleChangedEvent
2. Вспомогательные структуры
   • ConferenceTarget
   • SharedLinkInfo

---

Типы событий

WorkspaceCreated

Событие создания workspace.

Пример:

{
   "type": "WorkspaceCreated", // Тип события
   "timestamp": "2023-05-15T10:00:00Z", // Временная метка
   "sessionId": "2qLBHvJwX3G", // Идентификатор сессии создателя
   "ip": "192.168.1.1", // IP-адрес создания
   "workspaceId": "3aKp9RmVbN2", // Идентификатор workspace
   "creatorId": "5tFgY7hUjK1" // Идентификатор создателя
}

WorkspaceMemberInvited

Событие приглашения участника в workspace.

Пример:

{
   "type": "WorkspaceMemberInvited" // Тип события,
   "timestamp": "2023-05-15T10:05:00Z" // Временная метка,
   "sessionId": "2qLBHvJwX3G", // Идентификатор сессии приглашающего
   "ip": "192.168.1.1" // IP-адрес,
   "workspaceId": "3aKp9RmVbN2" // Идентификатор workspace,
   "inviterId": "5tFgY7hUjK1", // Идентификатор приглашающего
   "invitedEmails": ["3aKp9RmVbN2", "3aKp9RmVbN2"], // Email приглашенных
   "role": "MEMBER" // Роль приглашенных
}

WorkspaceMemberJoined

Событие присоединения участника к workspace.

Пример:

{
   "type": "WorkspaceMemberJoined" // Тип события,
   "timestamp": "2023-05-15T10:10:00Z" // Временная метка,
   "sessionId": "7yNcDpQrS4T", // Идентификатор сессии присоединившегося
   "ip": "192.168.1.2" // IP-адрес,
   "workspaceId": "3aKp9RmVbN2" // Идентификатор workspace,
   "accountId": "8uHbKjMlP9Z", // Идентификатор участника
   "role": "MEMBER" // Роль участника
}

ChatMemberJoined

Событие добавления участника в чат.

Пример:

{
   "type": "ChatMemberJoined" // Тип события,
   "timestamp": "2023-05-15T10:15:00Z" // Временная метка,
   "sessionId": "2qLBHvJwX3G", // Идентификатор сессии инициатора
   "ip": "192.168.1.1" // IP-адрес,
   "workspaceId": "3aKp9RmVbN2" // Идентификатор workspace,
   "chatId": "3aKp9RmVbN2", // Идентификатор чата
   "inviterId": "5tFgY7hUjK1", // Идентификатор приглашающего
   "invitees": ["8uHbKjMlP9Z", "9vIcLkNoQ0X"], // Идентификаторы добавленных
   "role": "MEMBER" // Роль в чате
}

WorkspaceMemberRoleChanged

Событие изменения роли участника workspace.

Пример:

{
   "type": "WorkspaceMemberRoleChanged" // Тип события,
   "timestamp": "2023-05-15T10:20:00Z" // Временная метка,
   "sessionId": "2qLBHvJwX3G", // Идентификатор сессии инициатора
   "ip": "192.168.1.1" // IP-адрес,
   "workspaceId": "3aKp9RmVbN2" // Идентификатор workspace,
   "initiator": "5tFgY7hUjK1", // Идентификатор инициатора
   "changed": "8uHbKjMlP9Z", // Идентификатор участника
   "newRole": "ADMIN" // Новая роль
}

ChatMessageSent

Событие отправки сообщения в чат.

Пример:

{
   "type": "ChatMessageSent" // Тип события,
   "timestamp": "2023-05-15T10:25:00Z" // Временная метка,
   "workspaceId": "3aKp9RmVbN2" // Идентификатор workspace,
   "chatId": "3aKp9RmVbN2" // Идентификатор чата,
   "authorId": "5tFgY7hUjK1" // Идентификатор автора
}

CallStarted

Событие начала звонка.

Пример:

{
   "type": "CallStarted" // Тип события,
   "timestamp": "2023-05-15T10:30:00Z" // Временная метка,
   "workspaceId": "3aKp9RmVbN2" // Идентификатор workspace,
   "initiatorId": "5tFgY7hUjK1", // Идентификатор инициатора
   "target": {
      "type": "ConferenceTargetChat" // Тип события,
      "chatId": "3aKp9RmVbN2" // Идентификатор чата
   }
}

AnonymousCallStarted

Событие начала анонимного звонка.

Пример:

{
   "type": "AnonymousCallStarted" // Тип события,
   "timestamp": "2023-05-15T10:35:00Z" // Временная метка,
   "workspaceId": "3aKp9RmVbN2" // Идентификатор workspace,
   "recipientId": "8uHbKjMlP9Z", // Идентификатор получателя
   "target": {
      "type": "ConferenceTargetWatercooler" // Тип события,
      "scope": "PUBLIC", // Область видимости
      "participantIds": ["3aKp9RmVbN2", "3aKp9RmVbN2"], // Участники
      "initiator": "3aKp9RmVbN2", // Инициатор
      "chatId": "3aKp9RmVbN2" // Идентификатор чата
   }
}

RegistrationEvent

Событие регистрации пользователя.

Пример:

{
   "type": "RegistrationEvent" // Тип события,
   "timestamp": "2023-05-15T10:40:00Z" // Временная метка,
   "accountId": "9vIcLkNoQ0X", // Идентификатор пользователя
   "sessionAppKind": "WEB", // Тип клиента
   "eventType": "MAGIC_LINK", // Метод аутентификации
   "sessionId": "1aMbNcOdPeQ", // Идентификатор сессии
   "ip": "192.168.1.3" // IP-адрес
}

LoginAttemptEvent

Событие попытки входа.

Пример:

{
   "type": "LoginAttemptEvent" // Тип события,
   "timestamp": "2023-05-15T10:45:00Z" // Временная метка,
   "contact": "user@example.com", // Email или идентификатор
   "sessionId": "2bNcOdPeQfR", // Идентификатор сессии
   "authMethod": "PASSWORD", // Метод аутентификации
   "ip": "192.168.1.4", // IP-адрес
   "result": false, // Результат (успех/неудача)
   "errorMessage": "Invalid password" // Сообщение об ошибке
}

SharedLinkEvent

Событие работы с shared link.

Пример:

{
   "type": "SharedLinkEvent" // Тип события,
   "timestamp": "2023-05-15T10:50:00Z" // Временная метка,
   "accountId": "5tFgY7hUjK1", // Идентификатор пользователя
   "sessionId": "3cOdPeQfRgS", // Идентификатор сессии
   "ip": "192.168.1.5", // IP-адрес
   "sharedLinkId": "4dPeQfRgShT", // Идентификатор ссылки
   "info": { // Информация о ссылке
      "type": "WorkspaceInvite" // Тип события,
      "workspaceId": "3aKp9RmVbN2", // Идентификатор workspace
      "creator": "5tFgY7hUjK1", // Создатель
      "expiration": "2023-06-15T10:50:00Z" // Срок действия
   },
   "operation": "CREATE" // Тип операции
}

DashboardLoginAttemptEvent

Событие попытки входа в админку.

Пример:

{
   "type": "DashboardLoginAttemptEvent" // Тип события,
   "timestamp": "2023-05-15T10:55:00Z" // Временная метка,
   "contact": "admin@example.com", // Email или идентификатор
   "ip": "192.168.1.6", // IP-адрес
   "result": true, // Результат
   "errorMessage": null // Сообщение об ошибке
}

DashboardUserSystemAdminRoleChangedEvent

Событие изменения роли системного администратора.

Пример:

{
   "type": "DashboardUserSystemAdminRoleChangedEvent" // Тип события,
   "timestamp": "2023-05-15T11:00:00Z" // Временная метка,
   "ip": "192.168.1.7", // IP-адрес
   "initiator": "5tFgY7hUjK1", // Инициатор
   "changed": "8uHbKjMlP9Z", // Участник
   "changeType": "GRANT" // Тип изменения (назначение)
}

DashboardUserOrgAdminRoleChangedEvent

Событие изменения роли администратора организации.

Пример:

{
   "type": "DashboardUserOrgAdminRoleChangedEvent" // Тип события,
   "timestamp": "2023-05-15T11:05:00Z" // Временная метка,
   "ip": "192.168.1.8", // IP-адрес
   "initiator": "5tFgY7hUjK1", // Инициатор
   "changed": "9vIcLkNoQ0X", // Участник
   "organizationId": "6uGxZ8iWaV3", // Идентификатор организации
   "changeType": "REVOKE" // Тип изменения (отзыв)
}

Вспомогательные структуры

ConferenceTarget

Базовый тип для цели конференции.

Примеры:

{
   "type": "ConferenceTargetChat", // Тип цели (чат)
   "chatId": "5tFgY7hUjK1" // Идентификатор чата
}

{
   "type": "ConferenceTargetWatercooler", // Тип цели (watercooler)
   "scope": "PUBLIC", // Область видимости
   "participantIds": ["3aKp9RmVbN2", "3aKp9RmVbN2"], // Участники
   "initiator": "5tFgY7hUjK1", // Инициатор
   "chatId": "5tFgY7hUjK1" // Идентификатор чата
}

SharedLinkInfo

Базовый тип для информации о shared link.

Примеры:

{
   "type": "WorkspaceInvite", // Тип ссылки
   "workspaceId": "3aKp9RmVbN2", // Идентификатор workspace
   "creator": "5tFgY7hUjK1", // Создатель
   "expiration": "2023-06-15T10:50:00Z" // Срок действия
}

{
   "type": "FileSharing" // Тип события,
   "workspaceId": "3aKp9RmVbN2" // Идентификатор workspace,
   "fileId": "7yVcXwLzP2K" // Идентификатор файла
}