【API】 カスタム ユーザーグループの所有者の追加

  • 更新

Learn365 APIを使用して、カタログ管理者をカスタム ユーザーグループの所有者として追加することができます。

LMS 管理者は、組織内のすべてのカスタム ユーザーグループを管理できますが、カタログ管理者が管理できるのは、自分が所有しているカスタム ユーザーグループのみです。

このガイドの最後に、カタログ管理者が利用できる操作のリストを掲載しています。

ここでは、新規または既存のカスタム ユーザーグループに所有者を追加する方法を説明します。

カタログ 管理者のユーザー ID

カタログ管理者をカスタム ユーザーグループの所有者として追加するには、カタログ管理者のユーザー ID が必要です。

カタログ管理者のユーザー ID は、こちら手順で取得できます。

 

新しいカスタム ユーザーグループに所有者を追加する

この操作に必要なロール:LMS管理者 または カタログ管理者

API で新しいカスタム ユーザーグループの作成する際に所有者を追加するには、こちらをご参照ください。

 

既存のカスタム ユーザーグループに所有者を追加する

この操作に必要なロール:・LMS管理者 または グループの所有者である カタログ管理

事前準備

既存のカスタム ユーザーグループに所有者を追加するには、対象となるユーザー グループのグループ IDが必要です。

また、すでに所有者が設定されているかどうかも確認します。

手順:

1.https://api.365.systems/  にアクセスし、API キーで認証します。

2.Groups セクションに移動し、 GET /services/users/v2/Groups Returns the list of active groups エンドポイントを選択し、右上の[Try it out]をクリックします。

3.必要に応じて、クエリパラメータを入力し、レスポンスを絞り込みます。

4.[Execute]を選択してリクエストを実行します。

5.Responses ブロックで結果を確認します。

  • Code 2xx(例:200)は、リクエストが正しく動作したことを示します。
  • 1 回のレスポンスで取得できるユーザーグループは最大 100 件です。
  • 各ユーザーグループで、次のパラメータを確認します。 
    • id:ユーザーグループの ID
    • ownerIds:ユーザー グループの所有者の ID リスト※所有者がいない場合、このリストは空になります。

所有者の追加

既存のカスタム ユーザーグループにオーナーを追加します。

手順:

1.https://api.365.systems/  にアクセスし、API キーで認証します。

2.Groups セクションに移動し、 PUT/services/users/v2/Groups/{groupId} Updates the group エンドポイントを選択し、右上の[Try it out]をクリックします。

3.パラメータを入力します。

  • groupId:「The internal ID of the group 」フィールドに、対象のカスタム ユーザーグループの ID を入力します。
  • body:「Edit Value」フィールドに、以下を入力します。
  • "title": "string":ユーザーグループの名称。現在の名称をそのまま維持したい場合は既存の名称を入力し、変更したい場合は新しい名称を入力します。名称は一意である必要があり、既存のカスタ ムユーザーグループや Microsoft Entra グループと重複することはできません。既存のグループのリストは、GET /services/users/v2/Groups で取得できます。
  • "ownerIds":[配列] ユーザーグループの所有者となるカタログ管理者のユーザー ID のリスト。※注意:ここで指定した所有者にすべて置き換えられます。既存の所有者をそのまま維持する場合、そのユーザー ID も入力します。

例:

{
"title": "Sound Engineers",
"ownerIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fa35cdf2-75bd-40b0-ac0d-b5ca7bfde448" 
]
}

 

4.[Execute]を選択してリクエストを実行します。

5.Responses ブロックで結果を確認します。

  • Code 200 は、リクエストが正しく動作したことを示します。
  • エラーの場合、Response body にはエラー オブジェクトとそのコード、問題を説明するメッセージ キーが含まれます。

 

ユーザーグループの所有者が実行できる操作

すべてのカタログ管理者が利用可能な操作(所有者であるかどうかは不問)

カスタムユーザーグループの所有者であるカタログ管理者が利用可能な操作