カスタム ユーザー グループは、Learn365 API を通じて作成、管理できるグループです。
Microsoft Entraグループとは異なり、カスタム ユーザー グループには、Learn365 と Flow365 の両方のユーザーを含むことができます。
ここでは、Learn365 API を通じたカスタム ユーザー グループの作成と削除について説明します。
カスタム ユーザー グループの作成
API を通じたカスタム ユーザー グループ の作成は、以下の手順に沿って行います。
1. https://api.365.systems/ にアクセスし、APIキーで認証します。
2. Groups セクションに移動し、POST /services/users/Groups Creates the internal group エンドポイントを選択し、右上の「Try it out」を選択します。
3.パラメータを入力します。
body:「Edit Value」フィールドでグループのタイトル(名前)を入力します。タイトルはユニークでなければなりません。つまり、既に存在するカスタム ユーザー グループや Microsoft Entra グループの名前は使用できません。既存のカスタムユーザーグループおよび Microsoft Entra グループのリストは、GET /services/users/Groups Returns the list of active groups で取得できます。
4.「Execute」を選択してリクエストを実行します。
5.Responses ブロックで結果を確認します。
- Code の下の2xx(202など)は、リクエストが正しく動作したことを示します。
- エラーの場合、Response body にはエラー オブジェクトとそのコード、問題を説明するメッセージ キーが含まれます。
カスタム ユーザー グループの削除
カスタム ユーザー グループを削除するには、グループ IDが必要です。
グループ ID は以下の方法で取得することができます。
- カスタム ユーザー グループを作成したときの Response body に、[ID」が含まれています。
- GET /services/users/Groups Returns the list of active groups リクエストを実行します。このリクエストの詳細については、こちらを参照してください。
API を通じたカスタム ユーザー グループ の削除は、以下の手順に沿って行います。
1. https://api.365.systems/ にアクセスし、APIキーで認証します。
2. Groups セクションに移動し、DELETE /services/users/Groups/{groupId} Deletes the group エンドポイントを選択し、右上の「Try it out」を選択します。
3.パラメータを入力します。
- groupId*:「groupId」フィールドに、ユーザーグループの ID を入力します。
4.「Execute」を選択してリクエストを実行します。
5.Responses ブロックで結果を確認します。
- Code の下の2xx(202など)は、リクエストが正しく動作したことを示します。
- エラーの場合、Response body にはエラー オブジェクトとそのコード、問題を説明するメッセージ キーが含まれます。