通过

agentUser 资源类型

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

表示Microsoft Entra ID中用户标识的专用子类型，专为需要充当数字辅助角色的 AI 支持的应用程序 (代理) 。 代理用户允许代理访问专门需要用户标识的 API 和服务，并接收带有 idtyp=user 声明的令牌。 代理用户不同于人类 用户 ，它们仅通过所有者、发起人和经理等关系与用户关联。

每个代理用户都与父代理标识保持一对一关系，并通过该父级的凭据进行身份验证。 代理用户具有类似于用户的功能，例如添加到组、分配的许可证以及访问邮箱和聊天等协作功能，同时在安全约束下作，包括无密码身份验证、无特权管理员角色分配以及类似于来宾用户的权限。

继承自 用户。

此资源是一种开放类型，它允许除此处所述的属性之外的其他属性。

方法

方法 返回类型 Description
List agentUser 集合 获取 agentUser 对象的列表。
创建 agentUser 创建新的 agentUser 对象。
Get agentUser 读取 agentUser 对象的属性和关系。
更新 agentUser 更新 agentUser 对象。
删除 无 删除 agentUser 对象。
应用角色分配
列出应用角色分配 appRoleAssignment 集合 获取此代理用户的应用角色分配。
创建应用角色分配 appRoleAssignment 为此代理用户创建新的应用角色分配。
已删除项目
List directoryObject collection 检索最近删除的代理用户对象的列表。
Get directoryObject 检索最近删除的代理用户的属性。
还原 directoryObject 还原最近删除的代理用户。
永久删除 无 永久删除代理用户。
目录对象
列出拥有的对象 directoryObject collection 获取代理用户拥有的目录对象。
组织关系
列出直接下属 directoryObject collection 获取向代理用户报告的用户和联系人。
List manager directoryObject 获取此代理用户的经理的用户或联系人。
添加管理器 无 分配代理用户的经理。
删除管理器 无 删除代理用户的经理。
列出直接成员身份 directoryObject collection 获取代理用户所属的组、目录角色和管理单元。
列出可传递成员身份 directoryObject collection 获取代理用户所属的组、目录角色和管理单元，包括嵌套组成员身份。
列出可传递报表 directoryObject collection 获取代理用户的可传递报表。
赞助商
列出赞助商 directoryObject collection 获取负责此代理用户权限的用户和组。
添加赞助商 无 为代理用户添加赞助商。
删除赞助商 无 从代理用户中删除赞助商。

属性

重要

虽然此资源继承自 用户，但某些属性不适用，返回 null 或默认值。 下表中排除了这些属性。

