Поделиться через


Перечисление ролей

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Получите список всех ролей, которые можно назначить в Viva Engage.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) EngagementRole.Read.All EngagementRole.ReadWrite.All
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение EngagementRole.Read.All EngagementRole.ReadWrite.All

HTTP-запрос

GET /employeeExperience/roles

Необязательные параметры запросов

Этот метод поддерживает $filter параметры запроса OData (eq), $select, , $topи $count . Общие сведения см. в статье Параметры запроса OData. Параметр поддерживают $filter только свойства displayName и id.

В следующей таблице показано, как использовать параметры запроса OData с этим API.

Описание HTTP-запрос
Получение первых 10 ролей и включение количества общих ролей GET /employeeExperience/roles?$top=10&$count=true
Фильтрация ролей по отображаемого имени Network Admin GET /employeeExperience/roles?$filter=displayName eq 'Network Admin'
Получение только свойств id и displayName для списка ролей GET /employeeExperience/roles?$select=id,displayName

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успешного 200 OK выполнения этот метод возвращает код отклика и коллекцию объектов engagementRole в теле отклика.

Примеры

Запрос

Ниже показан пример запроса.

GET https://graph.microsoft.com/beta/employeeExperience/roles

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#employeeExperience/roles",
  "value": [
    {
            "id": "ec759127-089f-4f91-8dfc-03a30b51cb38",
            "displayName": "Network Admin"
        },
        {
            "id": "966b8ec4-6457-4f22-bd3c-5a2520e98f4a",
            "displayName": "Verified Admin"
        },
        {
            "id": "77aa47ad-96fe-4ecc-8024-fd1ac5e28f17",
            "displayName": "Corporate Communicator"
        }
  ]
}