Cato API - AccountSnapshot > Usuarios

AccountSnapshot > Usuarios

El campo UserSnapshot contiene datos relacionados con los usuarios de VPN en la cuenta. Cuando ejecutas una consulta para todos los usuarios en la cuenta (el argumento ID está vacío), entonces la llamada API devuelve datos de los usuarios que están actualmente conectados al VPN y al Cato Cloud.

Si usas el argumento ID para ejecutar una consulta para usuarios específicos, la llamada API devuelve datos de esos usuarios incluso cuando no están conectados al VPN.

Campos de UserSnapshot

Los campos UserSnapshot contienen datos de usuarios de VPN conectados y sus conexiones al Cato Cloud. Usa el argumento IDs para especificar qué usuarios de VPN están incluidos en la consulta.

Estos son los detalles que los campos UserSnapshot pueden devolver para la consulta:

  • id - ID de usuario de VPN
  • connectivityStatus - conectividad al Cato Cloud (arreglo con campos anidados)
  • operationalStatus - estado para un sitio o usuario de VPN (arreglo con campos anidados)
  • name - nombre del usuario de VPN
  • deviceName - nombre de la computadora o dispositivo
  • uptime - cuánto tiempo el Cliente ha estado conectado al Cato Cloud (en segundos)
  • lastConnected - marca de tiempo de cuando el usuario de VPN se conectó al PoP
  • version - versión del software del Cliente (cadena)
  • versionNumber - versión del software del Cliente (INT)
  • popID - ID del PoP al que el Cliente está conectado
  • popName - nombre del PoP al que el usuario de VPN está conectado
  • RemoteIP - dirección IP del Cliente
  • RemoteIPInfo - dirección IP, ISP y información geográfica relacionada con el Cliente
  • internalIP - dirección IP del PoP al que el Cliente está conectado
  • osType - sistema operativo del dispositivo en el que se ejecuta el Cliente
  • osVersion - versión del sistema operativo para el dispositivo
  • devices - datos relacionados con el Cliente (arreglo con campos anidados)
  • connectedInOffice - muestra si el Cliente está conectado al VPN usando el Modo Oficina
  • metrics - métricas de tráfico en tiempo real (basadas en los últimos 30 segundos) y datos para el Cliente (arreglo con campos anidados)
  • info - información general sobre el usuario de VPN (arreglo con campos anidados)
  • recentConnections - datos relacionados con las conexiones VPN más recientes completadas (arreglo con consultas y campos anidados)

ID

Muestra el ID único interno del usuario de VPN para la cuenta, este valor no se muestra en la Aplicación de Gestión de Cato.

connectivityStatus

El campo Usuarios > connectivityStatus muestra la conectividad para un usuario de VPN:

  • connected al Cato Cloud
  • disconnected del Cato Cloud

operationalStatus

El campo Usuarios > operationalStatus muestra el estado del usuario de VPN:

  • active - pasando tráfico
  • disabled - deshabilitado en la Aplicación de Gestión de Cato
  • locked - la cuenta para este usuario de VPN está bloqueada
  • new - no relevante para usuarios de VPN
  • pending_user_configuration - esperando que el usuario de VPN confirme la cuenta
  • pending_mfa_configuration - esperando que el usuario de VPN configure los ajustes de MFA
  • pending_code_generation - esperando que el usuario de VPN ingrese el código de registro

Name

El campo nombre muestra el nombre del usuario de VPN en la Aplicación de Gestión de Cato.

DeviceName

El campo deviceName muestra el nombre de la computadora o dispositivo que está conectado al Cato Cloud.

uptime

El campo uptime muestra la cantidad total de tiempo en segundos, que el usuario de VPN está conectado al Cato Cloud.

lastConnected

Para un usuario de VPN que no está conectado al Cato Cloud, el campo lastConnected muestra la marca de tiempo de la última vez que el Cliente se conectó al Cato Cloud.

version

El campo version muestra la versión del Cliente como el tipo STRING.

versionNumber

El campo versionNumber muestra la versión del Cliente como el tipo INT.

