検索

【API】 ユーザー ロールの取得

  • 更新

Learn365 API を使用すると、ユーザーやグループに割り当てられているすべてのロールの一覧を取得できます。

ここでは、Learn365 API を使用して、ロールの一覧を取得するための手順について説明します。

 

ユーザーまたはグループに割り当てられたロールの取得

手順：

1．API にアクセスし、認証を行います。

https://api.365.systems/  にアクセスし、適切な API キーで認証されていることを確認してください。

2．エンドポイントを選択します。

RolesAssignments セクション で以下のエンドポイントを選択し、右上の［Try it out］をクリックします。

GET method /odata/v2/RoleAssignments  Returns the list of role assignments 

3．必要に応じて、クエリ オプション パラメータを入力します。

クエリ オプション パラメータを使用すると、レスポンスで取得するデータを絞り込むことができます。

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

クエリ オプション パラメータの使用例

  • フィルターで特定のユーザーまたはグループに関するデータのみを取得する

「$filter」フィールドに、UserId eq ユーザ ID （または グループ ID） と入力します。

入力例：UserId eq d822c362-5b86-41b0-8261-57220470c89f

ユーザ ー ID または グループ ID は API を使用して取得できます。詳細な手順については、こちらのドキュメントをご参照ください。

roles of a user via API-1.png

 

  • 特定のコースにおけるロール割り当ての一覧を取得する

「$expand」フィールドに、User($select=PrincipalType) と入力します。

これにより、レスポンスに PrincipalType（ロールがユーザーに割り当てられているのか、グループに割り当てられているのかを示すパラメータ）が含まれるようになります。

「$filter」フィールドには、 RoleScope/CourseId eq コース ID と入力します。

入力例：RoleScope/CourseId eq 09e99b42-9000-4b18-a818-9e7964547013

コース ID は API を使用して取得できます。詳細な手順については、こちらのドキュメントをご参照ください。

roles of a user via API-2.png

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

roles of a user via API-3.png

 

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

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

  • ステータスコード 200 が返され、レスポンス本文にロール割り当ての一覧が表示された場合は成功です。
  • レスポンス本文では、テナント内のすべてのコースカタログにおける、ユーザーやグループに割り当てられたロールの一覧と、その詳細情報（IDを含む）を確認できます。クエリ オプション パラメータを指定している場合、レスポンスには条件に一致するデータのみが表示されます。
  • 特定のユーザーやグループを Ctrl + F を使用して検索し、必要に応じてコピーできます。また、Download オプションを使用して、結果を JSON フォーマットでローカルデバイスに保存できます。

ロール パラメータの値には、以下のようなものがあります。

  • Learner：受講者
  • LMSAdmin：LMS管理者
  • CourseAdmin：コースまたはトレーニングプラン 管理者
  • CourseCatalogAdmin：カタログ 管理者
  • CourseSessionInstructor：（セッションの）講師
  • CourseCatalogVisitor：カタログのユーザリストに追加されている
  • CourseVisitor：特定のコースの対象者
roles of a user via API-4.png