Cato API - AccountSnapshot > Usuários

AccountSnapshot > Usuários

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

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

Campos de UserSnapshot

Os campos UserSnapshot contêm dados para usuários de VPN conectados e suas conexões com a Nuvem Cato. Use o argumento IDs para especificar quais usuários de 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 de VPN
  • connectivityStatus - conectividade com a Nuvem Cato (array com campos aninhados)
  • operationalStatus - status para um site ou usuário de VPN (array com campos aninhados)
  • name - nome do usuário de VPN
  • deviceName - nome do computador ou dispositivo
  • uptime - tempo de conexão do Cliente à Nuvem Cato (em segundos)
  • lastConnected - data/hora em que o usuário de VPN se conectou ao PoP
  • version - Versão do software do Cliente (string)
  • versionNumber - Versão do software do Cliente (INT)
  • popID - ID do PoP ao qual o Cliente está conectado
  • popName - nome do PoP ao qual o usuário de 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á sendo executado
  • osVersion - versão do sistema operacional do dispositivo
  • devices - dados relacionados ao Cliente (array com campos aninhados)
  • connectedInOffice - mostra se o Cliente está conectado à VPN usando o Modo Office
  • info - informações gerais sobre o usuário de 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 de VPN para a conta, este valor não é mostrado na Aplicação de Gerenciamento Cato.

connectivityStatus

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

  • conectado à Nuvem Cato
  • desconectado da Nuvem Cato

operationalStatus

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

  • ativo - passando tráfego
  • desativado - desativado na Aplicação de Gerenciamento Cato
  • bloqueado - conta para este usuário de VPN está bloqueada
  • novo - não relevante para usuários de VPN
  • pending_user_configuration - aguardando o usuário de VPN confirmar a conta
  • pending_mfa_configuration - aguardando o usuário de VPN configurar as Configurações de Proteção de Endpoint
  • pending_code_generation - aguardando o usuário de VPN inserir o código de registro

Nome

O campo nome mostra o nome do usuário de VPN na Aplicação de Gerenciamento Cato.

Nome do Dispositivo

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

uptime

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

lastConnected

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

Versão

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

Os campos Usuários > RemoteIPInfo mostram 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 WAN conectado ao PoP
  • countryCode - código para a localização física do PoP (baseado na geolocalização do endereço IP)
  • countryName - país onde o PoP está localizado (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 geolocalização 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 em que o Cliente está instalado.

osVersion

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

Dispositivos

Os campos Usuários > DeviceSnapshot mostram métricas e dados do dispositivo que está conectado à Cato Cloud. Alguns campos em DeviceSnapshot são repetidos para lhe proporcionar maior flexibilidade com os dados. Além disso, a mesma infraestrutura DeviceSnapshot é usada para usuários de VPN e para sites, e alguns 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
  • name - nome do dispositivo
  • identifier - identificador único para o dispositivo
  • connected - um valor booleano que indica se o Cliente está conectado à 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 sobre os campos Interfaces para DeviceSnapshot, veja Cato API - AccountSnapshot > Sites > Dispositivos > Interfaces.

  • lastConnected - marca de tempo quando o Cliente se conectou à Cato Cloud
  • lastDuration - quantidade total de tempo que o Cliente esteve conectado à Cato Cloud
  • connectedSince - mostra a marca de tempo de quanto tempo o Cliente está ativamente conectado à Cato Cloud
  • lastPopName - o nome do PoP ao qual o Cliente está conectado
  • lastPopID - o ID do PoP ao qual o Cliente está conectado
  • recentConnections - dados relacionados aos fluxos de tráfego mais recentes completos (array com consultas e campos aninhados)

    Para mais sobre os campos recentConnections para DeviceSnapshot, veja Cato API - AccountSnapshot > Sites > Dispositivos.

  • type - 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á rodando
  • osVersion - versão do sistema operacional para o dispositivo
  • version - versão do software do Cliente, por exemplo, 4.4.1234 (string)
  • versionNumber - versão major do software do Cliente, por exemplo, 4 (INT)
  • releaseGroup - mostra o status de liberação para o Cliente, como GA ou EA
  • mfaExpirationTime - Mostra o tempo restante antes do token MFA expirar

connectedInOffice

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

Informação

Os campos UserInfo mostram informações básicas sobre o usuário de VPN, de forma sucinta. Estes são os detalhes para os campos:

  • name - nome do usuário de VPN
  • status - status do Cliente como tipo STRING
  • email - endereço de e-mail do usuário de VPN
  • creationTime - marca de tempo quando o usuário de VPN foi criado na conta
  • phoneNumber - número de telefone para o usuário de VPN
  • origin - mostra como o usuário de VPN foi adicionado à conta:
    • regular - adicionado manualmente na Aplicação de Gerenciamento Cato
    • LDAP - adicionado com sincronização LDAP
  • authMethod - Configurações de Autenticação Multifatorial (MFA) para este usuário de VPN:
    • None - o usuário de VPN não requer MFA para autenticar no Cliente
    • MFA - o usuário de VPN requer MFA para autenticar no Cliente

Conexões Recentes

O campo Usuários > RecentConnections mostra dados relacionados às conexões de Cliente mais recentes com a Cato Cloud. Estes são os detalhes que este campo pode retornar para uma consulta:

  • duration - quantidade total de tempo para os dados da consulta
  • interfaceName - Nome para a porta na Aplicação de Gerenciamento Cato
  • deviceName - Nome do dispositivo no qual o Cliente está instalado
  • lastConnected - Mostra a marca de tempo quando o Cliente iniciou a conexã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

Snapshot > IDs de Usuários Argumento

Digite os IDs de usuários de VPN para os dados que a consulta retorna. Quando este argumento está vazio, a consulta retorna todos os usuários de VPN conectados à Cato Cloud.

Esse artigo foi útil?

Usuários que acharam isso útil: 0 de 0

0 comentário