API による Microsoft Entra / カスタム ユーザー グループの可視性の制限

  • 更新

API を通じて Learn365 管理センターでグループとそのユーザーの可視性と可用性を設定できます。

この設定により、たとえば、ユーザーをトレーニングに登録するとき、ピープル ピッカー(「ユーザーまたはグループ」フィールド)で特定の Microsoft Entra(Azure Active Directory)またはカスタム ユーザー グループのユーザーだけが選択可能となります。

制限は必要に応じて、Microsoft Entra(Azure Active Directory)またはカスタム ユーザー グループに適用できます。適用するグループの数に上限はありません。

この制限を使用して、特定のグループのユーザーを、特定のコースカタログだけで選択できるようにすることもできます。

注記:

1つのテナント内に複数の組織(環境)設定した場合、API によるグループ制限を使用して、環境間でユーザーの可視性を制御できます。詳細については、「1つのテナント内の複数環境(組織)に対する制限の追加」をご参照ください。

この制限は、グループのオブジェクト ID またはグループ ID を制限リストに追加し、グループ制限をオンにすることで設定することができます。

 

グループ制限とピープルピッカー

グループ制限がオンの場合、Learn365 管理センターのピープルピッカーでは、制限リストに含まれるグループからのユーザーだけを選択することができます。

つまり、次のようなとき、ピープルピッカーには環境の制限リストに含まれる特定の Microsoft Entra(Azure Active Directory)またはカスタム ユーザー グループからのユーザーだけが表示されます。

  • グローバル設定> LMS 管理者 を追加するとき
  • トレーニングにユーザーを登録するとき
  • コースカタログにユーザーを追加するとき

グループ制限リストへの追加

オブジェクト ID を使用する

Microsoft Entra(Azure Active Directory)グループのオブジェクト ID を使用して、グループ制限リストに追加することができます。

グループのオブジェクト ID は、Microsoft Entra 管理センターで見つけることができます。

特定のコースカタログにグループ制限を適用する場合は、コースカタログ ID が必要です。コースカタログ ID の取得は、こちらをご参照ください。

オブジェクト ID でグループ制限リストに Microsoft Entra(Azure Active Directory)グループを追加するには、

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

2.GroupRestrictions セクションに移動し、POST /groupRestrictions/addADGroup エンドポイントを選択し、右上の「Try it out」をクリックします。

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

  • objectId:Microsoft Entra(Azure Active Directory)グループのオブジェクト ID を入力します。(このパラメータは入力必須です。)
  • courseCatalogId:特定のコースカタログに限定する場合は、コースカタログ ID を入力します。(このパラメータは任意です。)
    このフィールドが空の場合、グループ制限は環境全体に適用されます。

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

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

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

グループ ID を使用する

Microsoft Entra(Azure Active Directory)またはカスタム ユーザー グループのグループ ID を使用して、グループ制限リストに追加することができます。グループ ID は API で取得することができます。詳細は、こちらをご参照ください。

グループ ID でグループ制限リストに Microsoft Entra(Azure Active Directory)グループまたはカスタム ユーザー グループを追加するには、

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

2.GroupRestrictions セクションに移動し、POST /groupRestrictions/addGroup エンドポイントを選択し、右上の「Try it out」をクリックします。

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

  • groupId:Microsoft Entra(Azure Active Directory)グループ ID を入力します。(このパラメータは入力必須です。)
  • courseCatalogId:特定のコースカタログに限定する場合は、コースカタログ ID を入力します。(このパラメータは任意です。)
    このフィールドが空の場合、グループ制限は環境全体に適用されます。

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

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

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

グループ制限リストの表示

環境内でグループ制限のリストに追加されたグループのリストを表示します。

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

