セッションベースの認証ではなく、トークンを使用して Orchestrator API にアクセスできます。オペレータ スーパー ユーザーは、API トークンを管理できます。ユーザーに対して複数の API トークンを作成できます。
注： エンタープライズ読み取り専用ユーザーと MSP ビジネス スペシャリスト ユーザーの場合、トークンベースの認証は有効になっていません。
デフォルトでは、API トークンは有効になっています。これらを無効にするには、オペレータ ポータルの
[システム プロパティ (System Properties)] に移動し、システム プロパティ
session.options.enableApiTokenAuth の値を
[False] として設定します。
注： オペレータ スーパー ユーザーは、API トークンを介した不正アクセスを防ぐために、非アクティブな ID プロバイダ (IdP) ユーザーを Orchestrator から手動で削除する必要があります。
ユーザーは、ロールに基づいてトークンの作成、取り消し、およびダウンロードを行うことができます。
API トークンを管理するには、次の手順を実行します。
- オペレータ ポータルで、 の順に移動します。
- ユーザーを選択して、[変更 (Modify)] をクリックするか、ユーザー名へのリンクをクリックします。[API トークン (API Tokens)] セクションに移動します。
- [新規 API トークン (New API Token)] をクリックします。
- [新規トークン (New Token)] 画面で、トークンの [名前 (Name)] と [説明 (Description)] を入力してから、ドロップダウン メニューから [有効期間 (Lifetime)] を選択します。
- [保存 (Save)] をクリックします。新しいトークンが [API トークン (API Tokens)] テーブルに表示されます。最初に、トークンの状態は [保留中 (Pending)] として表示されます。ダウンロードすると、状態が [有効 (Enabled)] に変わります。
- トークンをダウンロードするには、トークンを選択してから、[API トークンをダウンロード (Download API Token)] をクリックします。
- トークンを無効にするには、トークンを選択し、[API トークンを取り消す (Revoke API Token)] をクリックします。トークンの状態は [取り消し済み (Revoked)] として表示されます。
- [CSV] をクリックして、.csv ファイル形式の API トークンの完全リストをダウンロードします。
- トークンの有効期間が過ぎると、状態は [期限切れ (Expired)] に変わります。
注： トークンに関連付けられているユーザーのみがトークンをダウンロードでき、ダウンロード後にトークンの ID のみが表示されます。トークンをダウンロードできるのは 1 回だけです。トークンをダウンロードすると、ユーザーは、それを Orchestrator API にアクセスするための要求の認証ヘッダーの一部として送信できます。
次の例は、API にアクセスするコードのサンプル スニペットを示しています。
curl -k -H "Authorization: Token <Token>"
-X POST https://vco/portal/
-d '{ "id": 1, "jsonrpc": "2.0", "method": "enterprise/getEnterpriseUsers", "params": { "enterpriseId": 1 }}'
同様に、追加のプロパティを設定し、パートナー管理者、エンタープライズ カスタマー、およびパートナー カスタマーの API トークンを作成できます。詳細については、以下を参照してください。
- 『VMware SD-WAN 管理ガイド』の「ユーザー」トピック
- 『VMware SD-WAN パートナー ガイド』の「ユーザー」トピック
[API トークン (API Tokens)] セクションで使用可能なその他のオプションは次のとおりです。
| オプション | 説明 |
|---|---|
| 検索 (Search) | 検索語句を入力して、テーブル全体で一致するテキストを検索します。詳細検索オプションを使用して、検索結果を絞り込みます。 |
| 列 (Columns) | ページで表示または非表示にする列をクリックして選択します。 |
| 更新 (Refresh) | クリックしてページを更新し、最新のデータを表示します。 |
