Instantâneo da Conta > Usuários

O campo UserSnapshot contém dados relacionados aos usuários VPN na conta. Quando você executa uma consulta para todos os usuários na conta (o argumento ID está vazio), a chamada da API retorna dados para usuários que estão atualmente conectados ao VPN e à Cato Cloud.

Se você usar o argumento ID para executar uma consulta para usuários específicos, a chamada da API retorna dados para esses usuários, mesmo quando não estão conectados ao VPN.

Campos UserSnapshot

Os campos UserSnapshot contêm dados para usuários VPN conectados e suas conexões com a Cato Cloud. Use o argumento IDs para especificar quais usuários VPN estão incluídos na consulta.

Estes são os detalhes que os campos UserSnapshot podem retornar para a consulta:

id - ID do usuário VPN
connectivityStatus - conectividade com a Cato Cloud (array com campos aninhados)
operationalStatus - status para um Site ou usuário VPN (array com campos aninhados)
name - Nome do usuário VPN
deviceName - Nome do computador ou dispositivo
uptime - quanto tempo o Cliente esteve conectado à Cato Cloud (em segundos)
lastConnected - carimbo de data/hora de quando o usuário VPN se conectou ao PoP
version - versão do software Cliente (string)
versionNumber - versão do software Cliente (INT)
popID - ID do PoP ao qual o Cliente está conectado
popName - Nome do PoP ao qual o usuário VPN está conectado
RemoteIP - Endereço IP do Cliente
RemoteIPInfo - Endereço IP, ISP e informações geográficas relacionadas ao Cliente
internalIP - Endereço IP do PoP ao qual o Cliente está conectado
osType - Sistema Operacional do dispositivo em que o Cliente está rodando
osVersion - Versão do Sistema Operacional para o dispositivo
devices - dados relacionados ao Cliente (array com campos aninhados)
connectedInOffice - mostra se o Cliente está conectado ao VPN usando o Modo de Escritório
metrics - métricas de tráfego em tempo real (com base nos últimos 30 segundos) e dados para o Cliente (array com campos aninhados)
info - informações gerais sobre o usuário VPN (array com campos aninhados)
recentConnections - dados relacionados às conexões de VPN mais recentes completadas (array com consultas e campos aninhados)

ID

Mostra o ID interno único do usuário VPN para a conta, esse valor não é mostrado no Aplicativo de Gerenciamento Cato.

connectivityStatus

O campo Usuários > connectivityStatus mostra a conectividade para um usuário VPN:

Conectado à Cato Cloud
Desconectado da Cato Cloud

operationalStatus

O campo Usuários > operationalStatus mostra o status do usuário VPN:

Ativo - passando tráfego
Desabilitado - desativado no Aplicativo de Gerenciamento Cato
Bloqueado - conta para este usuário VPN está bloqueada
Novo - não relevante para usuários VPN
pending_user_configuration - aguardando o usuário VPN confirmar a conta
pending_mfa_configuration - aguardando o usuário VPN configurar as Configurações do MFA
pending_code_generation - aguardando o usuário VPN inserir o Código de Registro

Nome

O campo nome mostra o Nome do usuário VPN no Aplicativo de Gerenciamento Cato.

DeviceName

O campo deviceName mostra o Nome do computador ou dispositivo que está conectado à Cato Cloud.

uptime

O campo uptime mostra o total de tempo em segundos que o usuário VPN está conectado à Cato Cloud.

lastConnected

Para um usuário VPN que não está conectado à Cato Cloud, o campo lastConnected mostra o carimbo de data/hora da última vez que o Cliente se conectou à Cato Cloud.

version

O campo version mostra a versão do Cliente como o tipo STRING.

versionNumber

O campo versionNumber mostra a versão do Cliente como o tipo INT.

PopID

O campo Usuários > PoPID mostra o ID do PoP ao qual o Cliente está conectado.

PopName

O campo Usuários > PoPName mostra o Nome do PoP ao qual o Cliente está conectado.

RemoteIP

O campo Usuários > RemoteIP mostra o Endereço IP do Cliente.

RemoteIPInfo

O campo Usuários > RemoteIPInfo mostra dados relacionados ao Endereço IP, ISP e localização física do PoP ao qual o Cliente está conectado. Estes são os detalhes para os campos:

ip - Endereço IP da conexão WAN com o PoP
countryCode - código para a localização física do PoP (baseado na geolocalização do Endereço IP)
countryName - País que é a localização física do PoP (baseado na geolocalização do Endereço IP)
city - Cidade onde o PoP está localizado (baseado na geolocalização do Endereço IP)
state - Estado onde o PoP está localizado (baseado na geolocalização do Endereço IP)
provider - Provedor de ISP para a conexão de última milha entre a Cato Cloud e o PoP
latitude - latitude do PoP (baseado na geolocalização do Endereço IP)
longitude - longitude do PoP (baseado na localização geográfica do endereço IP)

InternalIP

O campo Usuários > InternalIP mostra o endereço IP do PoP ao qual o Cliente está conectado.

osType

O campo osType mostra o sistema operacional do dispositivo no qual o Cliente está instalado.

osVersion

O campo osVersion mostra a versão do sistema operacional do dispositivo no qual o Cliente está instalado.

Dispositivos

Os campos Usuários > DeviceSnapshot mostram métricas e dados do dispositivo que está conectado ao Cato Cloud. Alguns campos em DeviceSnapshot são repetidos para oferecer maior flexibilidade com os dados. Além disso, a mesma infraestrutura DeviceSnapshot é usada para usuários VPN e para sites, e alguns dos campos são relevantes apenas para usuários ou sites.

Estes são os dados que você pode ver:

