APIサービスを使ってユーザー、ロール、グループを管理 - Cloud

Talend Cloud APIユーザーガイド

Version
Cloud
Language
日本語 (日本)
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
ジョブデザインと開発 > Designing APIs
ジョブデザインと開発 > Testing APIs

Talend Cloud Web APIサービスを使えば、ユーザーの作成、グループへのユーザーの割り当て、ユーザーへのロールの割り当て、ユーザープロファイルの取得というプロセスを自動化できます。

  • このAPIサービスで使われるホストはhttps://api.<env>.cloud.talend.comです。
  • このAPIサービスの全容がわかるAPIドキュメンテーションは、https://api.<env>.cloud.talend.com/v1/management/swagger-ui/?urls.primaryName=Identities%20Managementを参照してください。
<env>にはお使いのクラウドリージョンが入ります。該当のリージョン名が不明な場合は、Talend CloudのリージョンとURLを参照してください。
このユーザー管理APIへのアクセスに必要となる条件:

ユーザー管理のエンドポイント

操作 メソッド リソース 必要な権限
テナント下の全ユーザーを取得 GET

/v1/management/users

[Users - Management] (ユーザー - 管理)
リクエストごとにユーザーを1名作成 POST

/v1/management/users

[Users - Management] (ユーザー - 管理)
特定のユーザーを取得 GET /v1/management/users/<userId> [Users - Management] (ユーザー - 管理)
特定のユーザーの詳細を更新 PUT /v1/management/users/<userId> [Users - Management] (ユーザー - 管理)
特定のユーザーを削除 DELETE /v1/management/users/<userId> [Users - Management] (ユーザー - 管理)
特定のユーザーが所属するグループをリスト表示 GET /v1/management/users/<userId>/groups [Users - Management] (ユーザー - 管理)
指定されたグループに特定のユーザーを追加 POST /v1/management/users/<userId>/groups [Users - Management] (ユーザー - 管理)
特定のグループから特定のユーザーを削除 DELETE

/v1/management/users/<userId>/groups/<groupId>

[Users - Management] (ユーザー - 管理)
特定のユーザーに割り当てられたロールをリスト表示 GET /v1/management/users/<userId>/roles [Users - Management] (ユーザー - 管理)
特定のユーザーにロールを割り当て POST /v1/management/users/<userId>/roles [Users - Management] (ユーザー - 管理)
特定ユーザーのロールを取り消し DELETE /v1/management/users/<userId>/roles/<roleId> [Users - Management] (ユーザー - 管理)

グループ管理のエンドポイント

操作 メソッド リソース 必要な権限
指定されたグループを取得 GET

/v1/management/groups

[Groups - Management] (グループ - 管理)
リクエストごとにグループを1つ作成 POST

/v1/management/groups

[Groups - Management] (グループ - 管理)
特定のグループの詳細を取得 GET /v1/management/groups/<groupId> [Groups - Management] (グループ - 管理)
特定のグループを削除 DELETE /v1/management/groups/<groupId> [Groups - Management] (グループ - 管理)
特定のグループの名前を変更 PATCH /v1/management/groups/<groupId> [Groups - Management] (グループ - 管理)
特定のグループに属するユーザーを取得 GET /v1/management/groups/<groupId>/users [Groups - Management] (グループ - 管理)
指定されたグループにユーザーがまだ存在しない場合はユーザーを追加 POST

/v1/management/groups/<groupId>/users

[Users - Management] (ユーザー - 管理)
特定のグループから特定のユーザーを削除 DELETE /v1/management/groups/<groupId>/users/<userId> [Users - Management] (ユーザー - 管理)

ロール管理のエンドポイント

操作 メソッド リソース 必要な権限
指定されたロールを取得 GET

/v1/management/roles

[Roles - Management] (ロール - 管理)
リクエストごとにロールを1つ作成 POST

/v1/management/roles

[Roles - Management] (ロール - 管理)
ロールをIDで取得 GET /v1/management/roles/<roleId> [Roles - Management] (ロール - 管理)
特定のロールを更新 PUT /v1/management/roles/<roleId> [Roles - Management] (ロール - 管理)
特定のロールを削除 DELETE /v1/management/roles/<roleId> [Roles - Management] (ロール - 管理)
特定のロールが割り当てられたユーザーを取得 GET

/v1/management/roles/<roleId>/users

[Roles - Management] (ロール - 管理)
特定のユーザーにロールを割り当て POST

/v1/management/roles/<roleId>/users

[Users - Management] (ユーザー - 管理)
特定ユーザーのロールを取り消し DELETE /v1/management/roles/<roleId>/users/<userId> [Users - Management] (ユーザー - 管理)