orchestrator
2021.10
false
- 基本情報
- 認証
- Swagger の定義
- はじめに
- Swagger での API 呼び出しを認可する
- 論理リソースを管理する
- Orchestrator API
- プラットフォーム管理 API
Swagger での API 呼び出しを認可する
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。
![](https://docs.uipath.com/_next/static/media/grid.05ebd128.png?w=3840&%3Bq=100)
Orchestrator API ガイド
Last updated 2024年6月18日
Swagger での API 呼び出しを認可する
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}/swagger/ui/index#/
)。
注: Swagger 認証は、Orchestrator インスタンスで設定したパラメーターに従って期限切れになります。既定では、この値は 30 分に設定されています。変更するには、
Web.config
ファイルの Auth.Cookie.Expire
パラメーターの値を変更します。
Orchestrator サービスで Swagger UI を介して API 呼び出しを認可するには、次の手順を実行します。
-
Orchestrator API ページの右上隅にある [Authorize] ボタンを探します。ロックが開いている場合は、認可されていません。
-
[Authorize] をクリックします。[Available authorizations] ウィンドウが表示されます。
注: 現在サポートされているのは、OAuth2 という認可スキーム 1 つです。 - Orchestrator API のすべてのエンドポイントを試すことができるように、すべてのスコープが事前に選択されています。特定の API へのアクセスを制限する場合は、該当するスコープをクリアしてください。
- [Authorize] をクリックします。認可されたことを確認する新しいウィンドウが表示されます。
- 完了したら、[Close] または [X] をクリックして [Available authorizations] ウィンドウを閉じます。[Authorize] ボタンに閉じたロックが表示され、認可されていることを示します。
アクセス トークンの期限が切れた場合、「
401: You are not authenticated!
」という応答を受信します。ベアラー認可ヘッダーは要求に対してまだ存在していますが、アクセス トークンは期限切れになっています。この場合、期限切れのトークンを無効にして、新しいアクセス トークンを生成する必要があります。
Swagger UI の操作が完了したら、使用したアクセス トークンを無効にする必要があります。
- Orchestrator API ページの右上隅にある [Authorize] ボタンを探します。ロックは閉じているはずです。つまり、承認されています。
- [Authorize] をクリックし、表示される [Available authorizations] ページで [Logout] をクリックします。
- [Close] または [X] をクリックして [Available authorizations] ウィンドウを閉じます。[Authorize] ボタンに開いているロックが表示され、認可されていないことを示します。