id - ID interno único da Cato para o dispositivo
nome - nome do dispositivo
identificador - identificador único para o dispositivo
conectado - um valor booleano que indica se o Cliente está conectado ao Cato Cloud
haRole - este campo é usado em SiteSnapshot > Site > Dispositivos
interfaces - mostra dados em tempo real para o Cliente (array com consultas e campos aninhados)
Para mais informações sobre os campos Interfaces para DeviceSnapshot, veja Cato API - Instantâneo da Conta > Sites > Dispositivos > Interfaces.
lastConnected - carimbo de data/hora de quando o Cliente conectou-se ao Cato Cloud
lastDuration - quantidade total de tempo que o Cliente esteve conectado ao Cato Cloud
connectedSince - mostra o carimbo de data/hora de quanto tempo o Cliente está ativamente conectado ao Cato Cloud
lastPopName - o nome do PoP ao qual o Cliente está conectado
lastPopID - o ID do PoP ao qual o Cliente está conectado
métricas - métricas de tráfego em tempo real e dados para o Socket (array com consultas e campos aninhados)
Para mais informações sobre os campos de Métricas para DeviceSnapshot, veja Cato API - Instantâneo da Conta > Locais > Dispositivos > Interfaces.
recentConnections - dados relacionados aos fluxos de tráfego mais recentes concluídos (array com consultas e campos aninhados)
Para mais informações sobre os campos recentConnections para DeviceSnapshot, veja Cato API - Instantâneo da Conta > Sites > Dispositivos.
tipo - mostra o tipo de dispositivo
uptimeSeconds - mostra o número de segundos que este Cliente esteve ativo
socketInfo - este campo é usado em SiteSnapshot > Site > Dispositivos
interfacesLinkState - este campo é usado em SiteSnapshot > Site > Dispositivos
osType - sistema operacional do dispositivo no qual o Cliente está em execução
osVersion - versão do sistema operacional para o dispositivo
versão - versão do software do Cliente, por exemplo, 4.4.1234 (string)
versionNumber - versão principal do software do Cliente, por exemplo, 4 (INT)
releaseGroup - mostra o status de lançamento para o Cliente, como GA ou EA
mfaExpirationTime - Mostra a quantidade de tempo restante antes que o token de MFA expire

connectedInOffice

O campo connectedInOffice é um valor booleano, e quando é verdadeiro, mostra que o Cliente está conectado à rede usando o Modo de Escritório.

Painel de Métricas

Os campos Usuários > Painel de Métricas mostram as análises de tráfego em tempo real para o Cliente. Estes são os dados que você pode ver:

duração - quantidade total de tempo para os dados do Cliente
granularity - duração em segundos para um único balde de métricas
bytesDownstream - tráfego total recebido (do Cato Cloud para o Cliente)
bytesUpstream - tráfego total enviado (do Cliente para o Cato Cloud)
bytesTotal - tráfego total para o Cliente
lostDownstream - número de pacotes perdidos para o tráfego recebido
lostDownstreamPcnt - porcentagem de pacotes perdidos para o tráfego recebido
lostUpstream - número de pacotes perdidos para o tráfego enviado
lostUpstreamPcnt - porcentagem de pacotes perdidos para o tráfego enviado
packetsDownstream - total de pacotes recebidos
packetsUpstream - total de pacotes enviados
jitterUpstream - variação para o tráfego enviado (diferença no atraso de tempo em milissegundos (ms) entre pacotes de dados)
jitterDownstream - variação para o tráfego recebido (diferença no atraso de tempo em milissegundos (ms) entre pacotes de dados)
packetsDiscardedDownstream - total de pacotes descartados para o tráfego recebido
packetsDiscardedUpstream - total de pacotes descartados para o tráfego enviado
rtt - tempo de ida e volta do Cliente para o Cato Cloud

Informações

Os campos UserInfo mostram informações básicas sobre o usuário VPN, em uma ramificação concisa. Estes são os detalhes para os campos:

nome - nome do usuário VPN
status - status do Cliente como o tipo STRING
email - endereço de e-mail do usuário VPN
creationTime - timestamp quando o Usuário VPN foi criado na Conta
phoneNumber - Número de Telefone para o Usuário VPN
origin - mostra como o Usuário VPN foi adicionado à Conta:
- regular - manualmente adicionado no Aplicativo de Gerenciamento Cato
- LDAP - adicionado com Sincronização LDAP
authMethod - Configurações de Autenticação Multifatorial (MFA) para este Usuário VPN:
- Nenhum - o Usuário VPN não requer MFA para autenticar ao Cliente
- MFA - o Usuário VPN requer MFA para autenticar ao Cliente

ConexõesRecentes

O campo Usuários > ConexõesRecentes mostra dados relacionados às conexões mais recentes do Cliente para o Cato Cloud. Estes são os Detalhes que este campo pode retornar para uma consulta:

duração - quantidade total de Tempo para os Dados da consulta
interfaceName - Nome para a Porta na Aplicação de Gerenciamento
deviceName - Nome do Dispositivo no qual o Cliente está instalado
lastConnected - Mostra o timestamp quando o Cliente iniciou a Conexão com o Cato Cloud
popID - O ID do PoP ao qual o Cliente estava conectado
popName - O Nome do PoP ao qual o Cliente estava conectado
remoteIP - Endereço IP do Cliente
remoteIPInfo - Endereço IP, ISP e informações geográficas relacionadas ao PoP ao qual o fluxo de Tráfego estava conectado

Captura Instantânea > Argumento de IDs de Usuários

Digite os IDs dos Usuários VPN para os Dados que a consulta retorna. Quando este argumento está vazio, a consulta retorna todos os Usuários VPN conectados ao Cato Cloud.

Cato API - Instantâneo da Conta > Usuários