Cato API - AccountSnapshot > ユーザー

Prev Next

AccountSnapshot > ユーザー

UserSnapshotフィールドは、アカウント内のVPN ユーザーに関連するデータを含みます。 アカウント内のすべてのユーザーに対してクエリを実行する場合(ID 引数が空の場合)、API 呼び出しは現在VPN とCato Cloudに接続されているユーザーのデータを返します。

特定のユーザーのためにID引数を使用してクエリを実行すると、これらのユーザーがVPNに接続されていない場合でもデータが返されます。

ユーザーSnapshot項目

UserSnapshotの項目は、接続されたVPN ユーザーと、そのCato Cloudへの接続データを含みます。 ID引数を使用して、クエリに含めるVPN ユーザーを指定します。

UserSnapshotの項目がクエリのために返すことができる詳細は次の通りです:

  • id - VPN ユーザーID

  • connectivityStatus - Cato Cloudへの接続性(ネストされた項目を含む配列)

  • operationalStatus - サイトまたはVPN ユーザーのステータス(ネストされた項目を含む配列)

  • name - VPN ユーザーの名前

  • deviceName - コンピューターまたはデバイスの名前

  • uptime - クライアントがCato Cloudに接続していた時間(秒単位)

  • lastConnected - クライアントがPoPに接続した時のタイムスタンプ

  • version - クライアントのソフトウェアバージョン(文字列)

  • versionNumber - クライアントソフトウェアのバージョン(INT)

  • popID - クライアントが接続しているPoPのID

  • popName - VPNユーザーが接続するPoPの名前

  • RemoteIP - クライアントのIP アドレス

  • RemoteIPInfo - クライアントに関連するIPアドレス、ISP、地理情報

  • internalIP - クライアントが接続しているPoPのIP アドレス

  • osType - クライアントが実行されているデバイスのオペレーティングシステム

  • osVersion - デバイスのオペレーティングシステムのバージョン

  • devices - クライアントに関連するデータ(ネストされた項目を含む配列)

  • connectedInOffice - クライアントがオフィスモードを使用してVPNに接続しているかどうかを示します

  • info - VPN ユーザー全般情報(ネストされた項目を含む配列)

  • recentConnections - 最近完了したVPN 接続に関連するデータ(ネストされたクエリと項目を含む配列)

ID

アカウントに対するユニークなVPN ユーザー内部IDを表示します。この値はCato管理アプリケーションでは表示されません。

connectivityStatus

ユーザー > connectivityStatusフィールドは、VPN ユーザーの接続性を示します:

  • 接続済み Cato Cloudへ

  • 切断 Cato Cloudから

operationalStatus

ユーザー > operationalStatus のフィールドは、VPN ユーザーのステータスを表示します:

  • active - トラフィック通過

  • disabled - Cato Management Applicationで無効

  • locked - このVPN ユーザーのアカウントがロックされています

  • new - VPN ユーザーには無関係

  • pending_user_configuration - アカウントの確認待ち

  • pending_mfa_configuration - 2要素認証設定の構成待ち

  • pending_code_generation - 登録コードの入力待ち

名前

name フィールドは、Cato管理アプリケーション内のVPN ユーザーの名前を示します。

DeviceName

deviceName フィールドは、Cato Cloudに接続しているコンピューターまたはデバイスの名前を示します。

uptime

uptime フィールドは、VPN ユーザーがCato Cloudに接続されている時間を秒単位で示します。

lastConnected

Cato Cloudに接続されていないVPN ユーザーに対して、lastConnectedフィールドはクライアントが最後にCato Cloudに接続した時のタイムスタンプを表示します。

version

version フィールドは、クライアントのバージョンをSTRING型として示します。

versionNumber

versionNumber フィールドは、クライアントのバージョンをINT型として示します。

PopID

ユーザー > PoPID フィールドは、クライアントが接続しているPoPのID を示します。

PopName

ユーザー > PoPName フィールドは、クライアントが接続しているPoPの名前を示します。

RemoteIP

ユーザー > RemoteIP フィールドは、クライアントのIPアドレスを示します。

RemoteIPInfo

ユーザー > RemoteIPInfo フィールドは、クライアントが接続しているPoPに関連するIP アドレス、ISP、物理位置のデータを示します。 これはフィールドの詳細です:

  • ip - PoPへのWAN 接続のIP アドレス

  • countryCode - PoPの物理的な位置のコード(IP アドレスのジオロケーションベース)

  • countryName - PoPの物理的な位置の国名(IP アドレスのジオロケーションベース)

  • city - PoPの位置する都市(IP アドレスのジオロケーションベース)

  • state - PoPの位置する州(IP アドレスのジオロケーションベース)

  • provider - Cato CloudとPoPのラストマイル接続のISP プロバイダー

  • latitude - PoPの緯度(IP アドレスのジオロケーションベース)

  • longitude - PoPの経度(IP アドレスのジオロケーションベース)

