API によるユーザーのロールリストの取得

  • 更新

Learn365 APIを通じて、ユーザーまたはグループに割り当てられているすべてのロールのリストを取得することができます。

ここでは、Learn365 API を通じたこれらのロールのリストを取得する方法について説明します。

 

ユーザーまたはグループに割り当てられているロールの取得は、以下の手順に沿って行います。

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

2.RolesAssignments セクションに移動し、GET method /odata/v2/RoleAssignments  Returns the list of role assignments エンドポイントを選択し、右上の「Try it out」を選択します。

 

roles of a user via API-1.png

 

3.レスポンスのデータを制御するクエリオプションパラメータを入力します。

クエリ オプションパラメータを設定しない場合、レスポンスにはテナントのすべてのロール割り当てに関する情報が含まれます。

 

例えば、クエリ オプションに対象のユーザーまたはグループのIDを設定し、特定のユーザーまたはグループに割り当てられたロールのリストを取得することができます。

この場合、$filter フィールドに「UserId eq <該当するユーザまたはグループのID>」と入力します。

例:UserId eq d822c362-5b86-41b0-8261-57220470c89f

 

roles of a user via API-2.png

 

別の例として、特定のコースにおけるロールの割り当てリストを取得します。

  • $expand フィールドに「User($select=PrincipalType)」と入力し、ロールの割り当て先(ユーザまたはグループ)示す PrincipalType パラメータをレスポンスに含めます。
  • $filter フィールドには「RoleScope/CourseId eq <コースのID>」と入力します。
    例: RoleScope/CourseId eq 09e99b42-9000-4b18-a818-9e7964547013

 

roles of a user via API-3.png

 

レスポンスには、PrincipalType パラメータを持つコースのすべてのロールの割り当てリストを表示します。

roles of a user via API-4.png

 

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

 

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

  • Code の下の2xx(202など)は、リクエストが正しく動作したことを示します。
  • Response body にはテナントのすべてのコースカタログのユーザーおよびグループに割り当てられたロールのリストと、IDを含むそれらのデータが表示されます。クエリオプションパラメータが設定されている場合、レスポンスには関連するデータと詳細のみが含まれます。
  • Ctrl+F で特定のユーザーまたはグループを検索し、必要な場所にコピーして使用することができます。
  • Downloadオプションを使用して、APIリクエストの結果を JSON フォーマットでローカルデバイスに保存できます。

ロールは以下のいずれかになります。

  • Learner:ユーザーまたはグループはコースまたはトレーニングプランに登録されている。
  • LMSAdmin:ユーザーはLMS管理者として割り当てられています。
  • CourseAdmin:ユーザーまたはグループはコースまたはトレーニングプランの管理者として割り当てられています。
  • CourseCatalogAdmin:ユーザーはカタログ 管理者として割り当てられています。
  • CourseSessionInstructor:ユーザーはセッションの講師として割り当てられています。
  • CourseCatalogVisitor:ユーザーは特定のカタログのユーザリストに追加されています。
  • CourseVisitor:ユーザーは特定のコースの対象者に追加されています。

roles of a user via API-5.png