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

  • 更新

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

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

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

 目次

 

事前の準備

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

  • ユーザー ID:ユーザー ID の取得については、こちらを参照してください。
  • ユーザーグループ ID:ユーザー グループ ID の取得については、こちらを参照してください。

また、すでにカスタム ユーザー グループに属しているユーザーを確認しておくことも重要です。

API経由でこれを行うには

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

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

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

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

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

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

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

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

カスタム ユーザー グループ にユーザーを追加する

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.パラメータを入力します。

  • groupId:「groupIdフィールドに、ユーザーグループの ID を入力します。
  • body:「Edit Value」フィールドで、グループに追加するユーザーの ID を入力します。

Add custom user group via API-1.png

 

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

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

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

 

カスタム ユーザー グループ からユーザーを削除する

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

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

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

2.Groups セクションに移動し、

  • 1人のユーザー削除する場合:DELETE /services/users/Groups/{groupId}/members/{userId} Removes the user from the group を選択します。このエンドポイントでは、「groupId」フィールドにユーザー グループ ID を、「userId」フィールドにユーザー ID を入力します。

  • 複数のユーザーを削除する場合DELETE /services/users/Groups/{groupId}/members Removes the list of users from the group を選択します。このエンドポイントでは、「groupId」フィールドにユーザーグループ ID を入力し、「body」に、グループから削除するユーザーの ID を入力します。

複数のユーザー削除の例

Add custom user group via API-2.png

 

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

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

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