Swagger での API 呼び出しを認可する

Swagger にアクセスする

Orchestrator API Swagger にアクセスするには、Orchestrator URL に /swagger/index.html を追加します (例: https://{yourDomain}/swagger/index.html)。

Swagger で表示される API は、使用する Orchestrator インスタンスによって異なります。Swagger で直接簡単に要求を行うには、別のタブで Orchestrator にログインします。

アクセストークンを取得する

Orchestrator インスタンスで Swagger UI を介して API 呼び出しを認可するには、次の手順を実行します。

Orchestrator API ページ (OrchestratorURL/swagger) の右上隅にある [Authorize] ボタンを探します。ロックが開いている場合は、認可されていません。
[Authorize] をクリックします。[Available authorizations] ウィンドウが表示されます。

注: 現在サポートされているのは、OAuth2 という認可スキーム 1 つです。
Orchestrator API のすべてのエンドポイントを試すことができるように、すべてのスコープが事前に選択されています。特定の API へのアクセスを制限する場合は、該当するスコープをクリアしてください。
[Authorize] をクリックします。認可されたことを確認する新しいウィンドウが表示されます。
完了したら、[Close] または [X] をクリックして [Available authorizations] ウィンドウを閉じます。[Authorize] ボタンに閉じたロックが表示され、認可されていることを示します。

要求を送信する

認可されている間に、以下の方法で Orchestrator API リソースに要求を送信できます。

操作の実行に使用する Orchestrator API リソースを展開します。閉じたロックは、認可されていることを意味します。
展開したメソッドウィンドウで、[Try it out] をクリックします。
必要に応じてパラメーター値を指定します。
[Execute] をクリックします。要求が実行されます。ベアラー認可ヘッダーが自動的に要求に使用されます。

新しいアクセストークンを生成する

アクセストークンの期限が切れた場合、「401: You are not authenticated!」という応答を受信します。ベアラー認可ヘッダーは要求に対してまだ存在していますが、アクセストークンは期限切れになっています。この場合、期限切れのトークンを無効にして、新しいアクセストークンを生成する必要があります。

Orchestrator API ページ (OrchestratorURL/swagger) の右上隅にある [承認] ボタンを探します。ロックは閉じているはずです。
[Authorize] をクリックし、表示される [Available authorizations] ページで [Logout] をクリックして、期限切れのトークンを取り消します。
[Close] または [X] をクリックして [Available authorizations] ウィンドウを閉じ、「アクセストークンを取得する」セクションの説明に従ってアクセストークンを取得します。

アクセスを取り消す

Swagger UI の操作が完了したら、使用したアクセストークンを無効にする必要があります。

Orchestrator API ページ (OrchestratorURL/swagger) の右上隅にある [承認] ボタンを探します。ロックは閉じているはずです。つまり、承認されています。
[Authorize] をクリックし、表示される [Available authorizations] ページで [Logout] をクリックします。
[Close] または [X] をクリックして [Available authorizations] ウィンドウを閉じます。[Authorize] ボタンに開いているロックが表示され、認可されていないことを示します。