ユーザー管理

使用可能な機能

プラットフォーム管理 API により、プラットフォームの以下の機能が公開されます。

管理シナリオ	認証方法
ユーザー管理 — ユーザーまたはグループの作成、更新、削除、および組織設定の管理	外部アプリケーション

ベース URL

すべてのプラットフォーム管理 API 呼び出しは、ベース URL への HTTP メソッドを使用して実行されます。

https プロトコルを使用し、API 呼び出しを介して送信するデータを暗号化することをお勧めします。

注:

Automation Cloud および Automation Suite のデプロイの場合、Identity Server のすべての URL に /identity_ というセグメントが含まれます。
スタンドアロンデプロイの場合、Identity Server のすべての URL に /identity というセグメントが含まれます。

リソースリスト

プラットフォーム管理 API により、アプリケーションで以下のリソースを制御できます。

ユーザー管理

監査

GET {BaseURL}/identity/api/AuditQuery/{organizationId} - 指定した組織 ID の監査ログを取得します。
GET {BaseURL}/identity/api/AuditQuery/{organizationId}/download - 指定した組織 ID の監査ログをダウンロードします。

グループ

GET {BaseURL}/identity/api/Group/{partitionGlobalId} - 指定したパーティション ID (組織またはテナント) からすべてのローカルグループと組み込みグループを取得します。
GET {BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId} - 指定したパーティション ID 内の指定したローカルグループまたは組み込みグループを取得します。
POST {BaseURL}/identity/api/Group - 新しいローカルグループを作成します。
PUT {BaseURL}/identity/api/Group/{groupId} - ローカルグループの情報を更新します。
DELETE {BaseURL}/identity/api/Group/{partitionGlobalId} - 指定したパーティション ID (組織またはテナント) からすべてのローカルグループを削除します。
DELETE {BaseURL}/identity/api/Group/{partitionGlobalId}/{groupId} - 指定したローカルグループを削除します。

メッセージテンプレート

GET {BaseURL}/identity/api/MessageTemplate - 指定したフィルターを使用してメッセージテンプレートを取得します。
GET {BaseURL}/identity/api/MessageTemplate/{templateId} - 指定したメッセージテンプレートを取得します。
PUT {BaseURL}/identity/api/MessageTemplate/{templateId} - 指定したメッセージテンプレートを更新します。

ロボットアカウント

GET {BaseURL}/identity/api/RobotAccount/{partitionGlobalId} - 指定したパーティション ID (組織またはテナント) 内のすべてのロボットアカウントを取得します。
GET {BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId} - 指定したパーティション ID 内の指定したロボットアカウントを取得します。
POST {BaseURL}/identity/api/RobotAccount - 新しいロボットアカウントを作成します。
PUT {BaseURL}/identity/api/RobotAccount/{robotAccountId} - 指定したロボットアカウント情報を更新します。
DELETE {BaseURL}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId} - 指定したロボットアカウントを削除します。
DELETE {BaseURL}/identity/api/RobotAccount/{partitionGlobalId} - 指定したパーティション ID 内のすべてのロボットアカウントを削除します。

設定

GET {BaseURL}/identity/api/Setting - 特定のテナントのキーのリストに基づいてアプリケーション設定を取得します。
PUT {BaseURL}/identity/api/Setting - 特定のテナントで設定を更新するか、新しい設定を作成します。

ユーザー (User)

GET {BaseURL}/identity/api/User/{userId} - 指定したユーザーの情報を取得します。
POST {BaseURL}/identity/api/User - 新規ユーザーを作成します。このエンドポイントはべき等です。ユーザーを上書きしようとすると、既存のユーザーは削除されます。
POST {BaseURL}/identity/api/User/BulkCreate - ユーザーを一括作成します。
POST {BaseURL}/identity/api/User/{userId}/changepassword - 指定したユーザーのパスワードを更新します。
PUT {BaseURL}/identity/api/User/{userId} - 指定したユーザーの情報を更新します。
DELETE {BaseURL}/identity/api/User - すべてのユーザーを削除します。
DELETE {BaseURL}/identity/api/User/{userId} - 指定したユーザーを削除します。

UserLoginAttempt

GET {BaseURL}/identity/api/User/{userId}/loginAttempts - 指定したユーザーのログイン試行を取得します。

API リソースごとのスコープ

スコープでは、プラットフォーム管理リソースに対するアプリケーションレベルのアクセス権を定義します。

たとえば、アプリケーションの認証トークンを生成するには、複数のスコープを渡します。アプリケーションがリソースにアクセスするために API 呼び出しを行うと、トークンがリソーススコープに対して検証されます。トークン要求で渡したスコープにリソースが含まれていれば呼び出しは成功し、続いてエンドポイントごとにユーザー権限が確認されます (GET 要求の場合は読み取り権限、POST、PUT、DELETE 要求の場合は書き込み権限)。権限がない場合、応答は拒否されます。

エンドポイントごとの権限

権限では、アプリケーションのユーザーにリソース内の特定の機能に対するアクセス権を付与します。権限はそれぞれ 1 つのスコープにリンクしています。アプリケーションがリソースに正常にアクセスした後、認証されたユーザーがエンドポイントの対応するメソッドに対して適切な権限を持っているかどうかがサーバーで確認されます。

たとえば、一部のユーザーに対し、ユーザーグループの削除または更新を制限しながら、表示は許可することができます。

一般的に、GET メソッドには読み取り権限が必要であるのに対し、POST、PUT、DELETE メソッドには書き込み権限が必要です。

スコープと権限のリスト

ユーザー管理

以下の表は、特定のアクションを実行するために必要なスコープと権限をまとめたものです。

リソース	スコープ	権限
監査クエリ	PM.Audit	PM.Audit.Read (GET 要求の場合)
グループ	PM.Group	PM.Group.Read (GET 要求の場合) PM.Group.Write (POST、PUT、DELETE 要求の場合)
メッセージテンプレート	PM.MessageTemplate	PM.MessageTemplate.Read (GET 要求の場合) PM.MessageTemplate.Write (for PUT requests)
ロボットアカウント	PM.RobotAccount	PM.RobotAccount.Read (GET 要求の場合) PM.RobotAccount.Write (POST、PUT、DELETE 要求の場合)
設定	PM.Setting	PM.Setting.Read (GET 要求の場合) PM.Setting.Write (PUT 要求の場合)
ユーザー (User)	PM.User	PM.User.Read (GET 要求の場合) PM.User.Write (POST、PUT、DELETE 要求の場合)
UserLoginAttempt	PM.UserLoginAttempt	PM.UserLoginAttempt.Read (GET 要求の場合)