Unified Identity Management logo figure Unified Identity Management logo figure

Справочник событий аудита

Типы событий

Аутентификация и логаут

Событие Описание

sso.auth.success

Попытки аутентификации пользователей в UIDM, которые завершились успешно

sso.auth.fail

Неуспешные попытки аутентификации пользователей в UIDM

sso.auth.revoke

Принудительное завершение сессии

sso.auth.logout

Протоколируются факты инвалидации сессии у пользователя

sso.auth.auto.fail

Неуспешный автовход

sso.auth.autologin.token.created

Успешный автовход

sso.auth.token.lifetime.end

Завершение сессии по таймауту

sso.auth.increase.success

Успешное повышение уровня сессии

sso.auth.increase.fail

Неуспешная попытка повышения уровня сессии

sso.api.session.delete.success

Удаление сессии через API управления сессиями (/sessionlist) или АРМ Контакт-Центра

sso.api.session.delete.fail

Неуспешное удаление сессии через API управления сессиями (/sessionlist) или АРМ Контакт-Центра

sso.auth.preauth.success

Попытки аутентификации пользователей по паре логин-пароль в UIDM, которые завершились успешно (но при этом сам процесс продолжается, например следующим шагом будет ввод ОТП кода).

Access token еще не выдан, так что это событие можно использовать только для предварительных действий, вроде прогрева кеша бизнес-данных.

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

Событие Описание

sso.auth.get_access_token.success

Протоколируются факты выдачи токена доступа (access token) системой UIDM

sso.auth.get_access_token.fail

Протоколируются неуспешные попытки выдачи токена доступа (access token) системой UIDM

sso.token_exchange.success

Успешная выдача нового токена доступа путем обмена согласно спецификации (oauth token exchange)

sso.refresh.success

Успешная выдача нового токена доступа путем обновления старого (oauth refresh token flow)

sso.auth.token_introspection.success

Успешная интроспекция токена (tokeninfo)

sso.auth.token_introspection.fail

Неуспешная интроспекция токена (tokeninfo)

API-токены

Событие Описание

sso.apitokens.creation.success

Успешный выпуск API-токена пользователем

sso.apitokens.revocation.success

Успешный отзыв API-токена пользователем

sso.auth.protected.resource.success_access

См. ниже

При доступе по API-токену в стандартном событии sso.auth.protected.resource.success_access будет указан authType = apitokens

Авторизация действий

Событие Описание

sso.auth.protected.resource.success_access

Протоколируются факты доступа к ресурсам, защищенным системой WebSSO, которые были разрешены. Достоверность регистрации событий зависит от корректности работы защищаемого сервиса.

sso.auth.protected.resource.fail_access

Протоколируются факты доступа к ресурсам, защищенным системой WebSSO, которые были запрещены. Достоверность регистрации событий зависит от корректности работы защищаемого сервиса.

sso.auth.otp_code.success

Протоколируются события успешного ввода OTP-кода

sso.auth.otp_code.fail

Протоколируются события неуспешного ввода OTP-кода

Соцсети - управление привязками

Событие Описание

webapi.social.mapping.create.success

Успешное создание привязки

webapi.social.mapping.create.fail

Неуспешное создание привязки

webapi.social.mapping.delete.success

Успешное удаление привязки

webapi.social.mapping.delete.fail

Неуспешное удаление привязки

Мультиаккаунты - управление привязками

Событие Описание

webapi.multiaccount.mapping.create.success

Успешное создание привязки

webapi.multiaccount.mapping.create.fail

Неуспешное создание привязки

webapi.multiaccount.mapping.delete.success

Успешное удаление привязки

webapi.multiaccount.mapping.delete.fail

Неуспешное удаление привязки

Блокировка и разблокировка

Событие Описание

sso.principal.lock.success

Блокировка пользователя

sso.principal.unlock.success

Разблокировка пользователя

Смена данных пользователей

Событие Описание

webapi.customer.credential.login.change.success

Успешная смена логина (через Customer WebAPI)

webapi.customer.credential.login.change.fail

Неуспешная смена логина (через Customer WebAPI)

webapi.customer.credential.password.change.success

Успешная смена пароля (через Customer WebAPI)

sso.credentials_change.success

Успешная смена пароля (через WebSSO)

webapi.customer.credential.password.change.fail

Неуспешная смена пароля (через Customer WebAPI)

sso.credentials_change.fail

Неуспешная смена пароля (через WebSSO)

sso.credentials_change.blocked

Блокировка возможности смены пароля в результате множественных вводов неверного старого пароля.

webapi.customer.settings.set.success

Успешная установка пользовательских настроек через Customer WebAPI /customers/{principalId}/settings/view (таблица PrincipalProperty)