internalIP

ユーザー > internalIPフィールドは、クライアントが接続しているPoPのIPアドレスを示します。

osType

osType フィールドは、クライアントがインストールされているデバイスのオペレーティングシステムを示します。

osVersion

osVersion フィールドは、クライアントがインストールされているデバイスのオペレーティングシステムのバージョンを示します。

デバイス

ユーザー > DeviceSnapshot フィールドは、Cato Cloudに接続しているデバイスのメトリックとデータを表示します。 DeviceSnapshotの一部のフィールドは、データに柔軟性を持たせるために繰り返されます。 また、同じDeviceSnapshotインフラストラクチャがVPN ユーザーとサイトの両方に使用されており、一部のフィールドはユーザーまたはサイトのみに関連しています。

これがご覧になれるデータです:

  • id - デバイスに対するユニークな内部Cato ID 

  • name - デバイスの名前

  • identifier - デバイスのユニークな識別子

  • connected - クライアントがCato Cloudに接続されているかどうかを示すブール値

  • haRole - このフィールドはSiteSnapshot > Site> Devicesで使用されます

  • interfaces - クライアントのリアルタイムデータを表示します(ネストされたクエリと項目を含む配列)

    DeviceSnapshotのインターフェースフィールドに関する詳細については、Cato API - AccountSnapshot > Sites > Devices > Interfacesを参照してください。

  • lastConnected - クライアントがCato Cloudに接続したときのタイムスタンプ

  • lastDuration - クライアントがCato Cloudに接続されていた総時間

  • connectedSince - クライアントがCato Cloudにアクティブに接続されていた経過時間を示します

  • lastPopName - クライアントが接続していたPoP名

  • lastPopID - クライアントが接続していたPoPのID

  • recentConnections - 最近完了したトラフィックフローに関するデータ(ネストされたクエリと項目を含む配列)

    DeviceSnapshotのrecentConnections フィールドについて詳しくは、Cato API - AccountSnapshot > Sites > Devicesを参照。

  • type - デバイスタイプを表示します

  • uptimeSeconds - このクライアントがアクティブであった秒数を表示します

  • socketInfo - このフィールドはSiteSnapshot > Site> Devicesで使用されます

  • interfacesLinkState - このフィールドはSiteSnapshot > Site> Devicesで使用されます

  • osType - クライアントが実行されているデバイスのオペレーティングシステム

  • osVersion - デバイスのオペレーティングシステムのバージョン

  • version - クライアントのソフトウェアバージョン(例:4.4.1234、文字列)

  • versionNumber - クライアントの主要ソフトウェアバージョン(例:4、INT)

  • releaseGroup - クライアントのリリース状況を示します。例えば、GA またはEA

  • mfaExpirationTime - MFA トークンが期限切れになるまでの残り時間を示します

connectedInOffice

connectedInOffice フィールドはブール値であり、trueの場合、クライアントがオフィスモードを使用してネットワークに接続していることを示します。

情報

UserInfo の項目は、VPN ユーザーに関する基本情報を簡潔なブランチで表示します。 これはフィールドの詳細です:

  • name - VPN ユーザーの名前

  • status - クライアントのステータスをSTRING型として

  • email - VPN ユーザーの電子メールアドレス

  • creationTime - VPNユーザーがアカウントに作成された時のタイムスタンプ

  • phoneNumber - VPN ユーザーの電話番号

  • origin - VPN ユーザーがアカウントに追加された方法を示します:

    • regular - Cato管理アプリケーションで手動追加

    • LDAP - LDAP 同期で追加されました

  • authMethod - このVPN ユーザーのための多要素認証(MFA)設定:

    • None - VPN ユーザーはクライアントに認証する際にMFAを必要としません。

    • MFA - VPN ユーザーはクライアントに認証するためにMFAを必要とします。

RecentConnections

ユーザー > RecentConnections 項目は、Cato Cloudへの最近のクライアント接続に関連するデータを示します。 この項目がクエリのために返せる詳細は次の通りです:

  • duration - クエリーデータの総期間

  • interfaceName - Cato管理アプリケーションでのポート名

  • deviceName - クライアントがインストールされているデバイスの名前

  • lastConnected - クライアントがCato Cloudへの接続を開始した時のタイムスタンプを示します

  • popID - クライアントが接続されていたPoPのID

  • popName - クライアントが接続されていたPoPの名前

  • remoteIP - クライアントのIPアドレス

  • remoteIPInfo - トラフィックフローが接続されていたPoPに関連するIPアドレス、ISP、地理情報

Snapshot > ユーザー ID引数

クエリの結果データのためにVPN ユーザーのIDを入力します。 この引数が空の場合、クエリはCato Cloudに接続されているすべてのVPN ユーザーを返します。