属性 类型 说明
accountEnabled Boolean 启用帐户时为 true，否则为 false。 创建 对象时需要此属性。 继承自 用户。
assignedLicenses assignedLicense collection 分配给代理用户的许可证，包括继承的 (基于组的) 许可证。 此属性不区分直接分配的许可证和继承的许可证。 使用 licenseAssignmentStates 属性标识直接分配的许可证和继承的许可证。 不可为 null。 继承自 用户。
assignedPlans assignedPlan collection 分配给代理用户的计划。 只读。 不可为 null。 继承自 用户。
businessPhones 字符串集合 代理用户的电话号码。 仅可为此属性设置一个数字。 本地目录同步的用户为只读。 继承自 用户。
城市 String 代理用户所在的城市。 最大长度为 128 个字符。 继承自 用户。
cloudRealtimeCommunicationInfo cloudRealtimeCommunicationInfo Microsoft与代理用户相关的实时通信信息。 继承自 用户。
CompanyName String 代理用户与之关联的公司的名称。 此属性可用于描述外部用户所属的公司。 最大长度为 64 个字符。 继承自 用户。
country String 代理用户所在的国家或地区;例如， US 或 UK。 最大长度为 128 个字符。 继承自 用户。
createdDateTime DateTimeOffset 以 ISO 8601 格式和 UTC 创建代理用户的日期和时间。 值无法修改，并在实体创建时自动填充。 可为 Null。 对于本地用户，值表示首次在 Microsoft Entra ID 中创建用户。 null属性适用于 2018 年 6 月之前创建的一些用户，以及 2018 年 6 月之前同步到Microsoft Entra ID的本地用户。 只读。 继承自 用户。
creationType 字符串 只读。 零。 继承自 用户。
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 权限。 若要在委派方案中读取此属性，管理员至少需要以下Microsoft Entra角色之一：生命周期工作流管理员 (最低特权) 全局读取者。 若要在委派方案中编写此属性，管理员需要 全局管理员 角色。 有关详细信息，请参阅 为用户配置 employeeLeaveDateTime 属性。 继承自 用户。
employeeOrgData employeeOrgData 表示组织数据 (例如，与用户关联的部门和 costCenter) 。 继承自 用户。
employeeType String 捕获企业员工类型。 例如，Employee、Contractor、Consultant 或 Vendor。 继承自 用户。
faxNumber String 用户的传真号。 继承自 用户。
givenName String 用户的名。 最大长度为 64 个字符。 继承自 用户。
id String 用户的唯一标识符。 应将其视为不透明的标识符。 继承自 directoryObject。 不可为空。 只读。 继承自 实体
identityParentId String 引用关联 代理标识的对象 ID。 创建对象时需要此属性，在更新期间无法清除此属性。 继承自 用户。
imAddresses String collection 即时消息语音 IP (VOIP) 会话启动协议 (用户的 SIP) 地址。 只读。 继承自 用户。
infoCatalogs 字符串集合 标识分配给用户的信息片段。 继承自 用户。
isLicenseReconciliationNeeded 布尔值 指示用户是否正在等待交换邮箱许可证分配。 只读。 继承自 用户。
isManagementRestricted 布尔值 true 如果用户是受限管理管理单元的成员，则为 。 如果未设置，则默认值为 null ，默认行为为 false。 只读。 若要管理属于受限管理管理单元成员的用户，必须在受限管理管理单元的范围内为管理员或调用应用分配Microsoft Entra角色。 继承自 用户。
isResourceAccount 布尔 请勿使用 – 保留以备今后使用。 继承自 用户。
jobTitle String 用户的职务。 最大长度为 128 个字符。 继承自 用户。
licenseAssignmentStates licenseAssignmentState 集合 此用户的许可证分配状态。 它还指示直接分配的许可证以及用户通过组成员身份继承的许可证。 只读。 继承自 用户。
mail String 用户的 SMTP 地址，例如， admin@contoso.com。 对此属性的更改还会更新用户的 proxyAddresses 集合，以将值包含为 SMTP 地址。 此属性不能包含重音字符。 注意：建议不要为Azure AD B2C 用户配置文件更新此属性。 请改用 otherMails 属性。 继承自 用户。
mailNickname String 用户的邮件别名。 创建用户时必须指定此属性。 最大长度为 64 个字符。 继承自 用户。
mobilePhone String 用户的主要移动电话号码。 从本地目录同步的用户为只读。 继承自 用户。
officeLocation String 用户公司地点的办公室位置。 最大长度为 128 个字符。 继承自 用户。
otherMails 字符串集合 用户的其他电子邮件地址列表；例如：["bob@contoso.com", "Robert@fabrikam.com"]。 最多可以存储 250 个值，每个值的限制为 250 个字符。 注意：此属性不能包含重音字符。 继承自 用户。
postalCode String 用户邮政地址的邮政编码。 邮政编码特定于用户所在的国家/地区。 在美国，此属性包含邮政编码。 最大长度为 40 个字符。 继承自 用户。
preferredDataLocation String 用户的首选数据位置。 有关详细信息，请参阅 OneDrive Online 多地理位置。 继承自 用户。
preferredLanguage String 用户的首选语言。 首选语言格式基于 RFC 4646。 该名称结合了与语言关联的 ISO 639 双字母小写区域性代码以及与国家或地区关联的 ISO 3166 双字母大写子区域性代码。 示例：“en-US”或“es-ES”。 继承自 用户。
provisionedPlans provisionedPlan 集合 为用户设置的计划。 只读。 不可为 null。 继承自 用户。
proxyAddresses String collection 例如：["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]。 对 mail 属性的更改还会更新此集合，以将值作为 SMTP 地址包含在内。 有关详细信息，请参阅 mail 和 proxyAddresses 属性。 以 SMTP (大写) 作为前缀的代理地址是主要代理地址，而前缀 smtp 的代理地址是辅助代理地址。 对于Azure AD B2C 帐户，此属性限制为 10 个唯一地址。 Microsoft Graph 中的只读；只能通过 Microsoft 365 管理中心 来更新此属性。 不可为 null。 继承自 用户。
refreshTokensValidFromDateTime DateTimeOffset 在此时间之前) 颁发的任何刷新令牌或会话令牌 (会话 Cookie 都无效，并且应用程序在使用无效的刷新令牌或会话令牌获取委托访问令牌时收到错误， (访问 Microsoft Graph) 等 API。 如果发生这种情况，应用程序必须通过请求授权的终结点来获取新的刷新令牌。 只读。 使用 invalidateAllRefreshTokens 进行重置。 继承自 用户。
securityIdentifier 字符串 用户的安全标识符 (SID)，用于 Windows 应用场景。 只读。 默认情况下返回。 继承自 用户。
showInAddressList Boolean 请勿在 Microsoft Graph 中使用。 请改为通过Microsoft 365 管理中心管理此属性。 表示是否应将代理用户包含在 Outlook 全局地址列表中。 请参阅 已知问题。 继承自 用户。
signInSessionsValidFromDateTime DateTimeOffset 在此时间之前) 颁发的任何刷新令牌或会话令牌 (会话 Cookie 都无效，并且应用程序在使用无效的刷新令牌或会话令牌获取委托访问令牌时收到错误， (访问 Microsoft Graph) 等 API。 如果发生这种情况，应用程序必须通过请求授权的终结点来获取新的刷新令牌。 只读。 使用 revokeSignInSessions 进行重置。 继承自 用户。
state String 代理用户地址中的州或省。 最大长度为 128 个字符。 继承自 用户。
streetAddress String 代理用户的营业地点的街道地址。 最大长度为 1024 个字符。 继承自 用户。
surname String 用户的姓氏。 最大长度为 64 个字符。 继承自 用户。
usageLocation String 两个字母组成的国家/地区代码（ISO 标准 3166）。 由于检查国家/地区服务可用性的法律要求，需要为分配许可证的代理用户。 示例包括： US、 JP和 GB。 不可为 null。 继承自 用户。
userPrincipalName String 用户主体名称 (代理用户的 UPN) 。 UPN 是基于 Internet 标准 RFC 822 的用户的 Internet 样式登录名称。 按照约定，这应映射到代理用户的电子邮件名称。 常规格式为alias@domain，其中域必须存在于租户的已验证域集合中。 创建用户时此属性是必需的。 可从 组织 的 verifiedDomains 属性访问租户的已验证域。 注意：此属性不能包含重音字符。 仅支持使用以下字符：A - Z、a - z、0 - 9、' . - _ ! # ^ ~。 有关允许字符的完整列表，请参阅用户名策略。 继承自 用户。
userType String 一个字符串值，可用于对目录中的代理用户类型进行分类。 可能的值为 Member 和 Guest。 注意：有关成员和来宾用户的权限的详细信息，请参阅 Microsoft Entra ID 中的默认用户权限是什么？继承自用户。

关系

重要

虽然此资源类型继承 用户 资源类型中的所有关系，但某些关系不适用于代理用户，并且将始终返回 null 或 默认值。 为清楚起见，下表中排除了这些关系。

关系 类型 说明
appRoleAssignments appRoleAssignment 集合 表示代理用户已为应用程序授予的应用角色。 继承自 用户
directReports directoryObject collection 向代理用户报告的用户和联系人。 (用户和联系人的经理属性设置为此 user.) 只读。 可为 Null。 继承自 用户
manager directoryObject 此代理用户的经理的用户或联系人。 只读。 继承自 用户
memberOf directoryObject collection 代理用户所属的组、目录角色和管理单元。 只读。 可为 Null。 继承自 用户
ownedObjects directoryObject collection 代理用户拥有的目录对象。 只读。 可为 Null。 继承自 用户
赞助商 directoryObject collection 负责此代理用户在租户中的特权的用户和组，并更新代理用户的信息和访问权限。 (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"
}
  • Last updated on