webapi.customer.settings.set.fail

Неуспешная установка пользовательских настроек через Customer WebAPI /customers/{principalId}/settings/view (таблица PrincipalProperty)

sso.auth.credential.%s.change.success

Успешная смена контактных данных (email, phone)

sso.auth.credential.%s.change.fail

Неуспешная смена контактных данных (email, phone)

sso.auth.credential.%s.change.verified

TODO: уточнить

sso.restore_password_request.success

Успешный запрос на восстановление пароля

sso.restore_password_request.fail

Неуспешный запрос на восстановление пароля

sso.settings.event-notifier.put

Смена настроек уведомлений пользователей (в какие каналы какие типы событий)

sso.settings.event-notifier.delete

Удаление настроек уведомлений пользователей (сброс на дефолтное значение)

sso.settings.login-by-otp.put

Смена настроек 2 фактора (вкл, выкл)

sso.totp.add-key

Добавление настроек 2 фактора TOTP

sso.totp.remove-key

Удаление настроек 2 фактора TOTP

sso.principal.roles_update.success

Изменение ролей принципала

Модель данных события

Поле Описание Пример (аутентификация)

id

Идентификатор данной записи в БД аудита.

sso_6bb72c60-cb98-4faf-a4ef-b1581c841b4b

digest

Подпись лог-события

Не используется

ipAddress

IP адрес в виде числа.

3257718304

msisdn

Номер телефона пользователя на момент возникновения события (LEGACY поле, не использовать в новых интеграциях)

77123456789

name

Название данного события в БД аудита. В данном примере - sso.auth.success - успешная аутентификация.

sso.auth.success

principalId

Уникальный идентификатор пользователя. Жизненный цикл учетных записей должен исключать присваивание одного и то же идентификатора разным пользователям.

sso_99f016d5-03a1-4185-8bd0-412d8da53492

timeEnd

Дата и время окончания данного события.

12.07.2017 0:12:29

timeStart

Дата и время начала данного события (сейчас для всех событий время начала совпадает с временем окончания)

12.07.2017 0:12:29

forwardedIpAddresses

Цепочка запроксированных IP-адресов клиента. Работает в случае корректной настройки имени заголовка и всех обратных прокси по пути запроса.

geoIPCountry

Названия географических субъектов, определенные на основании IP-адреса пользователя. Заполняется при получении сервером в запросе корректного IP-адреса пользователя и интеграции с базой данных GeoIP

RU

geoIPRegionId

Названия географических субъектов, определенные на основании IP-адреса пользователя. Заполняется при получении сервером в запросе корректного IP-адреса пользователя и интеграции с базой данных GeoIP

1025

geoIPRegionNameNat

Названия географических субъектов, определенные на основании IP-адреса пользователя. Заполняется при получении сервером в запросе корректного IP-адреса пользователя и интеграции с базой данных GeoIP

Московская область

accessToken

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

clientId

Идентификатор приложения - например, личный кабинет, мобильный личный кабинет и т.д., в котором произошло данное событие. Применимо не для всех событий.

portal

userAgent

Информация о UserAgent, полученная от браузера пользвоателя. Обычно содержит данные об устройстве, ОС и браузере. В данном примере - в качестве User Agent выступала система автотестов.

roox-autotests

nodeId

Имя конкретного сервера UIDM, на котором произошло событие

aws-eu01-node03

correlationId

Идентификатор для сопоставления события с информацией в лог-файлах решения.

1SFOP26MNIN6KU

authType

"Способ аутентификации пользователя (автовход, логин-пароль, соц.сети и т.д.). Возможные значения:

login_password - вход по логину-паролю login-by-jwt - вход по identity-токену (jwt) apitokens - использование api token для вызова операции lite-principal-auth - вход по "легкой" учетке mpt - single-sign-on srp6a - вход по логину-паролю с использованием протокола srp6a

login_password

service

Название сценария UIDM, при работе которого возникло данное событие

dispatcher

url

Запрошенный ресурс, над которым выполняется действие - используется для событий доступа к ресурсу, если в решении используется централизованная авторизация (политики)

httpMethod

Запрошенный метод для ресурса - используется для событий доступа к ресурсу, если в решении используется централизованная авторизация (политики)

requestAuthLevel

LEGACY

gotoUrl

https://uidm.example.com

oauthCode

Выданный OAUTH2 Code в случае использования code flow при аутентификации

geoIPDatabase

Данные об используемой базе geoIP

geoipbase

geoIPDatabaseVersion

Данные об используемой базе geoIP

default_2016-04-20

ipAddressString

IP адрес в виде строки.

194.44.214.32

geoIPCityId

