ユーザーのサインインとサインアウト
管理者は Sophos Firewall API を使用して、アクセス制御の自動化、外部認証システムとの統合、およびゲストユーザーのアクセス管理を行うことができます。API スクリプトを使用して、ファイアウォールからライブユーザーをサインイン / サインアウトしたり、ネットワークにログインしているユーザーを表示したりできます。
API を使ってユーザーをサインインすると、ファイアウォールの「現在のアクティビティ > ライブユーザー」に表示されます。ユーザーのクライアントの種類は「API クライアント」になります。
XML API または API Controller エンドポイントを使用して、ユーザーのサインインやサインアウトを行えます。
詳しい手順については、お使いのエンドポイントのタブをクリックしてください。
このエンドポイントは、サインインおよびサインアウトを並行して処理します。
このエンドポイントを使用する前に、これらの操作を実行する管理者に読み取り / 書き込み権限を付与する必要があります。以下のような処理が行われます。
「プロファイル > デバイスのアクセス」に移動し、該当する管理者のプロファイルで、「アイデンティティ」の下の「ライブユーザーの管理」を「読み取り、書き込み」に設定します。
このエンドポイントを使用するには、以下の URL を使って POST リクエストを送信する必要があります。
https://<ファイアウォールの IP アドレスまたは FQDN>:<ポート>/xmlapi/v1/authentication/networkuser
ユーザーをサインインするには、次の構文を使用します。
<Request><LiveUserLogin><Admin><UserName>admin</UserName><Password>abcd</Password></Admin><UserName>testuser</UserName><IPAddress>192.0.2.1</IPAddress><MacAddress>AA-BB-CC-DD-EE-FF</MacAddress></LiveUserLogin></Request>
上記の構文中の値はプレースホルダです。ご利用のネットワークに応じて、適切な値に置き換えてください。
ユーザーをサインアウトするには、次の構文を使用します。
<Request><LiveUserLogout><Admin><UserName>admin</UserName><Password>abcd</Password></Admin><UserName>testuser</UserName><IPAddress>192.0.2.1</IPAddress><MacAddress>AA-BB-CC-DD-EE-FF</MacAddress></LiveUserLogout></Request>
上記の構文中の値はプレースホルダです。ご利用のネットワークに応じて、適切な値に置き換えてください。
例
curl -k "https://<192.0.2.1>:<4444>/xmlapi/v1/authentication/networkuser -d '<Request><LiveUserLogin><Admin><UserName>admin</UserName><Password>abcd</Password></Admin><UserName>testuser</UserName><IPAddress>192.0.2.1</IPAddress><MacAddress>DE:AD:BE:EF:CA:FE</MacAddress></LiveUserLogin></Request>'
このエンドポイントは、サインインおよびサインアウトを順番に処理します。
このエンドポイントを使用するには、以下の URL を使ってペイロードを送信する必要があります。
https://<ファイアウォールの IP アドレスまたは FQDN>:<ポート>/webconsole/APIController
ユーザーをサインインするには、次の構文を使用します。
<Request><LiveUserLogin><UserName>admin</UserName><Password>abcd</Password><IPAddress>192.0.2.1</IPAddress><MacAddress>00:0C:29:2D:D3:AC</MacAddress></LiveUserLogin></Request>
上記の構文中の値はプレースホルダです。ご利用のネットワークに応じて、適切な値に置き換えてください。
ユーザーをサインアウトするには、次の構文を使用します。
<Request><LiveUserLogout><Admin><UserName>admin</UserName><Password>abcd</Password></Admin><UserName>sophos</UserName><IPAddress>192.0.2.1</IPAddress></LiveUserLogout></Request>
上記の構文中の値はプレースホルダです。ご利用のネットワークに応じて、適切な値に置き換えてください。
例
https://<10.21.18.15>:4444/webconsole/APIController?SecureStorageMasterKey=Passw0rd@12345&reqxml=<Request><LiveUserLogin><UserName>admin</UserName><Password>abcd</Password><IPAddress>10.21.18.15</IPAddress><MacAddress>00:0C:29:2D:D3:AC</MacAddress></LiveUserLogin></Request>