Orchestrator
最新
偽
- 基本情報
- Swagger 定義
- Swagger での API 呼び出しを認可する
- 論理リソースを管理する
- Orchestrator API の使用例
Orchestrator API ガイド
最終更新日 2024年3月21日
Swagger での API 呼び出しを認可する
Swagger UI を介して Automation Cloud の Orchestrator サービスに対する API 呼び出しを認可するには、次の手順を実行します。
-
Orchestrator API ページ (
{organization_name}/{tenant_name}/orchestrator_/swagger
) の右上隅にある [Authorize] ボタンを探します。ロックが開いている場合は、認可されていません。 -
[Authorize] をクリックします。[Available authorizations] ウィンドウが表示されます。
注: 現在サポートされているのは、OAuth2 という認可スキーム 1 つです。 - Orchestrator API のすべてのエンドポイントを試すことができるように、すべてのスコープが事前に選択されています。特定の API へのアクセスを制限する場合は、該当するスコープをクリアしてください。
- [Authorize] をクリックします。認可されたことを確認する新しいウィンドウが表示されます。
- 完了したら、[Close] または [X] をクリックして [Available authorizations] ウィンドウを閉じます。[Authorize] ボタンに閉じたロックが表示され、認可されていることを示します。
アクセス トークンの期限が切れた場合、「
401: You are not authenticated!
」という応答を受信します。ベアラー認可ヘッダーは要求に対してまだ存在していますが、アクセス トークンは期限切れになっています。この場合、期限切れのトークンを無効にして、新しいアクセス トークンを生成する必要があります。
Swagger UI の操作が完了したら、使用したアクセス トークンを無効にする必要があります。
- Orchestrator API ページ (
{organization_name}/{tenant_name}/orchestrator_/swagger
) の右上隅にある [承認] ボタンを探します。ロックは閉じているはずです。つまり、承認されています。 - [Authorize] をクリックし、表示される [Available authorizations] ページで [Logout] をクリックします。
- [Close] または [X] をクリックして [Available authorizations] ウィンドウを閉じます。[Authorize] ボタンに開いているロックが表示され、認可されていないことを示します。