Названия географических субъектов, определенные на основании IP-адреса пользователя. Заполняется при получении сервером в запросе корректного IP-адреса пользователя и интеграции с базой данных GeoIP

223

geoIPCityNameNat

Названия географических субъектов, определенные на основании IP-адреса пользователя. Заполняется при получении сервером в запросе корректного IP-адреса пользователя и интеграции с базой данных GeoIP

Москва

referer

Заголовок Referer, если событие произошло в вебе

networkType

LEGACY

data

"Дополнительная информация о событии в формате ключ-значение. Содержимое зависит от события и настроек.

Поле может содержать claims токена, для этого требуется конфигурация. Что такое claims https://uidm.ru/docs/site/generic/develop/concepts.html#_%D0%BA%D0%BB%D0%B5%D0%B9%D0%BC%D1%8B_claims

Также в поле могут попадать произвольные дополнительные данные от вызывающей стороны (веб-клиента или мобильного приложения), такие как версия приложения, MAC-адрес устройства, статус рутованности и так далее. Требуется конфигурация разрешенных полей.

<data></data>

imsi

IMSI пользователя, для которого произошло событие. Берётся из профиля пользователя UIDM, если было передано от внешней системы при создании профиля

iccid

ICCID пользователя, для которого произошло событие. Берётся из профиля пользователя UIDM, если было передано от внешней системы при создании профиля

imei

IMEI пользователя, для которого произошло событие. Берётся из профиля пользователя UIDM, если было передано от внешней системы при создании профиля

userAgentDeviceType

Информация об устройстве, OS и браузера. Формируется при интеграции с внешним справочником устройств на основании параметра UserAgent.

Desktop

userAgentDeviceBrand

Информация об устройстве, OS и браузера. Формируется при интеграции с внешним справочником устройств на основании параметра UserAgent.

Unknown

userAgentDeviceModel

Информация об устройстве, OS и браузера. Формируется при интеграции с внешним справочником устройств на основании параметра UserAgent.

Unknown Unknown

userAgentOSFamily

Информация об устройстве, OS и браузера. Формируется при интеграции с внешним справочником устройств на основании параметра UserAgent. Для OCB может формироваться из переданной информации в блоке device_info (будет использовано поле device_os) в теле запроса.

Unknown Unknown

userAgentOSNameVersion

Информация об устройстве, OS и браузера. Формируется при интеграции с внешним справочником устройств на основании параметра UserAgent. Для OCB может формироваться из переданной информации в блоке device_info (будет использовано поле device_os_version) в теле запроса.

Unknown Unknown Unknown

userAgentBrowserType

Информация об устройстве, OS и браузера. Формируется при интеграции с внешним справочником устройств на основании параметра UserAgent.

browser

userAgentBrowserFamily

Информация об устройстве, OS и браузера. Формируется при интеграции с внешним справочником устройств на основании параметра UserAgent.

Unknown Unknown

userAgentBrowserNameVersion

Информация об устройстве, OS и браузера. Формируется при интеграции с внешним справочником устройств на основании параметра UserAgent. Для OCB может формироваться из переданной информации в блоке device_info (будет использовано поле app_version) в теле запроса.

Unknown Unknown Unknown

clientGroupId

группа приложений-клиентов UIDM, если у приложений настроена привязка к группам

LK

imeiDeviceBrand

LEGACY

imeiDeviceModel

LEGACY

imeiDeviceType

LEGACY

authEndpointType

LEGACY

oauth2

authLevel

уровень авторизации, вычисленный в ходе данного события аутентификации

5

requestedScopes

перечень запрошенных клиентом скоупов

authorizedScopes

перечень выданных клиенту скоупов

httpHeaders

HTTP Заголовки, полученные UIDM при вызове данной операции

{"host":["uidm.example.com"],"accept-encoding":["gzip, deflate"],"accept":["application/json"],"user-agent":["roox-autotests"],"content-type":["application/x-www-form-urlencoded"],"cookie":["RX_SID=DDC5F7400F26AFBDD999A6902468E55C; gotoOnFail=uidm.example.com/sso/oauth2/authorize?response_type=code&redirect_uri=uidm.example.com; lb=wms"],"content-length":["4328"],"connection":["close"],"x-forwarded-proto":["https"]}

error

Тип ошибки (для событий fail).

errorSubtype

Дополнительная информация для данного типа ошибки (для событий fail)

executionId

Уникальный идентификатор сценария. Позволяет связать в БД аудита несколько событий, которые происходили в рамках одного пользовательского сценария. Доступно не для всех событий.

a01725f6-60dd-46b2-b654-40aa4dae9c42

impersonator

Для событий входа от имени абонента содержит информацию о том, кто выполнил такой вход.