Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет специализированный подтип удостоверения пользователя в Microsoft Entra ID предназначен для приложений (агентов) на основе ИИ, которые должны функционировать в качестве цифровых рабочих ролей. Пользователи агентов разрешают агентам доступ к API и службам, которым специально требуются удостоверения пользователей, получая маркеры с утверждениями idtyp=user . Пользователи агентов отличаются от пользователей-пользователей , и они связаны только с пользователями через такие отношения, как владелец, спонсор и менеджер.
Каждый пользователь агента поддерживает связь "один к одному" с родительским удостоверением агента и проходит проверку подлинности с помощью учетных данных этого родителя. Пользователи агентов имеют такие возможности, как добавление в группы, назначенные лицензии и доступ к функциям совместной работы, таким как почтовые ящики и чат, при работе с ограничениями безопасности, включая отсутствие проверки подлинности паролей, отсутствие назначений привилегированных ролей администратора и разрешения, аналогичные гостевым пользователям.
Наследует от пользователя.
Этот ресурс является открытым типом, который позволяет использовать дополнительные свойства, помимо описанных здесь.
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Список | коллекция agentUser | Получение списка объектов agentUser . |
| Создание | agentUser | Создайте новый объект agentUser . |
| Получение | agentUser | Чтение свойств и связей объекта agentUser . |
| Обновление | agentUser | Обновить объект agentUser . |
| Delete | Нет | Удаление объекта agentUser . |
| Назначение ролей приложений | ||
| Перечисление назначений ролей приложения | Коллекция appRoleAssignment | Получите назначения ролей приложения для этого пользователя агента. |
| Создание назначения роли приложения | appRoleAssignment | Создайте назначение роли приложения для этого пользователя агента. |
| Удаленные элементы | ||
| List | Коллекция directoryObject | Получите список недавно удаленных пользовательских объектов агента. |
| Получение | directoryObject | Получите свойства недавно удаленного пользователя агента. |
| Восстановление | directoryObject | Восстановите недавно удаленного пользователя агента. |
| Удалить без возможности восстановления | Нет | Окончательное удаление пользователя агента. |
| Объекты каталога | ||
| Список корпоративных объектов | Коллекция directoryObject | Получение объектов каталога, принадлежащих пользователю агента. |
| Организационные отношения | ||
| Список подчиненных | Коллекция directoryObject | Получение пользователей и контактов, которые сообщают пользователю агента. |
| Получение руководителя | directoryObject | Получите пользователя или контакт, который является руководителем этого пользователя агента. |
| Добавление руководителя | Нет | Назначьте диспетчера пользователя агента. |
| Удаление диспетчера | Нет | Удалите диспетчер пользователя агента. |
| Перечисление прямых членства | Коллекция directoryObject | Получение групп, ролей каталогов и административных единиц, в которые входит пользователь агента. |
| Перечисление транзитивных членства | Коллекция directoryObject | Получение групп, ролей каталога и административных единиц, членом которых является пользователь агента, включая членство в вложенных группах. |
| Перечисление транзитивных отчетов | Коллекция directoryObject | Получение транзитивных отчетов для пользователя агента. |
| Спонсоров | ||
| Список спонсоров | Коллекция directoryObject | Получите пользователей и группы, отвечающие за привилегии этого пользователя агента. |
| Добавление спонсоров | Нет | Добавьте спонсоров для пользователя агента. |
| Удаление спонсоров | Нет | Удалите спонсоров из пользователя агента. |
Свойства
Важно!
Хотя этот ресурс наследуется от пользователя, некоторые свойства неприменимы и возвращают null значения или значения по умолчанию. Эти свойства исключены из приведенной ниже таблицы.
| Свойство | Тип | Описание |
|---|---|---|
| accountEnabled | Логический | Если учетная запись обеспечена — true, в противном случае — false. Это свойство является обязательным при создании объекта . Наследуется от пользователя. |
| assignedLicenses | Коллекция assignedLicense | Лицензии, назначенные пользователю агента, включая унаследованные (групповые) лицензии. Это свойство не различает назначенные напрямую и унаследованные лицензии. Используйте свойство licenseAssignmentStates для идентификации непосредственно назначенных и унаследованных лицензий. Значение null не допускается. Наследуется от пользователя. |
| assignedPlans | Коллекция assignedPlan | Планы, назначенные пользователю агента. Только для чтения. Значение null не допускается. Наследуется от пользователя. |
| businessPhones | Коллекция строк | Номера телефонов для пользователя агента. Для этого свойства можно указать только один номер. "Только для чтения" для пользователей, которые синхронизируются с локальным каталогом. Наследуется от пользователя. |
| city | String | Город, в котором находится пользователь агента. Максимальная длина: 128 символов. Наследуется от пользователя. |
| cloudRealtimeCommunicationInfo | cloudRealtimeCommunicationInfo | Сведения об обмене данными в реальном времени Майкрософт, связанными с пользователем агента. Наследуется от пользователя. |
| CompanyName | String | Имя компании, с которым связан пользователь агента. Это свойство может быть полезно для описания компании внешнего пользователя. Максимальная длина: 64 символа. Наследуется от пользователя. |
| country | String | Страна или регион, в которых находится пользователь агента; например, US или UK. Максимальная длина: 128 символов. Наследуется от пользователя. |
| createdDateTime | DateTimeOffset | Дата и время создания пользователя агента в формате ISO 8601 и UTC. Значение не может изменяться и заполняется автоматически при создании сущности. Допускается значение null. Для локальных пользователей значение представляет момент их создания в Microsoft Entra ID. Свойство предназначено null для некоторых пользователей, созданных до июня 2018 г. и локальных пользователей, синхронизированных с Microsoft Entra ID до июня 2018 г. Только для чтения. Наследуется от пользователя. |
| creationType | String | Только для чтения. Null. Наследуется от пользователя. |
| customSecurityAttributes | customSecurityAttributeValue | Открытый сложный тип, который содержит значение настраиваемого атрибута безопасности, назначенного объекту каталога. Допускается значение null. Наследуется от пользователя. |
| deletedDateTime | DateTimeOffset | Дата и время удаления пользователя. Наследуется от directoryObject. |
| department | String | Имя отдела, в котором работает пользователь. Максимальная длина: 64 символа. Наследуется от пользователя. |
| displayName | String | Имя пользователя, отображаемое в адресной книге. Это значение обычно является сочетанием имени, отчества и фамилии пользователя. Это свойство является обязательным при создании пользователя и не может быть очищено во время обновлений. Максимальная длина: 256 символов. Наследуется от пользователя. |
| employeeHireDate | DateTimeOffset | Дата и время, когда пользователь был нанят или начнет работу, если есть будущий сотрудник. Наследуется от пользователя. |
| employeeId | String | Идентификатор сотрудника, назначенный пользователю организацией. Максимальная длина составляет 16 символов. Наследуется от пользователя. |
| employeeLeaveDateTime | DateTimeOffset | Дата и время, когда пользователь покинет организацию или покинет ее. Чтобы прочитать это свойство, вызывающему приложению необходимо назначить разрешение User-LifeCycleInfo.Read.All . Чтобы записать это свойство, вызывающему приложению должны быть назначены разрешения User.Read.All и User-LifeCycleInfo.ReadWrite.All . Чтобы прочитать это свойство в делегированных сценариях, администратору требуется по крайней мере одна из следующих #REF! ролей: администратор рабочих процессов жизненного цикла (минимальные привилегии), глобальный читатель. Чтобы записать это свойство в делегированных сценариях, администратору требуется роль глобального администратора . Дополнительные сведения см. в разделе Настройка свойства employeeLeaveDateTime для пользователя. Наследуется от пользователя. |
| employeeOrgData | employeeOrgData | Представляет данные организации (например, division и costCenter), связанные с пользователем. Наследуется от пользователя. |
| employeeType | String | Фиксирует тип корпоративного работника. Например, Employee, Contractor, Consultant или Vendor. Наследуется от пользователя. |
| faxNumber | String | Номер факса пользователя. Наследуется от пользователя. |
| givenName; | String | Простое имя пользователя. Максимальная длина: 64 символа. Наследуется от пользователя. |
| id | String | Уникальный идентификатор пользователя. Его следует рассматривать как непрозрачный идентификатор. Наследуется от directoryObject. Значение null не допускается. Только для чтения. Наследует от сущности |
| identityParentId | String | Ссылается на идентификатор объекта связанного удостоверения агента. Это свойство является обязательным при создании объекта и не может быть очищено во время обновлений. Наследуется от пользователя. |
| imAddresses | Коллекция строк | Sip-адреса для пользователя, передаваемые по IP-адресам сеанса voIP. Только для чтения. Наследуется от пользователя. |
| infoCatalogs | Коллекция строк | Определяет сегменты сведений, назначенные пользователю. Наследуется от пользователя. |
| isLicenseReconciliationNeeded | Логический | Указывает, ожидает ли пользователь назначения лицензии почтового ящика Exchange. Только для чтения. Наследуется от пользователя. |
| isManagementRestricted | Логический |
true Значение , если пользователь является членом административной единицы управления с ограниченным доступом. Если значение по умолчанию не задано null , а поведение по умолчанию — false. Только для чтения. Для управления пользователем, который является членом административной единицы управления с ограниченным доступом, администратору или вызывающему приложению должна быть назначена #REF! роль в область административной единицы ограниченного управления. Наследуется от пользователя. |
| isResourceAccount | Логическое | Не используйте — зарезервировано для использования в будущем. Наследуется от пользователя. |
| jobTitle; | String | Должность пользователя. Максимальная длина: 128 символов. Наследуется от пользователя. |
| licenseAssignmentStates | Коллекция licenseAssignmentState | Состояние назначений лицензий для пользователя. Он также указывает лицензии, которые назначаются напрямую, и лицензии, унаследованные пользователем через членство в группах. Только для чтения. Наследуется от пользователя. |
| почта; | String | SMTP-адрес пользователя, например admin@contoso.com. Изменения этого свойства также обновят коллекцию proxyAddresses пользователя, чтобы включить значение в качестве SMTP-адреса. Это свойство не может содержать знаки акцента. ПРИМЕЧАНИЕ. Не рекомендуется обновлять это свойство для #REF! AD профилей пользователей B2C. Вместо этого используйте свойство otherMails. Наследуется от пользователя. |
| mailNickname | String | Почтовый псевдоним для пользователя. Это свойство должно быть указано при создании пользователя. Максимальная длина: 64 символа. Наследуется от пользователя. |
| mobilePhone | String | Основной сотовый телефон пользователя. Доступ только для чтения для пользователей, синхронизированных из локального каталога. Наследуется от пользователя. |
| officeLocation | String | Расположение офиса на месте работы пользователя. Максимальная длина: 128 символов. Наследуется от пользователя. |
| otherMails | Коллекция строк | Список дополнительных адресов электронной почты для пользователя. Например: ["bob@contoso.com", "Robert@fabrikam.com"]. Может хранить до 250 значений, каждое из которых имеет ограничение в 250 символов. ПРИМЕЧАНИЕ. Это свойство не может содержать знаки акцента. Наследуется от пользователя. |
| postalCode | String | Почтовый индекс адреса пользователя. Формат почтового индекса зависит от страны или региона пользователя. В США для этого атрибута используется ZIP-код. Максимальная длина: 40 символов. Наследуется от пользователя. |
| preferredDataLocation | String | Предпочитаемое расположение данных для пользователя. Дополнительные сведения см. в статье #REF! Online с поддержкой нескольких регионов. Наследуется от пользователя. |
| preferredLanguage | String | Предпочитаемый язык для пользователя. Предпочтительный формат языка основан на RFC 4646. Имя объединяет двухбуквенный код языка и региональных параметров ISO 639, связанный с языком, и двухбуквенный код субкультуры ISO 3166, связанный со страной или регионом. Пример: "en-US" или "es-ES". Наследуется от пользователя. |
| provisionedPlans | Коллекция provisionedPlan | Планы, подготовленные для пользователя. Только для чтения. Значение null не допускается. Наследуется от пользователя. |
| proxyAddresses | Коллекция String | Пример: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]. Изменения в свойстве mail также обновят эту коллекцию, включив значение в качестве SMTP-адреса. Дополнительные сведения см. в разделе Свойства mail и proxyAddresses. Адрес прокси-сервера с SMTP префиксом (с прописной буквой) является основным прокси-адресом, а адрес прокси-сервера с smtp префиксом — вторичными адресами прокси-сервера. Для #REF! AD учетных записей B2C это свойство имеет ограничение в 10 уникальных адресов. Доступно только для чтения в Microsoft Graph. Обновить это свойство можно только с помощью Центра администрирования Microsoft 365. Значение null не допускается. Наследуется от пользователя. |
| refreshTokensValidFromDateTime | DateTimeOffset | Все маркеры обновления или маркеры сеансов (файлы cookie сеанса), выданные до этого времени, недопустимы, а приложения получают ошибку при использовании недопустимого маркера обновления или сеансов для получения маркера делегированного доступа (для доступа к API, таким как Microsoft Graph). В этом случае приложение должно получить новый маркер обновления, запросив авторизованную конечную точку. Только для чтения. Сброс можно выполнить с помощью invalidateAllRefreshTokens. Наследуется от пользователя. |
| securityIdentifier | String | Идентификатор безопасности (SID) пользователя, используемый в сценариях #REF!. Только для чтения. Возвращается по умолчанию. Наследуется от пользователя. |
| showInAddressList | Логический | Не используйте в Microsoft Graph. Вместо этого управляйте этим свойством с помощью Центр администрирования Microsoft 365. Указывает, должен ли пользователь агента быть включен в глобальный список адресов #REF!. См. сведения об известной проблеме. Наследуется от пользователя. |
| signInSessionsValidFromDateTime | DateTimeOffset | Все маркеры обновления или маркеры сеансов (файлы cookie сеанса), выданные до этого времени, недопустимы, а приложения получают ошибку при использовании недопустимого маркера обновления или сеансов для получения маркера делегированного доступа (для доступа к API, таким как Microsoft Graph). В этом случае приложение должно получить новый маркер обновления, запросив авторизованную конечную точку. Только для чтения. Сброс можно выполнить с помощью revokeSignInSessions. Наследуется от пользователя. |
| state | String | Штат или провинция в адресе пользователя агента. Максимальная длина: 128 символов. Наследуется от пользователя. |
| streetAddress | String | Адрес компании пользователя агента. Максимальная длина: 1024 символа. Наследуется от пользователя. |
| surname | String | Фамилия пользователя. Максимальная длина: 64 символа. Наследуется от пользователя. |
| usageLocation | String | Двухбуквенный код страны (по стандарту ISO 3166). Требуется для пользователей агентов, которым назначены лицензии в соответствии с юридическими требованиями к проверка для доступности служб в странах. Примеры: US, JP и GB. Значение null не допускается. Наследуется от пользователя. |
| userPrincipalName | String | Имя участника-пользователя (UPN) пользователя агента. Имя участника-пользователя — это имя для входа в интернет-стиле для пользователя, основанное на стандарте Интернета RFC 822. По соглашению это должно сопоставляться с именем электронной почты пользователя агента. Общий формат — alias@domain, где домен должен присутствовать в проверенной коллекции доменов клиента. Это свойство обязательно указывать при создании пользователя. Доступ к проверенным доменам клиента можно получить с помощью свойства verifiedDomains объекта organization. ПРИМЕЧАНИЕ. Это свойство не может содержать знаки акцента. Разрешены только следующие символы: A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. Полный список разрешенных символов см. в политиках имен пользователей. Наследуется от пользователя. |
| userType | String | Строковое значение, которое можно использовать для классификации типов пользователей агента в каталоге. Возможные значения: Member и Guest.
ПРИМЕЧАНИЕ: Дополнительные сведения о разрешениях для участников и гостевых пользователей см. в статье Какие разрешения пользователей по умолчанию в Microsoft Entra ID? Наследуется от пользователя. |
Связи
Важно!
Хотя этот тип ресурса наследует все связи от типа ресурса пользователя , некоторые связи неприменимы к пользователям агента и всегда будут возвращать null значения или по умолчанию. Эти связи исключены из приведенной ниже таблицы для ясности.
| Связь | Тип | Описание |
|---|---|---|
| appRoleAssignments | Коллекция appRoleAssignment | Представляет роли приложения, предоставленные пользователю агента для приложения. Наследуется от пользователя |
| directReports | Коллекция directoryObject | Пользователи и контакты, которые сообщают пользователю агента. (Пользователи и контакты со свойством руководителя, которым присвоено значение этого пользователя.) Только для чтения. Допускается значение null. Наследуется от пользователя |
| manager | directoryObject | Пользователь или контакт, который является руководителем этого пользователя агента. Только для чтения. Наследуется от пользователя |
| memberOf | Коллекция directoryObject | Группы, роли каталогов и административные единицы, в которые входит пользователь агента. Только для чтения. Допускается значение null. Наследуется от пользователя |
| ownedObjects | Коллекция directoryObject | Объекты каталога, принадлежащие пользователю агента. Только для чтения. Допускается значение null. Наследуется от пользователя |
| Спонсоров | Коллекция directoryObject | Пользователи и группы, отвечающие за привилегии этого пользователя агента в клиенте, и поддерживают обновление сведений и доступа пользователя агента. (Методы HTTP: GET, POST, DELETE.). Наследуется от пользователя |
| transitiveMemberOf | Коллекция directoryObject | Группы, включая вложенные группы и роли каталога, членом которых является пользователь агента. Допускается значение null. Наследуется от пользователя |
| transitiveReports | Коллекция directoryObject | Транзитивные отчеты для пользователя агента. Только для чтения. Наследуется от пользователя |
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"@odata.type": "#microsoft.graph.agentUser",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"accountEnabled": "Boolean",
"assignedLicenses": [
{
"@odata.type": "microsoft.graph.assignedLicense"
}
],
"assignedPlans": [
{
"@odata.type": "microsoft.graph.assignedPlan"
}
],
"businessPhones": [
"String"
],
"city": "String",
"cloudRealtimeCommunicationInfo": {
"@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo"
},
"companyName": "String",
"country": "String",
"countryCode": "Integer",
"createdDateTime": "String (timestamp)",
"creationType": "String",
"customSecurityAttributes": {
"@odata.type": "microsoft.graph.customSecurityAttributeValue"
},
"department": "String",
"displayName": "String",
"employeeHireDate": "String (timestamp)",
"employeeId": "String",
"employeeOrgData": {
"@odata.type": "microsoft.graph.employeeOrgData"
},
"employeeType": "String",
"employeeLeaveDateTime": "String (timestamp)",
"faxNumber": "String",
"givenName": "String",
"imAddresses": [
"String"
],
"infoCatalogs": [
"String"
],
"isLicenseReconciliationNeeded": "Boolean",
"isManagementRestricted": "Boolean",
"isResourceAccount": "Boolean",
"jobTitle": "String",
"licenseAssignmentStates": [
{
"@odata.type": "microsoft.graph.licenseAssignmentState"
}
],
"mail": "String",
"mailNickname": "String",
"mobilePhone": "String",
"otherMails": [
"String"
],
"officeLocation": "String",
"postalCode": "String",
"preferredDataLocation": "String",
"preferredLanguage": "String",
"provisionedPlans": [
{
"@odata.type": "microsoft.graph.provisionedPlan"
}
],
"proxyAddresses": [
"String"
],
"refreshTokensValidFromDateTime": "String (timestamp)",
"securityIdentifier": "String",
"showInAddressList": "Boolean",
"signInSessionsValidFromDateTime": "String (timestamp)",
"state": "String",
"streetAddress": "String",
"surname": "String",
"usageLocation": "String",
"userPrincipalName": "String",
"userType": "String",
"identityParentId": "String"
}