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

Создание агентаПользователь

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

Важно!

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

Создайте новый объект agentUser . Вы также можете создать пользователя агента, используя конечную точку POST /users и указав microsoft.graph.agentUser тип в тексте запроса.

Как минимум необходимо указать необходимые свойства. При необходимости вы можете указать другие записываемые свойства.

Эта операция возвращает по умолчанию только подмножество свойств для каждого agentUser. Эти свойства по умолчанию указаны в разделе Свойства. Чтобы получить свойства, которые не возвращаются по умолчанию, выполните операцию GET и укажите их в параметре запроса OData $select.

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

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

Разрешения

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

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

Важно!

В делегированных сценариях с рабочими или учебными учетными записями администратору должна быть назначена поддерживаемая Microsoft Entra роль или настраиваемая роль с разрешением поддерживаемой роли. Администратор идентификатора агента — это наименее привилегированная роль, поддерживаемая для этой операции.

HTTP-запрос

POST /users/microsoft.graph.agentUser

Совет

Вы также можете создавать пользователей агента с помощью POST /users без указания microsoft.graph.agentUser типа. "@odata.type": "microsoft.graph.agentUser" Однако должен быть указан в тексте запроса вместе с другими необходимыми свойствами для создания пользователя.

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

Заголовок Значение
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json

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

В тексте запроса укажите представление объекта agentUser в формате JSON.

В следующей таблице перечислены свойства, необходимые при создании agentUser.

Параметр Тип Описание
accountEnabled Логический Если учетная запись обеспечена — true, в противном случае — false.
displayName String Имя, отображаемое в адресной книге пользователя агента.
mailNickname String Псевдоним почты для пользователя агента.
userPrincipalName String Имя субъекта-пользователя (someagent@contoso.com). Это имя для входа в интернет-стиле для пользователя агента на основе стандарта Интернета RFC 822. По соглашению это должно сопоставляться с именем электронной почты пользователя агента. Общий формат: псевдоним@домен. При этом домен должен входить в коллекцию проверенных доменов клиента. Доступ к проверенным доменам клиента можно получить с помощью свойства verifiedDomains объекта organization.
ПРИМЕЧАНИЕ. Это свойство не может содержать диакритические знаки. Разрешены только следующие символы: A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. Полный список разрешенных символов см. в политиках имен пользователей.
identityParentId String Идентификатор объекта связанного удостоверения агента. Обязательно.

Так как этот ресурс поддерживает расширения, можно использовать POST операцию и добавлять пользовательские свойства с собственными данными в экземпляр пользователя агента при его создании.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 201 Created и объект agentUser в теле отклика.

При попытке создать agentUser с идентификатором identityParentId , уже связанным с другим агентомUser, возвращается 400 Bad Request ошибка.

Примеры

Запрос

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

POST https://graph.microsoft.com/beta/users/microsoft.graph.agentUser
Content-type: application/json

{
  "accountEnabled": true,
  "displayName": "Sales Agent",
  "mailNickname": "SalesAgent",
  "userPrincipalName": "salesagent@contoso.com",
  "identityParentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Отклик

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

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

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users/$entity",
    "@odata.type": "#microsoft.graph.agentUser",
    "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
    "businessPhones": [],
    "displayName": "Sales Agent",
    "mail": "salesagent@contoso.com",
    "mailNickname": "SalesAgent",
    "userPrincipalName": "salesagent@contoso.com",
    "identityParentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Связанные материалы

  • Last updated on