PopID

El campo Usuarios > PoPID muestra el ID del PoP al que el Cliente está conectado.

PopName

El campo Usuarios > PoPName muestra el nombre del PoP al que el Cliente está conectado.

RemoteIP

El campo Usuarios > RemoteIP muestra la dirección IP del Cliente.

RemoteIPInfo

El campo Usuarios > RemoteIPInfo muestra datos relacionados con la dirección IP, ISP y ubicación física del PoP al que el Cliente está conectado. Estos son los detalles para los campos:

  • ip - dirección IP de la conexión WAN hacia el PoP
  • countryCode - código para la ubicación física del PoP (basado en la geo-localización de la dirección IP)
  • countryName - país que es la ubicación física del PoP (basado en la geo-localización de la dirección IP)
  • city - ciudad donde se encuentra el PoP (basado en la geo-localización de la dirección IP)
  • state - estado donde se encuentra el PoP (basado en la geo-localización de la dirección IP)
  • provider - proveedor de ISP para la conexión de último tramo entre el Cato Cloud y el PoP
  • latitude - latitud del PoP (basado en la geo-localización de la dirección IP)
  • longitude - longitud del PoP (basado en la geo-localización de la dirección IP)

InternalIP

El campo Usuarios > internalIP muestra la dirección IP del PoP al que el Cliente está conectado.

osType

El campo osType muestra el sistema operativo del dispositivo en el que está instalado el Cliente.

osVersion

El campo osVersion muestra la versión del sistema operativo del dispositivo en el que está instalado el Cliente.

Dispositivos

Los campos Usuarios > DeviceSnapshot muestran métricas y datos del dispositivo que está conectado al Cato Cloud. Algunos campos en DeviceSnapshot se repiten para ofrecerte mayor flexibilidad con los datos. Además, se utiliza la misma infraestructura de DeviceSnapshot para usuarios de VPN y para sitios, y algunos de los campos solo son relevantes para usuarios o sitios.

Estos son los datos que puedes ver:

  • id - ID único interno de Cato para el dispositivo
  • name - nombre del dispositivo
  • identifier - identificador único para el dispositivo
  • connected - un valor booleano que indica si el Cliente está conectado al Cato Cloud
  • haRole - este campo se utiliza en SiteSnapshot > Site> Devices
  • interfaces - muestra datos en tiempo real para el Cliente (arreglo con consultas y campos anidados)

    Para más información sobre los campos Interfaces para DeviceSnapshot, consulta Cato API - AccountSnapshot > Sites > Devices > Interfaces.

  • lastConnected - marca de tiempo de cuando el Cliente se conectó al Cato Cloud
  • lastDuration - cantidad total de tiempo que el Cliente ha estado conectado al Cato Cloud
  • connectedSince - muestra la marca de tiempo de cuánto tiempo el Cliente está activamente conectado al Cato Cloud
  • lastPopName - el nombre del PoP al que el Cliente está conectado
  • lastPopID - el ID del PoP al que el Cliente está conectado
  • metrics - métricas de tráfico en tiempo real y datos para el Socket (arreglo con consultas y campos anidados)

    Para más información sobre los campos Metrics para DeviceSnapshot, consulta Cato API - AccountSnapshot > Sites > Devices > Interfaces.

  • recentConnections - datos relacionados con los flujos de tráfico más recientes completados (arreglo con consultas y campos anidados)

    Para más información sobre los campos recentConnections para DeviceSnapshot, consulta Cato API - AccountSnapshot > Sites > Devices.

  • type - muestra el tipo de dispositivo
  • uptimeSeconds - muestra el número de segundos que este Cliente ha estado activo
  • socketInfo - este campo se utiliza en SiteSnapshot > Site> Devices
  • interfacesLinkState - este campo se utiliza en SiteSnapshot > Site> Devices
  • osType - sistema operativo del dispositivo en el que se ejecuta el Cliente
  • osVersion - versión del sistema operativo para el dispositivo
  • version - versión del software del Cliente, por ejemplo 4.4.1234 (cadena)
  • versionNumber - versión principal del software del Cliente, por ejemplo 4 (INT)
  • releaseGroup - muestra el estado de lanzamiento para el Cliente, como GA o EA
  • mfaExpirationTime - Muestra la cantidad de tiempo restante antes de que el token de MFA expire

