Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получите список всех ролей, назначенных пользователю в Viva Engage.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
|---|---|---|
| Делегированные (рабочая или учебная учетная запись) | EngagementRole.Read | EngagementRole.ReadWrite.All |
| Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
| Приложение | EngagementRole.Read.All | EngagementRole.ReadWrite.All |
Примечание.
Для вызова конечной точки /me требуется вход пользователя и, следовательно, делегированное разрешение. Разрешения приложений не поддерживаются при использовании конечной /me точки.
HTTP-запрос
GET /users/{userId}/employeeExperience/assignedRoles
GET /me/employeeExperience/assignedRoles
Заметка: Представляет
{userId}идентификатор пользователя Office.
Необязательные параметры запросов
Этот метод поддерживает $filter параметры запроса OData (eq), $select, и $count . Общие сведения см. в статье Параметры запроса OData. Параметр поддерживают $filter только свойства displayName и id.
В следующей таблице показано, как использовать параметры запроса OData с этим API.
| Описание | 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 |
Заголовки запросов
| Имя | Описание |
|---|---|
| Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Текст запроса
Не указывайте текст запроса для этого метода.
Отклик
В случае успешного 200 OK выполнения этот метод возвращает код отклика и коллекцию объектов engagementRole в теле отклика.
Примеры
Пример 1. Получение списка всех ролей, назначенных пользователю, выполнившего вход, в Viva Engage
В следующем примере показано, как получить список всех ролей, назначенных вошедшего пользователя в Viva Engage.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/me/employeeExperience/assignedRoles
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$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/beta/users/e8d9f6a2-1c34-4b7a-9f11-2a4d8b7c9e01/employeeExperience/assignedRoles
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$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"
}
]
}