- 基本情報
- 認証
- Swagger の定義
- はじめに
- Swagger での API 呼び出しを認可する
- 論理リソースを管理する
- Orchestrator API
- プラットフォーム管理 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#/.
The Swagger authentication expires according to the parameters set in your Orchestrator instance. By default, it is set to 30 minutes. You can change it by modifying the value of the Auth.Cookie.Expire parameter, in the Web.config file.
アクセス トークンを取得する
Orchestrator サービスで Swagger UI を介して API 呼び出しを認可するには、次の手順を実行します。
-
Orchestrator API ページの右上隅にある [Authorize] ボタンを探します。ロックが開いている場合は、認可されていません。
-
[Authorize] をクリックします。[利用可能な権限] ウィンドウが表示されます。
注:現在サポートされているのは、OAuth2 という認可スキームです。
-
Orchestrator API のすべてのエンドポイントを試すことができるように、すべてのスコープが事前に選択されています。特定の API へのアクセスを制限する場合は、該当するスコープをクリアしてください。
-
[Authorize] をクリックします。承認されたことを確認する新しいウィンドウが表示されます。
-
完了したら、[Close] または [X] をクリックして [Available authorizations] ウィンドウを閉じます。[Authorize] ボタンに閉じたロックが表示され、認可されていることを示します。
要求を送信する
認可されている間に、以下の方法で Orchestrator API リソースに要求を送信できます。
-
操作の実行に使用する Orchestrator API リソースを展開します。閉じたロックは、認可されていることを意味します。
-
展開したメソッド ウィンドウで、[Try it out] をクリックします。
-
必要に応じてパラメーター値を指定します。
-
[ 実行] をクリックします。要求が実行されます。ベアラー認可ヘッダーは、要求に対して自動的に使用されます。
新しいアクセス トークンを生成する
アクセス トークンの期限が切れた場合、「401: You are not authenticated!」という応答を受信します。ベアラー認可ヘッダーは要求に対してまだ存在していますが、アクセス トークンは期限切れになっています。この場合、期限切れのトークンを無効にして、新しいアクセス トークンを生成する必要があります。
-
Orchestrator API ページの右上隅にある [Authorize] ボタンを探します。ロックは閉じているはずです。
-
[Authorize] をクリックし、表示される [Available authorizations] ページで [Logout] をクリックして、期限切れのトークンを取り消します。
-
[Close] または [X] をクリックして [Available authorizations] ウィンドウを閉じ、「アクセス トークンを取得する」セクションの説明に従ってアクセス トークンを取得します。
アクセスを取り消す
Swagger UI の操作が完了したら、使用したアクセス トークンを無効にする必要があります。
- Orchestrator API ページの右上隅にある [Authorize] ボタンを探します。ロックは閉じているはずです。つまり、承認されています。
- [Authorize] をクリックし、表示される [Available authorizations] ページで [Logout] をクリックします。
- [閉じる] または [X] をクリックして、[使用可能な認可] ウィンドウを閉じます。[Authorize] ボタンには、認可されていないことを意味するオープン ロックが表示されます。