テナント管理APIの概要

Tenant Managerのユーザ インターフェイスの代わりにテナント管理REST APIを使用して、システム管理タスクを実行できます。たとえば、このAPIを使用して処理を自動化したり、ユーザなどの複数のエンティティを迅速に作成したりできます。

テナント管理APIでは、Swaggerオープン ソースAPIプラットフォームを使用します。Swaggerでは、開発者でもそうではないユーザでも、わかりやすいユーザ インターフェイスを利用してAPIを操作できます。Swaggerのユーザ インターフェイスでは、各API処理に関する詳細情報とドキュメントを参照できます。

Swaggerのテナント管理APIに関するドキュメントにアクセスする手順は次のとおりです。

  1. Tenant Managerにサインインします。
  2. Webアプリケーション ヘッダーで[Help] > [API Docs]を選択します。


    [API Docs]メニュー項目にアクセスする方法を示すスクリーンショット

API処理

テナント管理APIでは、使用できるAPI処理が次のセクションに分類されます。

処理の詳細

各API処理を展開表示すると、HTTPアクション、エンドポイントURL、必須またはオプションのパラメータのリスト、要求の本文の例(必要な場合)、想定される応答を確認できます。


Swagger APIでのGET groups処理を示す例

API要求の実行

注意:Swaggerユーザ インターフェイスを使用して実行するAPI処理はすべてライブ処理です。設定やその他のデータを誤って作成、更新、または削除しないように注意してください。
手順
  1. HTTPアクションをクリックし、要求の詳細を表示します。
  2. グループやユーザのIDなど、要求で追加のパラメータが必要かどうかを確認します。次に、それらの値を取得します。必要な情報を取得するために、先に別のAPI要求の実行が必要な場合もあります。
  3. 要求の本文の例を変更する必要があるかどうかを確認します。変更する場合は、[Model]をクリックすると各フィールドの要件を確認できます。
  4. [Try it out]をクリックします。
  5. 必須パラメータを指定するか、必要に応じて要求の本文を変更します。
  6. [Execute]をクリックします。
  7. 応答コードをチェックし、要求が正常に完了したかどうかを確認します。