API による カスタム ユーザー グループ の作成と削除

  • 更新

カスタム ユーザー グループは、Learn365 API を通じて作成、管理できるグループです。

Microsoft Entra グループとは異なり、カスタム ユーザー グループには、Learn365 と Flow365 の両方のユーザーを含むことができます。

ここでは、Learn365 API を通じたカスタム ユーザー グループの作成と削除について説明します。

カスタム ユーザー グループの作成

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

API を通じたカスタム ユーザー グループ の作成は、以下の手順に沿って行います。

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

2. Groups セクションに移動し、POST /services/users/v2/Groups Creates the internal group エンドポイントを選択し、右上の「Try it out」をクリックします。

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

body:「Edit Value」フィールドで以下を入力します。

  • title:グループの名前。名前はユニークでなければなりません。つまり、既に存在するカスタム ユーザー グループや Microsoft Entra グループの名前は使用できません。既存のカスタムユーザーグループおよび Microsoft Entra グループのリストは、GET /services/users/v2/Groups Returns the list of active groupsups で取得できます。このフィールド入力必須です。
  • ownerIds:このフィールドの入力は任意です。カタログ 管理者のユーザー ID を入力して、カスタム ユーザー グループの所有者を指定します。LMS 管理者は組織内のすべてのカスタム ユーザー グループを管理できますが、カタログ管理者は自分が所有するカスタム ユーザー グループだけを管理できます。グループの所有者とその権限については、こちらの記事を参照してください。

body の記述例


{

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

 

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

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

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

カスタム ユーザー グループの削除

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

カスタム ユーザー グループを削除するには、グループ IDが必要です。

グループ ID は以下の方法で取得することができます。

  • カスタム ユーザー グループを作成したときの Response body で「ID」を見つけます。
  • GET /services/users/v2/Groups Returns the list of active groupsups リクエストで取得できます。このリクエストの詳細については、こちらをご参照ください。

 API を通じたカスタム ユーザー グループ の削除は、以下の手順に沿って行います。

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

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

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

  • groupId:「groupIdフィールドに、ユーザーグループの ID を入力します。このフィールド入力必須です。

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

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

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