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

Swagger UI インターフェイスを使用して、Orchestrator API 呼び出しを認可およびテストします。

Swagger にアクセスする

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

Orchestrator API Swagger 定義にアクセスするには、Orchestrator の URL にサフィックス /swagger/ui/index#/ を追加します。例: https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_ /swagger/ui/index#/。

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

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

1. Orchestrator API ページの右上隅にある [Authorize] ボタンを探します。ロックが開いている場合は、認可されていません。

   図 1. [Authorize] ボタン

2. [ 承認] を選択します。[利用可能な権限] ウィンドウが表示されます。

   注:

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

   図 2. Available authorizations

   

3. All scopes are preselected such that you can experiment with all endpoints in the Orchestrator API.

Clear them if you want to restrict access to certain APIs. 4. Select Authorize. A new window is displayed confirming you have been authorized. 5. Once done, select Close or X to close the Available authorizations window. The Authorize button shows an closed lock meaning you are authorized.

要求を送信する

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

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

   図 3. 認可されていない API リソース

   

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

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

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

   図 4. ベアラー認可ヘッダー

   

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

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

1. Orchestrator API ページの右上隅にある [Authorize] ボタンを探します。ロックは閉じているはずです。

   図 5. [Authorize] ボタン

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

   図 6. Available authorizations

   

3. [Close] または [X] を選択して [Available authorizations] ウィンドウを閉じ、「アクセス トークンを取得する」セクションの説明に従ってアクセス トークンを取得します。

アクセスを取り消す

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

1. Orchestrator API ページの右上隅にある [Authorize] ボタンを探します。ロックは閉じているはずです。つまり、承認されています。
2. Select Authorize and on the displayed Available authorizations page, Select Logout.
3. [閉じる] または [X] をクリックして、[使用可能な認可] ウィンドウを閉じます。[Authorize] ボタンには、認可されていないことを意味するオープン ロックが表示されます。