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

Swagger にアクセスする

If you are using Swagger to try our API, just log in to your Orchestrator instance in a separate tab.

The Orchestrator API Swagger definition can be accessed by adding the /swagger/ui/index#/ suffix to your Orchestrator URL. For example, https://{yourDomain} /swagger/ui/index#/.

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

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

1. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). If the lock is open, you are unauthorized.

   

2. [Authorize] をクリックします。[利用可能な権限] ウィンドウが表示されます。

   注:

   現在サポートされているのは、OAuth2 という認可スキームです。

   

3. Orchestrator API のすべてのエンドポイントを試すことができるように、すべてのスコープが事前に選択されています。特定の API へのアクセスを制限する場合は、該当するスコープをクリアしてください。

4. [Authorize] をクリックします。承認されたことを確認する新しいウィンドウが表示されます。

5. 完了したら、[Close] または [X] をクリックして [Available authorizations] ウィンドウを閉じます。[Authorize] ボタンに閉じたロックが表示され、認可されていることを示します。

要求を送信する

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

1. 操作の実行に使用する Orchestrator API リソースを展開します。閉じたロックは、認可されていることを意味します。

   Figure 1. Unauthorized API resource

   

2. 展開したメソッド ウィンドウで、[Try it out] を選択します。

3. 必要に応じてパラメーター値を指定します。

4. [ 実行] を選択します。要求が実行されます。ベアラー認可ヘッダーは、要求に対して自動的に使用されます。

   Figure 2. Bearer authorization header

   

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

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

1. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). The lock should be closed.

   

2. [Authorize] をクリックし、表示される [Available authorizations] ページで [Logout] をクリックして、期限切れのトークンを取り消します。

   

3. Close the Available authorizations window by clicking Close or X and then obtain an access token as described on the Obtaining an access token section.

アクセスを取り消す

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

1. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). The lock should be closed, meaning you are authorized.
2. [Authorize] をクリックし、表示される [Available authorizations] ページで [Logout] をクリックします。
3. [閉じる] または [X] をクリックして、[使用可能な認可] ウィンドウを閉じます。[Authorize] ボタンには、認可されていないことを意味するオープン ロックが表示されます。