AccountSnapshot > Пользователи
Поле UserSnapshot содержит данные, связанные с пользователями VPN в учетной записи. Когда вы выполняете запрос для всех пользователей в учетной записи (аргумент ID пуст), вызов API возвращает данные для пользователей, которые в настоящее время подключены к VPN и Cato Cloud.
Если вы используете аргумент ID для выполнения запроса для конкретных пользователей, вызов API возвращает данные для этих пользователей, даже если они не подключены к VPN.
Поля UserSnapshot
Поля UserSnapshot содержат данные о подключенных пользователях VPN и их соединениях с Cato Cloud. Используйте аргумент IDs, чтобы указать, какие пользователи VPN включены в запрос.
Вот детали, которые поля UserSnapshot могут вернуть для запроса:
id - ID пользователя VPN
connectivityStatus - подключение к Cato Cloud (массив с вложенными полями)
operationalStatus - статус для сайта или пользователя VPN (массив с вложенными полями)
name - имя пользователя VPN
deviceName - имя компьютера или устройства
uptime - время, в течение которого Клиент был подключен к Cato Cloud (в секундах)
lastConnected - метка времени последнего подключения пользователя VPN к PoP
version - версия программного обеспечения Клиента (строка)
versionNumber - версия программного обеспечения Клиента (INT)
popID - ID PoP, к которому подключен Клиент
popName - имя PoP, к которому подключен пользователь VPN
RemoteIP - IP-адрес Клиента
RemoteIPInfo - IP-адрес, ISP и географическая информация, связанная с Клиентом
internalIP - IP-адрес PoP, к которому подключен Клиент
osType - операционная система устройства, на котором работает Клиент
osVersion - версия операционной системы устройства
devices - данные, связанные с Клиентом (массив с вложенными полями)
connectedInOffice - показывает, подключен ли Клиент к VPN, используя режим Office
info - общая информация о пользователе VPN (массив с вложенными полями)
recentConnections - данные, связанные с последними завершенными подключениями VPN (массив с вложенными запросами и полями)
ID
Показывает уникальный внутренний ID пользователя VPN для учетной записи, это значение не отображается в Приложении Управления Cato.
connectivityStatus
Поле Пользователи > connectivityStatus показывает подключение для пользователя VPN:
подключен к Cato Cloud
отключен от Cato Cloud
operationalStatus
Поле Пользователи > operationalStatus показывает статус пользователя VPN:
active - пропускает трафик
disabled - отключен в Приложении Управления Cato
locked - учетная запись этого пользователя VPN заблокирована
new - неактуально для пользователей VPN
pending_user_configuration - ожидание подтверждения учетной записи пользователем VPN
pending_mfa_configuration - ожидание настройки MFA пользователем VPN
pending_code_generation - ожидание ввода регистрационного кода пользователем VPN
Имя
Поле Имя показывает имя пользователя VPN в Приложении Управления Cato.
Имя устройства
Поле deviceName показывает имя компьютера или устройства, подключенного к Cato Cloud.
uptime
Поле uptime показывает общее время в секундах, в течение которого пользователь VPN подключен к Cato Cloud.
Последнее подключение
Для пользователя VPN, который не подключен к Cato Cloud, поле lastConnected показывает метку времени последнего подключения Клиента к Cato Cloud.
Версия
Поле version показывает версию Клиента как тип STRING.
Номер версии
Поле versionNumber показывает версию Клиента как тип INT.
PopID
Поле Пользователи > PoPID показывает ID PoP, к которому подключен Клиент.
PopName
Поле Пользователи > PoPName показывает имя PoP, к которому подключен Клиент.
RemoteIP
Поле Пользователи > RemoteIP показывает IP-адрес Клиента.
RemoteIPInfo
Поле Пользователи > RemoteIPInfo показывает данные, связанные с IP-адресом, провайдером (ISP) и физическим местоположением PoP, к которому подключен Клиент. Это детали для полей:
ip - IP-адрес подключения WAN к PoP
countryCode - код для физического местоположения PoP (на основе геолокации IP-адреса)
countryName - страна, являющаяся физическим местоположением PoP (на основе геолокации IP-адреса)
city - город, где находится PoP (на основе геолокации IP-адреса)
state - область, где находится PoP (на основе геолокации IP-адреса)
provider - провайдер ISP для последней мили соединения между Cato Cloud и PoP
latitude - широта PoP (на основе геолокации IP-адреса)
longitude - долгота PoP (на основе геолокации IP-адреса)
InternalIP
Поле Пользователи > internalIP показывает IP-адрес PoP, к которому подключен Клиент.
osType
Поле osType показывает операционную систему устройства, на котором установлен Клиент.
osVersion
Поле osVersion показывает версию операционной системы устройства, на котором установлен Клиент.
Устройства
Поля Пользователи > DeviceSnapshot показывают метрики и данные устройства, которое подключено к Cato Cloud. Некоторые поля в DeviceSnapshot повторяются, чтобы предоставить вам большую гибкость с данными. Также одна и та же инфраструктура DeviceSnapshot используется для пользователей VPN и для площадок, и некоторые из полей актуальны только для пользователей или площадок.
Это данные, которые вы видите:
id - уникальный внутренний Cato ID для устройства
name - имя устройства
identifier - уникальный идентификатор для устройства
connected - логическое значение, указывающее, подключен ли Клиент к Cato Cloud
haRole - это поле используется в Снимок площадки > Площадка> Устройства
interfaces - показывает данные в реальном времени для Клиента (массив с вложенными запросами и полями)
Для получения дополнительной информации о полях Interfaces для DeviceSnapshot смотрите Cato API - Снимок учетной записи > Площадки > Устройства > Интерфейсы.
lastConnected - отметка времени, когда Клиент подключился к Cato Cloud
lastDuration - общее время, в течение которого Клиент был подключен к Cato Cloud
connectedSince - показывает отметку времени, сколько времени Клиент активно подключен к Cato Cloud
lastPopName - название PoP, к которому подключен Клиент
lastPopID - ID PoP, к которому подключен Клиент
recentConnections - данные о последних завершенных потоках трафика (массив с вложенными запросами и полями)
Для получения дополнительной информации о полях recentConnections для DeviceSnapshot смотрите Cato API - Снимок учетной записи > Площадки > Устройства.
type - показывает тип устройства
uptimeSeconds - показывает количество секунд, в течение которых этот Клиент активен
socketInfo - это поле используется в Снимок площадки > Площадка> Устройства
interfacesLinkState - это поле используется в Снимок площадки > Площадка> Устройства
osType - операционная система устройства, на котором работает Клиент
osVersion - версия операционной системы устройства
version - версия программного обеспечения Клиента, например 4.4.1234 (строка)
versionNumber - основная версия программного обеспечения Клиента, например 4 (INT)
releaseGroup - показывает статус выпуска для Клиента, такой как GA или EA
mfaExpirationTime - Показывает количество времени, оставшегося до истечения срока действия токена MFA
connectedInOffice
Поле connectedInOffice имеет логическое значение, и когда оно true, это показывает, что Клиент подключен к сети с использованием Режим.
Информация
Поля UserInfo показывают базовую информацию о пользователе VPN в кратком подразделении. Это детали для полей:
name - имя пользователя VPN
status - статус Клиента как типа STRING
email - адрес электронной почты пользователя VPN
creationTime - отметка времени, когда пользователь VPN был создан в учетной записи
phoneNumber - номер телефона пользователя VPN
origin - показывает, как пользователь VPN был добавлен в учетную запись:
regular - добавлен вручную в Приложение Управления Cato
LDAP - добавлен с синхронизацией LDAP
authMethod - Настройки многофакторной аутентификации (MFA) для этого пользователя VPN:
None - пользователю VPN не требуется MFA для аутентификации в Клиенте
MFA - пользователю VPN требуется MFA для аутентификации в Клиенте
RecentConnections
Поле Пользователи > RecentConnections показывает данные, связанные с последними подключениями Клиента к Cato Cloud. Это детали, которые это поле может вернуть для запроса:
duration - общее время для данных запроса
interfaceName - Имя для порта в Приложении Управления Cato
deviceName - Имя устройства, на котором установлен Клиент
lastConnected - Показывает отметку времени, когда Клиент инициировал подключение к Cato Cloud
popID - ID PoP, к которому был подключен Клиент
popName - Имя PoP, к которому был подключен Клиент
remoteIP - IP-адрес Клиента
remoteIPInfo - IP-адрес, провайдер (ISP) и географическая информация, связанная с PoP, к которому был подключен поток трафика
Снимок > Аргументы ID пользователей
Введите ID пользователей VPN для данных, которые возвращает запрос. Когда этот аргумент пуст, запрос возвращает всех пользователей VPN, подключенных к Cato Cloud.