2.GroupRestrictions セクションに移動し、GET /groupRestrictions エンドポイントを選択し、右上の「Try it out」をクリックします。

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

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

  • Code 200 は、リクエストが正しく動作したことを示します。Response body には以下の情報が表示されます。
    • Id:制限のID(タイプ guid)。
    • CourseCatalogId:制限が適用されるコースカタログのID。これが空の場合、制限は環境全体に適用されます。
    • GroupId:ユーザーグループ ID
  • Code 200 で Response body が空の場合は、環境内にグループ制限がないことを示します。
  • エラーの場合、Response body にはエラー オブジェクトとそのコード、問題を説明するメッセージ キーが含まれます。

Restrict the visibility api-1.jpg

 

グループ制限のオン/ オフ

グループ制限のオンとオフを切り替えて、制限を有効または無効に設定します。

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

2.GroupRestrictions セクションに移動し、PUT /groupRestrictions/state エンドポイントを選択し、右上の「Try it out」をクリックします。

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

  • isEnabled:制限をオンにするには「true」を、オフにするには「false」を選択します。(このパラメータは入力必須です。)

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

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

  • Code 200 は、リクエストが正しく動作したことを示します。Response body は空です。
  • エラーの場合、Response body にはエラー オブジェクトとそのコード、問題を説明するメッセージ キーが含まれます。
  • 制限は、グループ制限のリストに追加されているグループのだけに適用されます。

グループ制限がオン(true)にした場合、制限リストに含まれるグループのユーザーだけが Learn365 管理センター のピープル ピッカーで利用できます。

例:

1.Microsoft Entra (Azure Active Directory) で「Human Resources」グループを作成します。

2.Learn365 のグループ制限リストに「Human Resources」グループを追加します。

3.グループ制限をオン(true)に設定します。

4.コースカタログ「People Development」内のトレーニングに受講者を登録をする際、「ユーザーまたはグループを検索」フィールドのピープル ピッカーには「Human Resources」グループのユーザーのみが表示され、選択できます。

 

グループ制限リストから削除

特定の制限を削除するには、その ID が必要です。ID は、GET /groupRestrictions エンドポイントを実行し、Response body の「Id」列で見つけることができます。

グループ制限リストから特定の制限を削除するには。

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

2.GroupRestrictions セクションに移動し、DELETE /groupRestrictions エンドポイントを選択し、右上の「Try it out」をクリックします。

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

  • id:制限 ID を入力します。(このパラメータは入力必須です。)

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

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

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

 

1つのテナント内の複数環境(組織)に対する制限の追加

1つのテナント内に複数の環境(組織)を設定した場合は、AP Iを通じて Microsoft Entra(Azure Active Directory)グループとユーザーの可視性を環境全体に制限できます。

カスタム ユーザー グループや Flow365 ユーザーについては、既定で特定の環境に可視性が限定されているため、可視性の制限は設定する必要はありません。

異なる環境のいずれかに制限を適用するには、以下の手順を行います。

1.環境にアクティブな API キーが生成されていることを確認します。

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

3. Microsoft Entra(Azure Active Directory)ユーザーまたはグループをグループ制限リストに追加します。(グループ制限リストへの追加を参照

4.環境のグループ制限をオンにします。(グループ制限のオン/ オフを参照

これで、この環境の Learn365 管理センターのピープル ピッカー(「ユーザーまたはグループを検索」フィールドなど)では、制限リストに含まれるグループのユーザーだけが選択可能となります。

  • テナントには環境Aと環境Bの 2 つの環境が設定されています。
  • Microsoft Entra(Azure Active Directory)グループ には「Marketing Team」と「Senior Developers」があります。

環境Aでは「Marketing Team」のみ、環境Bでは「Senior Developers」のみが表示されるように制御します。


 

1.環境A にアクティブな API キーが生成されていることを確認します。

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

3.グループ制限リストに「Marketing Team」を追加します。

4.制限をオンにします。

5.環境B にアクティブな API キーが生成されていることを確認します。

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

7.グループ制限リストに「Senior Developers」を追加します。

8.制限をオンにします。

 

これで、環境Aのピープルピッカーでは「Marketing Team」グループのユーザーだけを選択することができ、環境Bのピープルピッカーでは「Senior Developers」グループのユーザーだけを選択することができます。