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

Поле UserSnapshot содержит данные, связанные с VPN пользователями в учетной записи. Когда вы выполняете запрос для всех пользователей в учетной записи (аргумент ID пуст), вызов API возвращает данные для пользователей, которые в настоящее время подключены к VPN и облаку Cato.

Если вы используете аргумент ID для выполнения запроса для определенных пользователей, вызов API возвращает данные для этих пользователей, даже если они не подключены к VPN.

Поля UserSnapshot

Поля UserSnapshot содержат данные для подключенных VPN пользователей и их подключения к облаку Cato. Используйте аргумент IDs для указания, какие VPN пользователи включены в запрос.

Это детали, которые поля UserSnapshot могут вернуть для запроса:

• id - ID пользователя VPN
• connectivityStatus - подключение к облаку Cato (массив с вложенными полями)
• operationalStatus - статус для Сайта или пользователя VPN (массив с вложенными полями)
• name - Имя пользователя VPN
• deviceName - имя компьютера или устройства
• uptime - как долго Клиент подключен к облаку Cato (в секундах)
• 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 с использованием Режима офиса
• metrics - показатели трафика в реальном времени (основанные на последних 30 секундах) и данные для Клиента (массив с вложенными полями)
• info - общая информация о пользователе VPN (массив с вложенными полями)
• recentConnections - данные, связанные с самыми последними завершенными подключениями VPN (массив с вложенными запросами и полями)

ID

Показывает уникальный внутренний ID пользователя VPN для учетной записи. Это значение не отображается в Приложении Управления Cato.

connectivityStatus

Поле Пользователи > connectivityStatus показывает подключение для пользователя VPN:

• Подключен к облаку Cato
• Отключен от облака Cato

operationalStatus

Поле Пользователи > operationalStatus показывает статус пользователя VPN:

• активный - передача трафика
• отключен - отключен в Приложении Управления Cato
• заблокирован - учетная запись для данного пользователя VPN заблокирована
• новый - не имеет отношения к пользователям VPN
• pending_user_configuration - ожидание подтверждения учетной записи пользователем VPN
• pending_mfa_configuration - ожидание конфигурации настроек MFA пользователем VPN
• pending_code_generation - ожидание ввода кода регистрации пользователем VPN

Имя

Поле Имя показывает Имя пользователя VPN в Приложении Управления Cato.

DeviceName

Поле deviceName показывает имя компьютера или устройства, подключенного к облаку Cato.

uptime

Поле uptime показывает общее количество времени в секундах, пока пользователь VPN подключен к облаку Cato.

lastConnected

Для пользователя VPN, который не подключен к облаку Cato, поле lastConnected показывает временную метку времени последнего подключения Клиента к облаку Cato.

Версия

Поле Версия показывает Версию Клиента в виде типа STRING.

versionNumber

Поле 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 - уникальный внутренний ID Cato для устройства
• 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, к которому подключен Клиент
• metrics - метрики и данные трафика в реальном времени для Socket (массив с вложенными запросами и полями)

  Для получения дополнительной информации о полях Metrics для DeviceSnapshot смотрите Cato API - Снимок учетной записи > Площадки > Устройства > Интерфейсы.

• 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 является булевым значением, и когда оно истина, оно показывает, что Клиент подключен к сети с использованием режима Office.

Метрики

Поля Пользователи > Метрики показывают аналитику трафика в реальном времени для Клиента. Это данные, которые вы можете увидеть:

• длительность - общее время для данных Клиента
• детализация - длительность в секундах для одиночного бакета метрик
• байтыПоисходящему - общий входящий трафик (от Cato Cloud к Клиенту)
• байтыВосходящему - общий исходящий трафик (от Клиента к Cato Cloud)
• байтыВсего - общий трафик для Клиента
• потеряноПоисходящему - количество потерянных пакетов для входящего трафика
• потеряноПоисходящемуПроц - процент потерянных пакетов для входящего трафика
• потеряноВосходящему - количество потерянных пакетов для исходящего трафика
• потеряноВосходящемуПроц - процент потерянных пакетов для исходящего трафика
• пакетыПоисходящему - всего входящих пакетов
• пакетыВосходящему - всего исходящих пакетов
• джиттерВосходящему - джиттер для исходящего трафика (разница в задержке в миллисекундах (мс) между пакетами данных)
• джиттерПоисходящему - джиттер для входящего трафика (разница в задержке в миллисекундах (мс) между пакетами данных)
• пакетыОтброшенныеПоисходящему - всего отброшенных пакетов для входящего трафика
• пакетыОтброшенныеВосходящему - всего отброшенных пакетов для исходящего трафика
• rtt - время возвращения из Клиента в Cato Cloud

Информация

Поля UserInfo показывают основную информацию о пользователе VPN, в краткой форме. Это подробности для полей:

• имя - Имя пользователя VPN
• статус - статус Клиента как типа STRING
• электронная почта - Адрес электронной почты пользователя VPN
• время создания - метка времени, когда пользователь VPN был создан в учетной записи
• номер телефона - номер телефона пользователя VPN
• источник - показывает, как пользователь VPN был добавлен в учетную запись:
  • обычный - добавлен вручную в Приложение управления Cato
  • LDAP - добавлен с синхронизацией LDAP
• метод аутентификации - Настройки многофакторной аутентификации (MFA) для этого пользователя VPN:
  • Нет - пользователю VPN не требуется MFA для аутентификации в Клиенте
  • MFA - пользователю VPN требуется MFA для аутентификации в Клиенте

НедавниеСоединения

Поле Пользователи > НедавниеСоединения показывает данные, связанные с самыми последними соединениями Клиента с Cato Cloud. Это детали, которые это поле может вернуть для запроса:

• длительность - общее время для данных запроса
• имя интерфейса - Имя порта в Приложении управления Cato
• имя устройства - Имя устройства, на котором установлен Клиент
• последнееПодключение - Показывает метку времени, когда Клиент инициировал соединение с Cato Cloud
• popID - ID PoP, к которому Клиент был подключен
• popName - Имя PoP, к которому был подключен Клиент
• удаленныйIP - IP-адрес Клиента
• remoteIPInfo - IP-адрес, интернет-провайдер и географическая информация, связанные с PoP, к которому был подключен поток трафика

Снимок > Аргументы ID Пользователей

Введите ID пользователей VPN для данных, которые возвращает запрос. Когда этот аргумент пуст, запрос возвращает всех пользователей VPN, подключенных к Cato Cloud.