【API】カスタムユーザーグループへのユーザーの追加または削除

カスタムユーザーグループとは、Learn365 API または Learn365 管理センターを通じて作成、管理できるグループのことです。

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

ここでは、API を通じてカスタムユーザーグループにユーザーを追加、またはグループからユーザーを削除する方法を説明します。

事前の準備

カスタムユーザーグループにユーザーを追加、またはグループからユーザーを削除するには、以下の情報が必要です。

また、カスタムユーザーグループの既存のメンバーを確認しておくこともお勧めします。グループのメンバーは Learn365 管理センターで確認することもできます。

API を通じて確認するには、

2． Groups セクションに移動し、GET /services/users/Groups/{groupId}/members Returns the list of active group members エンドポイントを選択し、右上の［Try it out］をクリックします。

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

必要に応じて、クエリオプションパラメータを設定し、レスポンスデータを絞り込むことができます。

4．［Execute］を選択してリクエストを実行します。

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

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

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

2．Groups セクションに移動し、POST /services/users/Groups/{groupId}/members Adds the list of users to the group を選択し、右上の［Try it out］を選択します。

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

Add custom user group via API-1.png

4．［Execute］を選択してリクエストを実行します。

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

カスタムユーザーグループからユーザーを削除する場合、削除するユーザーの数によって使用するエンドポイントが異なります。

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

1人のユーザー削除する場合：DELETE /services/users/Groups/{groupId}/members/{userId} Removes the user from the group を選択し、右上の［Try it out］をクリックします。このエンドポイントでは、「groupId」フィールドにユーザーグループ ID 、「userId」フィールドにユーザー ID を入力します。
複数のユーザーを削除する場合：DELETE /services/users/Groups/{groupId}/members Removes the list of users from the group を選択し、右上の［Try it out］をクリックします。このエンドポイントでは、「groupId」フィールドにユーザーグループ ID を入力し、「body」にフィールドにグループから削除するユーザーの ID を入力します。

複数のユーザー削除の例

Add custom user group via API-2.png

3．［Execute］を選択してリクエストを実行します。

4．Responses ブロックで結果を確認します。