名前空間: microsoft.graph
Viva Engageでユーザーに割り当てられているすべてのロールの一覧を取得します。
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | EngagementRole.Read | EngagementRole.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | EngagementRole.Read.All | EngagementRole.ReadWrite.All |
注:
/me エンドポイントの呼び出しにはサインインしているユーザーが必要であり、そのため委任されたアクセス許可が必要です。
/me エンドポイントを使用する場合、アプリケーションのアクセス許可はサポートされません。
HTTP 要求
GET /users/{userId}/employeeExperience/assignedRoles
GET /me/employeeExperience/assignedRoles
手記:
{userId}は、Office ユーザー ID を表します。
オプションのクエリ パラメーター
このメソッドは、OData クエリ パラメーターの $filter (eq)、 $select、 $count をサポートします。 一般的な情報については、「OData クエリ パラメーター」を参照してください。
$filter パラメーターをサポートするのは、displayName プロパティと id プロパティのみです。
次の表は、この API で OData クエリ パラメーターを使用する方法を示しています。
| 説明 | HTTP 要求 |
|---|---|
| 割り当てられたロールを表示名でフィルター処理する | GET /users/{userId}/employeeExperience/assignedRoles?$filter=displayName eq 'Corporate Communicator' |
| 割り当てられたロールの一覧の id プロパティのみを取得します | GET /users/{userId}/employeeExperience/assignedRoles?$select=id |
| 割り当てられたロールの合計数を含める | GET /users/{userId}/employeeExperience/assignedRoles?$count=true |
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは応答コード 200 OK と応答本文の engagementRole オブジェクトのコレクションを返します。
例
例 1: サインインしているユーザーに割り当てられているすべてのロールの一覧を取得Viva Engage
次の例では、Viva Engageでサインイン ユーザーに割り当てられているすべてのロールの一覧を取得する方法を示します。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/v1.0/me/employeeExperience/assignedRoles
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#me/employeeExperience/assignedRoles",
"value": [
{
"id": "ec791927-d09f-4f91-bd76-d3b05e1c1a31",
"displayName": "Network Admin"
},
{
"id": "b0de8e6d-4457-4722-bdc5-5a32a09bf064",
"displayName": "Verified Admin"
},
{
"id": "77aa7d76-bdf6-4cc0-80e2-fd1ac5a28471",
"displayName": "Corporate Communicator"
}
]
}
例 2: Viva Engageでユーザーに割り当てられているすべてのロールの一覧を取得する
次の例では、Viva Engageでユーザーに割り当てられているすべてのロールの一覧を取得する方法を示します。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/v1.0/users/e8d9f6a2-1c34-4b7a-9f11-2a4d8b7c9e01/employeeExperience/assignedRoles
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/e8d9f6a2-1c34-4b7a-9f11-2a4d8b7c9e01/employeeExperience/assignedRoles",
"value": [
{
"id": "ec791927-d09f-4f91-bd76-d3b05e1c1a31",
"displayName": "Network Admin"
},
{
"id": "b0de8e6d-4457-4722-bdc5-5a32a09bf064",
"displayName": "Verified Admin"
},
{
"id": "77aa7d76-bdf6-4cc0-80e2-fd1ac5a28471",
"displayName": "Corporate Communicator"
}
]
}