命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
创建新的 agentUser 对象。 还可以通过使用 POST /users 终结点并在请求正文中指定 microsoft.graph.agentUser 类型来创建代理用户。
必须至少指定所需的属性。 可以选择指定其他任意可写属性。
默认情况下,此作仅返回每个 agentUser 的属性子集。 这些默认属性将记录在属性部分中。 若要获取非默认返回的属性,请执行 GET 操作,并在 $select OData 查询选项中指定这些属性。
此 API 可用于以下国家级云部署。
| 全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 | 最低特权权限 | 更高特权权限 |
|---|---|---|
| 委派(工作或学校帐户) | AgentIdUser.ReadWrite.IdentityParentedBy | AgentIdUser.ReadWrite.All、User.ReadWrite.All |
| 委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
| 应用程序 | AgentIdUser.ReadWrite.IdentityParentedBy | AgentIdUser.ReadWrite.All、User.ReadWrite.All |
重要
AgentIdentity* 权限当前无法通过Microsoft Entra 管理中心上的 API 权限体验获得同意。 若要使用这些权限,可以通过Microsoft图形 API调用来同意这些权限,如以编程方式授予或撤销 API 权限中所述。 有关这些 权限的详细信息,请参阅管理代理标识 的权限。
在具有工作或学校帐户的委派方案中,必须为管理员分配受支持的Microsoft Entra角色或具有受支持角色权限的自定义角色。 此作支持以下最低特权角色。
- 代理 ID 管理员
HTTP 请求
POST /users/microsoft.graph.agentUser
提示
还可以通过 POST /users 创建代理用户, microsoft.graph.agentUser 而无需指定类型。 但是, "@odata.type": "microsoft.graph.agentUser" 必须与创建用户所需的其他属性一起在请求正文中指定。
请求标头
| 标头 | 值 |
|---|---|
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type | application/json |
请求正文
在请求正文中,提供 agentUser 对象的 JSON 表示形式。
下表列出了创建 agentUser 时所需的属性。
| 参数 | 类型 | 说明 |
|---|---|---|
| accountEnabled | Boolean | 启用帐户时为 true,否则为 false。 |
| displayName | String | 要显示在代理用户的通讯簿中的名称。 |
| mailNickname | String | 代理用户的邮件别名。 |
| userPrincipalName | String | 用户主体名称 (someagent@contoso.com) 。 它是基于 Internet 标准 RFC 822 的代理用户的 Internet 样式登录名。 按照约定,这应映射到代理用户的电子邮件名称。 常规格式是 alias@domain,其中 domain 必须位于租户的已验证域集合中。 可从 组织 的 verifiedDomains 属性访问租户的已验证域。 注意:此属性不能包含突出字符。 仅支持使用以下字符: A - Z、a - z、0 - 9、 ' . - _ ! # ^ ~。 有关允许字符的完整列表,请参阅用户名策略。 |
| identityParentId | String | 关联 代理标识的对象 ID。 必填。 |
由于此资源支持 扩展,因此可以使用 POST 作并在创建时将具有自己的数据的自定义属性添加到代理用户实例。
响应
如果成功,此方法在 201 Created 响应正文中返回响应代码和 agentUser 对象。
尝试使用已链接到另一个 agentUser 的 identityParentId 创建 agentUser 将返回错误 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"
}