connectedInOffice

El campo connectedInOffice es un valor booleano, y cuando es true, muestra que el Cliente está conectado a la red usando el Modo Oficina.

Métricas

Los campos Usuarios > Metrics muestran el análisis de tráfico en tiempo real para el Cliente. Estos son los datos que puedes ver:

  • duration - cantidad total de tiempo para los datos del Cliente
  • granularity - duración en segundos para un único contenedor de métricas
  • bytesDownstream - tráfico total descendente (desde el Cato Cloud hacia el Cliente)
  • bytesUpstream - tráfico total ascendente (desde el Cliente hacia el Cato Cloud)
  • bytesTotal - tráfico total para el Cliente
  • lostDownstream - número de paquetes perdidos para el tráfico descendente
  • lostDownstreamPcnt - porcentaje de paquetes perdidos para el tráfico descendente
  • lostUpstream - número de paquetes perdidos para el tráfico ascendente
  • lostUpstreamPcnt - porcentaje de paquetes perdidos para el tráfico ascendente
  • packetsDownstream - paquetes descendentes totales
  • packetsUpstream - paquetes ascendentes totales
  • jitterUptstream - jitter para el tráfico ascendente (diferencia en el retraso en el tiempo en milisegundos (ms) entre los paquetes de datos)
  • jitterDownstream - jitter para el tráfico descendente (diferencia en el retraso en el tiempo en milisegundos (ms) entre los paquetes de datos)
  • packetsDiscardedDownstream - paquetes totales descartados para el tráfico descendente
  • packetsDiscardedUpstream - paquetes totales descartados para el tráfico ascendente
  • rtt - tiempo de ida y vuelta desde el Cliente al Cato Cloud

Información

Los campos UserInfo muestran información básica sobre el usuario de VPN, en una rama concisa. Estos son los detalles para los campos:

  • name - nombre del usuario de VPN
  • status - estado del Cliente como el tipo STRING
  • email - dirección de correo electrónico del usuario de VPN
  • creationTime - marca de tiempo cuando el usuario de VPN fue creado en la cuenta
  • phoneNumber - número de teléfono para el usuario de VPN
  • origin - muestra cómo fue agregado el usuario de VPN a la cuenta:
    • regular - agregado manualmente en la Aplicación de Gestión de Cato
    • LDAP - agregado con sincronización LDAP
  • authMethod - ajustes de Autenticación Multifactor (MFA) para este usuario de VPN:
    • Ninguno - el usuario VPN no requiere MFA para autenticarse en el Cliente
    • MFA - el usuario VPN requiere MFA para autenticarse en el Cliente

ConexionesRecientes

El campo Usuarios > ConexionesRecientes muestra los datos relacionados con las conexiones más recientes del Cliente a la Nube Cato. Estos son los detalles que este campo puede devolver para una consulta:

  • duración - cantidad total de tiempo para los datos de la consulta
  • nombreInterfaz - Nombre del puerto en la Aplicación de Gestión Cato
  • nombreDispositivo - Nombre del dispositivo en el que está instalado el Cliente
  • últimaConexión - Muestra la marca de tiempo cuando el Cliente inició la conexión a la Nube Cato
  • idPoP - El ID del PoP al que el Cliente estaba conectado
  • nombrePoP - El nombre del PoP al que el Cliente estaba conectado
  • ipRemota - Dirección IP del Cliente
  • infoIPRemota - Dirección IP, ISP e información geográfica relacionada con el PoP al que estaba conectado el flujo de tráfico

Instantánea > Argumento ID de Usuarios

Ingrese los ID de usuario VPN para los datos que devuelve la consulta. Cuando este argumento está vacío, la consulta devuelve todos los usuarios VPN conectados a la Nube Cato.

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0

0 comentarios