特権APIを使用したESAユーザロールAPIの取得

概要

このドキュメントでは、/esa/api/v2.0/login/privilegesエンドポイントを使用して、認証済みESAロールの特権情報を取得する方法について説明します。

環境

• Python 3.x
• Python要求ライブラリがインストールされている
• 管理インターフェイスでAPIサービスが有効になっており、APIポートが設定されたEメールセキュリティアプライアンス(ESA)

解決方法

1. 管理インターフェイスでESA APIサービスが有効になっていることを確認します。
2. ESAで設定されているAPIポートを確認し、スクリプトで同じポート値を使用します。
3. APIのコールに使用されるアカウントの認証ヘッダー値と有効なESAセッションCookieを取得します。
4. 必要に応じて、必要な依存関係をインストールします。

   pip install requests

5. スクリプト変数ESA IP address、API port、およびauthentication valuesを更新し、スクリプトを実行します。

注:ESAで設定されているAPIポートを使用します。スクリプトとスクリーンショットの間でポート値の一貫性を維持します。

応答の解釈

/login/privileges 応答は、認証されたセッションに付与される特権を表します。返された権限リストを使用して、現在のユーザロールで使用可能なAPIリソースと操作を判別します。

JSONペイロードで、data.privilegesを確認します。各エントリには、リソースのパスと、そのリソースに許可されているHTTP メソッドがリストされます。

関連コンテンツ

2)インストール要求（デフォルトではPythonと一緒にインストールされません）。 コマンドプロンプトから次のコマンドを実行します。

pip install requests

requestsを使用すると、PythonからHTTP要求を送信できます。

3) pprintはPython （標準ライブラリ）に含まれています。 インストールは必要ありません。

pprintモジュールは、インタプリタへの入力として使用できる形式で任意のPythonデータ構造をプリティプリントし、読み取り可能な形式で表示する機能を提供します。このモジュールはオプションです。スクリプトは代わりにprintを使用できますが、出力は読みにくくなります。

 JSONは標準ライブラリの一部であるため、個別にインストールする必要はありません。

問題

認証ユーザロールにアクセスできるCisco Eメールセキュリティアプライアンス(ESA)のAPIを特定します。

原因

ESAでのAPIアクセスは、認証されたセッションとロールに割り当てられた権限によって制御されます。/esa/api/v2.0/login/privilegesエンドポイントから有効な特権リストが返されるので、どのAPIリソースとHTTPメソッドが現在のユーザに対して許可されているかがわかります。

予想される結果

/esa/api/v2.0/login/privilegesに対するGET要求が成功すると、HTTP 200 OKと、認証されたセッションで使用可能な特権（APIアクセス）を一覧表示するJSONペイロードが返されます。返されたJSONを確認して、そのロールに対して許可されているAPIリソースと操作を特定します。

解決方法

手順

import requests
import json
import pprint

url = "https://192.0.2.10:6080/esa/api/v2.0/login/privileges"
headers = {
"Authorization": "Basic ",
    "Cookie": ""
}

response = requests.request("GET", url, headers=headers, verify=True)
json_string = json.loads(response.content)
pprint.pprint(json_string)

出力例

出力例：

{
  "data": {
    "privileges": [
      {
        "resource": "/esa/api/v2.0/login/privileges",
        "methods": ["GET"]
      }
    ]
  }
}

特権リストを確認して、認証されたセッションに対して許可されるAPIリソースおよびHTTPメソッドを特定します。

更新履歴

改定	発行日	コメント
1.0	01-Oct-2026	初版