Cato API - AccountSnapshot > Utilisateurs

AccountSnapshot > Utilisateurs

Le champ UserSnapshot contient des données relatives aux utilisateurs VPN du compte. Lorsque vous exécutez une requête pour tous les utilisateurs du compte (l'argument ID est vide), alors l'appel API renvoie les données des utilisateurs actuellement connectés au VPN et au Cato Cloud.

Si vous utilisez l'argument ID pour exécuter une requête pour des utilisateurs spécifiques, l'appel API renvoie des données pour ces utilisateurs même lorsqu'ils ne sont pas connectés au VPN.

Champs UserSnapshot

Les champs UserSnapshot contiennent des données sur les utilisateurs VPN connectés et leurs connexions au Cato Cloud. Utilisez l'argument IDs pour spécifier quels utilisateurs VPN sont inclus dans la requête.

Voici les détails que les champs UserSnapshot peuvent retourner pour la requête :

  • id - ID utilisateur VPN
  • connectivityStatus - connectivité au Cato Cloud (tableau avec champs imbriqués)
  • operationalStatus - statut pour un site ou un utilisateur VPN (tableau avec champs imbriqués)
  • name - nom de l'utilisateur VPN
  • deviceName - nom de l'ordinateur ou du dispositif
  • uptime - durée pendant laquelle le Client a été connecté au Cato Cloud (en secondes)
  • lastConnected - horodatage du moment où l'utilisateur VPN s'est connecté au PoP
  • version - version du logiciel Client (chaîne)
  • versionNumber - version du logiciel Client (INT)
  • popID - ID du PoP auquel le Client est connecté
  • popName - nom du PoP auquel l'utilisateur VPN est connecté
  • RemoteIP - adresse IP du Client
  • RemoteIPInfo - adresse IP, ISP et informations géographiques concernant le Client
  • internalIP - adresse IP du PoP auquel le Client est connecté
  • osType - système d'exploitation de l'appareil sur lequel le Client est installé
  • osVersion - version du système d'exploitation pour l'appareil
  • devices - données concernant le Client (tableau avec champs imbriqués)
  • connectedInOffice - indique si le Client est connecté au VPN en utilisant le Mode Bureau
  • metrics - métriques de trafic en temps réel (basées sur les 30 dernières secondes) et données pour le Client (tableau avec champs imbriqués)
  • info - informations générales sur l'utilisateur VPN (tableau avec champs imbriqués)
  • recentConnections - données concernant les connexions VPN les plus récentes complétées (tableau avec requêtes et champs imbriqués)

ID

Affiche l'ID interne unique de l'utilisateur VPN pour le compte, cette valeur n'est pas affichée dans l'application de gestion Cato.

connectivityStatus

Le champ Utilisateurs > connectivityStatus montre la connectivité pour un utilisateur VPN :

  • connecté au Cato Cloud
  • déconnecté du Cato Cloud

operationalStatus

Le champ Utilisateurs > operationalStatus montre le statut de l'utilisateur VPN :

  • actif - passage du trafic
  • désactivé - désactivé dans l'application de gestion Cato
  • verrouillé - le compte pour cet utilisateur VPN est verrouillé
  • nouveau - non pertinent pour les utilisateurs VPN
  • configuration_utilisateur_en_attente - en attente que l'utilisateur VPN confirme le compte
  • configuration_mfa_en_attente - en attente que l'utilisateur VPN configure les paramètres MFA
  • génération_code_en_attente - en attente que l'utilisateur VPN entrée le code d'enregistrement

Nom

Le champ nom montre le nom de l'utilisateur VPN dans l'application de gestion Cato.

NomDeLAppareil

Le champ NomDeLAppareil montre le nom de l'ordinateur ou de l'appareil connecté au Cato Cloud.

tempsDeFonctionnement

Le champ tempsDeFonctionnement montre le montant total de temps en secondes que l'utilisateur VPN est connecté au Cato Cloud.

dernièreConnexion

Pour un utilisateur VPN qui n'est pas connecté au Cato Cloud, le champ dernièreConnexion montre l'horodatage pour la dernière fois que le Client s'est connecté au Cato Cloud.

version

Le champ version montre la version du Client sous forme de chaîne.

numéroDeVersion

Le champ numéroDeVersion montre la version du Client sous forme de nombre entier.

IDDuPop

Le champ Utilisateurs > IDDuPop montre l'ID du PoP auquel le Client est connecté.

NomDuPop

Le champ Utilisateurs > NomDuPop montre le nom du PoP auquel le Client est connecté.

IPExterne

Le champ Utilisateurs > IPExterne montre l'adresse IP du Client.

InfoIPExterne

Le champ Utilisateurs > InfoIPExterne montre les données relatives à l'adresse IP, l'ISP et à la localisation physique du PoP auquel le Client est connecté. Voici les détails pour les champs :

  • ip - adresse IP de la connexion WAN vers le PoP
  • countryCode - code pour la localisation physique du PoP (basé sur la géolocalisation de l'adresse IP)
  • countryName - pays où se trouve la localisation physique du PoP (basé sur la géolocalisation de l'adresse IP)
  • city - ville où se trouve le PoP (basé sur la géolocalisation de l'adresse IP)
  • state - état où se trouve le PoP (basé sur la géolocalisation de l'adresse IP)
  • provider - fournisseur ISP pour la connexion de dernier kilomètre entre le Cato Cloud et le PoP
  • latitude - latitude du PoP (basé sur la géolocalisation de l'adresse IP)
  • longitude - longitude du PoP (basé sur la géolocalisation de l'adresse IP)

IPInterne

Le champ Utilisateurs > IPInterne montre l'adresse IP du PoP auquel le Client est connecté.

systèmeExploitation

Le champ systèmeExploitation montre le système d'exploitation de l'appareil sur lequel le Client est installé.

versionExploitation

Le champ versionExploitation montre la version du système d'exploitation de l'appareil sur lequel le Client est installé.

Appareils

Les champs Utilisateurs > DeviceSnapshot montrent les métriques et les données de l'appareil connecté au Cato Cloud. Certains champs dans DeviceSnapshot sont répétés pour vous donner une plus grande flexibilité avec les données. De plus, la même infrastructure DeviceSnapshot est utilisée pour les utilisateurs VPN et pour les sites, et certains des champs ne sont pertinents que pour les utilisateurs ou les sites.

Voici les données que vous pouvez voir :

  • id - ID unique interne Cato pour l'appareil
  • nom - nom de l'appareil
  • identifiant - identifiant unique pour l'appareil
  • connecté - une valeur booléenne qui indique si le Client est connecté au Cato Cloud
  • rôleHA - ce champ est utilisé dans SiteSnapshot > Site > Appareils
  • interfaces - montre les données en temps réel pour le Client (tableau avec requêtes et champs imbriqués)

    Pour plus d'informations sur les champs Interfaces pour DeviceSnapshot, voir Cato API - AccountSnapshot > Sites > Appareils > Interfaces.

  • dernièreConnexion - horodatage du moment où le Client s'est connecté au Cato Cloud
  • duréeDernièreConnexion - quantité totale de temps que le Client a été connecté au Cato Cloud
  • connectéDepuis - montre l'horodatage de combien de temps le Client est activement connecté au Cato Cloud
  • nomDernierPop - le nom du PoP auquel le Client est connecté
  • IDDernierPop - l'ID du PoP auquel le Client est connecté
  • métriques - métriques de trafic en temps réel et données pour le Socket (tableau avec requêtes et champs imbriqués)

    Pour plus d'informations sur les champs Metrics pour DeviceSnapshot, voir Cato API - AccountSnapshot > Sites > Appareils > Interfaces.

  • connexionsRécentes - données concernant les flux de trafic les plus récents complétés (tableau avec requêtes et champs imbriqués)

    Pour plus d'informations sur les champs recentConnections pour DeviceSnapshot, voir Cato API - AccountSnapshot > Sites > Appareils.

  • type - montre le type d'appareil
  • tempsDeFonctionnementSeconds - montre le nombre de secondes que ce Client a été actif
  • infoSocket - ce champ est utilisé dans SiteSnapshot > Site > Appareils
  • interfacesLinkState - ce champ est utilisé dans SiteSnapshot > Site> Devices
  • osType - système d'exploitation de l'appareil sur lequel le Client fonctionne
  • osVersion - version du système d'exploitation pour l'appareil
  • version - version du logiciel Client, par exemple 4.4.1234 (chaîne)
  • versionNumber - version majeure du logiciel Client, par exemple 4 (INT)
  • releaseGroup - Montre le statut de la version pour le Client, comme GA ou EA
  • mfaExpirationTime - Montre la durée restante avant l'expiration du jeton MFA

connectedInOffice

Le champ connectedInOffice est une valeur booléenne, et lorsqu'il est true, il montre que le Client est connecté au réseau en utilisant le Mode Bureau.

Métriques

Les champs Users > Metrics montrent les analyses de trafic en temps réel pour le Client. Voici les données que vous pouvez voir :

  • duration - durée totale pour les données du Client
  • granularity - durée en secondes pour un seul seau de métriques
  • bytesDownstream - total du trafic descendant (du Cato Cloud vers le Client)
  • bytesUpstream - total du trafic montant (du Client vers le Cato Cloud)
  • bytesTotal - trafic total pour le Client
  • lostDownstream - nombre de paquets perdus pour le trafic descendant
  • lostDownstreamPcnt - pourcentage de paquets perdus pour le trafic descendant
  • lostUpstream - nombre de paquets perdus pour le trafic montant
  • lostUpstreamPcnt - pourcentage de paquets perdus pour le trafic montant
  • packetsDownstream - total des paquets descendants
  • packetsUpstream - total des paquets montants
  • jitterUptstream - gigue pour le trafic montant (différence de délai temporel en millisecondes (ms) entre les paquets de données)
  • jitterDownstream - gigue pour le trafic descendant (différence de délai temporel en millisecondes (ms) entre les paquets de données)
  • packetsDiscardedDownstream - total des paquets rejetés pour le trafic descendant
  • packetsDiscardedUpstream - total des paquets rejetés pour le trafic montant
  • rtt - temps aller-retour du Client au Cato Cloud

Info

Les champs UserInfo montrent les informations de base sur l'utilisateur VPN, dans une branche concise. Voici les détails pour les champs :

  • name - nom de l'utilisateur VPN
  • status - statut du Client en tant que type STRING
  • email - adresse e-mail de l'utilisateur VPN
  • creationTime - horodatage lorsque l'utilisateur VPN a été créé dans le compte
  • phoneNumber - numéro de téléphone pour l'utilisateur VPN
  • origin - montre comment l'utilisateur VPN a été ajouté au compte :
    • regular - ajouté manuellement dans l'application de gestion Cato
    • LDAP - ajouté avec la synchronisation LDAP
  • authMethod - paramètres de l'authentification multifactorielle (MFA) pour cet utilisateur VPN :
    • None - l'utilisateur VPN n'a pas besoin de MFA pour s'authentifier au Client
    • MFA - l'utilisateur VPN nécessite MFA pour s'authentifier au Client

ConexionesRecientes

Le champ Users > RecentConnections montre les données relatives aux connexions les plus récentes du Client au Cato Cloud. Voici les détails que ce champ peut renvoyer pour une requête :

  • durée - durée totale pour les données de la requête
  • interfaceName - Nom du port dans l'application de gestion Cato
  • deviceName - Nom de l'appareil sur lequel le Client est installé
  • lastConnected - Montre l'horodatage lorsque le Client a initié la connexion au Cato Cloud
  • popID - L'ID du PoP auquel le Client était connecté
  • popName - Le nom du PoP auquel le Client était connecté
  • remoteIP - Adresse IP du Client
  • remoteIPInfo - Adresse IP, FAI et informations géographiques liées au PoP auquel le flux de trafic était connecté

Snapshot > Users IDs Argument

Saisir les IDs utilisateur VPN pour les données que la requête renvoie. Lorsque cet argument est vide, la requête renvoie tous les utilisateurs VPN connectés au Cato Cloud.

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0

0 commentaire