OpenAPI 認証
OpenAPI はダイジェスト ベースの認証方式を使用します。ワークフローは次のようになります。
-
Secure Workload UI ダッシュボードにログインします。
-
目的の機能を使用して API キーと API 秘密を生成します。
-
JSON 形式で REST 要求を送信するには、Secure Workload API SDK を使用します。
-
Python SDK を使用するには、
pip install tetpyclient
を使用して SDK をインストールします。 -
Python sdk をインストールしたら、RestClient をインスタンス化するためのいくつかの定型コードを次に示します。
from tetpyclient import RestClient
API_ENDPOINT="https://<UI_VIP_OR_DNS_FOR_TETRATION_DASHBOARD>"
# ``verify`` は、SSL サーバー認証を無効にするオプションのパラメータです。
# デフォルトでは、クラスタダッシュボード IP は、自己署名された証明書を使用します。
# 展開。そのため、「verify = False」を使用してサーバを無効にすることができます。
# API クライアントの SSL での認証。ユーザーが自身をアップロードした場合
# クラスタへの証明書([プラットフォーム(Platform)] > [SSL証明書(SSL Certificate)] から)
# エンタープライズ CA によって署名された後、サーバー側の認証
# 有効にする必要があります。このようなシナリオでは、コード verify=False
# は verify="path-to-CA-file" に置き換える必要があります。
# credentials.json は次のようになります。
# {
#"api_key": "<hex string>",
#"api_secret": "<hex string>"
# }
restclient = RestClient(API_ENDPOINT,
credentials_file='<path_to_credentials_file>/credentials.json',
verify=False)
# API 呼び出しの後に、エージェントのリストを取得する API などがあります。
# API は passed /openapi/v1/sensors または just /sensors です。
resp = restclient.get('/roles')
API キーと秘密の生成
手順
ステップ 1 |
Secure Workload のWeb インターフェイスで、ウィンドウの右上隅にある人のアイコンをクリックし、[APIキー(API Keys)] を選択します。 |
||
ステップ 2 |
[API キーの作成(Create API Key)] をクリックします。 |
||
ステップ 3 |
キーと秘密に必要な機能を指定します。ユーザーは、API キー + 秘密のペアの使用を予定している機能の制限設定を選択する必要があります。ユーザーが使用できる API 機能は、ユーザーのロールによって異なります。たとえば、サイト管理者ユーザーは、ソフトウェア エージェントを管理するためのキーを生成できますが、この機能は非サイト管理者ユーザーには使用できません。 API 機能には次のものがあります。
|
||
ステップ 4 |
[作成(Create)] をクリックします。 |
||
ステップ 5 |
キーと秘密をコピーして貼り付け、安全な場所に保存します。または、API クレデンシャル ファイルをダウンロードします。
|