命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
表示 Entra ID 目录中的代理标识。 代理标识是 AI 代理用于在Microsoft Entra ID生态系统中进行身份验证的帐户。
继承自 servicePrincipal。
此资源是一种开放类型,它允许除此处所述的属性之外的其他属性。
方法
| 方法 | 返回类型 | Description |
|---|---|---|
| List | agentidentity 集合 | 获取 agentidentity 对象及其属性的列表。 |
| 创建 | agentidentity | 创建新的 agentidentity 对象。 |
| Get | agentIdentity | 读取 agentIdentity 对象的属性和关系。 |
| 更新 | agentIdentity | 更新 agentIdentity 对象的属性。 |
| 应用角色分配 | ||
| 列出 appRoleAssignedTo | appRoleAssignment 集合 | 获取为此代理标识分配的用户、组和代理标识的应用角色。 |
| 列出 appRoleAssignments | appRoleAssignment 集合 | 获取分配此代理标识的应用角色。 |
| 创建 appRoleAssignment | appRoleAssignment | 创建新的 appRoleAssignment 对象。 |
| 删除 appRoleAssignment | appRoleAssignment | 删除现有的 appRoleAssignment 对象。 |
| 委派权限授予 | ||
| List oauth2PermissionGrants | oAuth2PermissionGrant 集合 | 获取授权此代理标识代表已登录用户访问 API 的委托权限。 |
| 已删除项目 | ||
| List | directoryObject collection | 检索最近删除的代理标识的列表。 |
| Get | directoryObject | 检索最近删除的代理标识的属性。 |
| 还原 | directoryObject | 还原最近删除的代理标识。 |
| 永久删除 | 无 | 永久删除代理标识。 |
| 目录对象 | ||
| List ownedObjects | directoryObject collection | 获取此代理标识拥有的目录对象。 |
| Memberships | ||
| 列出直接成员身份 | directoryObject collection | 获取此代理标识是其直接成员的组。 |
| 列出可传递成员身份 | directoryObject collection | 获取此代理标识所属的组。 此作是可传递的,包括此代理标识是嵌套成员的组。 |
| Owners | ||
| List owners | directoryObject 集合 | 获取此代理标识的所有者。 |
| 添加所有者 | directoryObject | 通过发布到所有者集合来添加所有者。 |
| 删除所有者 | 无 | 删除 directoryObject 对象。 |
| 赞助商 | ||
| 列出赞助商 | directoryObject collection | 获取此代理标识的发起人。 |
| 添加赞助商 | directoryObject | 通过发布到赞助商集合来添加赞助商。 |
| 删除赞助商 | 无 | 删除 directoryObject 对象。 |
属性
重要
虽然此资源继承自 servicePrincipal,但某些属性不适用。
| 属性 | 类型 | 说明 |
|---|---|---|
| odata.type | String |
#microsoft.graph.agentIdentity. 将此对象区分为代理标识。 可用于将此对象标识为代理标识,而不是另一种服务主体。 |
| accountEnabled | Boolean |
true 如果启用了代理标识帐户,则为 ;否则为 false。 如果设置为 false,则任何用户都无法登录到此应用,即使他们已分配到此应用。 继承自 servicePrincipal。 |
| agentIdentityBlueprintId | String | 用于定义此代理标识配置的代理标识蓝图的 appId 。 |
| customSecurityAttributes | customSecurityAttributeValue | 保留分配给目录对象的自定义安全属性的值的开放式复杂类型。 可为 NULL。 仅在 $select 上返回。 继承自 servicePrincipal。 |
| createdByAppId | 字符串 | 用于创建代理标识的应用程序的 appId 。 通过Microsoft Entra ID在内部设置。 只读。 继承自 servicePrincipal。 |
| createdDateTime | DateTimeOffset | 创建代理标识的日期和时间。 只读。 继承自 servicePrincipal。 |
| disabledByMicrosoftStatus | String | 指定Microsoft是否已禁用已注册的代理标识蓝图。 可能的值为: null (默认值) NotDisabled, (DisabledDueToViolationOfServicesAgreement 原因可能包括可疑、滥用或恶意活动,或违反Microsoft服务协议) 。 继承自 servicePrincipal。 |
| displayName | String | 代理标识的显示名称。 继承自 servicePrincipal。 |
| id | String | 代理标识的唯一标识符。 继承自 directoryObject。 键。 不可为 null。 只读。 继承自 entity。 |
| servicePrincipalType | String | 对于所有代理标识,设置为 ServiceIdentity 。 继承自 servicePrincipal。 |
| tags | 字符串集合 | 可用于对代理标识进行分类和标识的自定义字符串。 不可为 null。 该值是此处和关联的代理标识蓝图实体的 tags 属性上设置的字符串的并集。 继承自 servicePrincipal。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| appRoleAssignedTo | appRoleAssignment 集合 | 此应用或服务的应用角色分配,授予用户、组和其他代理标识。 支持 $expand。 继承自 microsoft.graph.servicePrincipal |
| appRoleAssignments | appRoleAssignment 集合 | 授予此代理标识的另一个应用或服务的应用角色分配。 支持 $expand。 继承自 microsoft.graph.servicePrincipal |
| createdObjects | directoryObject collection | 此代理标识创建的目录对象。 只读。 可为 Null。 继承自 microsoft.graph.servicePrincipal |
| memberOf | directoryObject collection | 此代理标识所属的角色。 HTTP 方法:GET 只读。 可为空。 支持 $expand。 继承自 microsoft.graph.servicePrincipal |
| oauth2PermissionGrants | oAuth2PermissionGrant 集合 | 委派权限授予此代理标识代表已登录用户访问 API 的授权。 只读。 可为 Null。 继承自 microsoft.graph.servicePrincipal |
| ownedObjects | directoryObject collection | 此代理标识拥有的目录对象。 只读。 可为 NULL。 支持 $expand 和 $filter (/$count eq 0、 /$count ne 0、 /$count eq 1) /$count ne 1 。 继承自 microsoft.graph.servicePrincipal |
| owners | directoryObject collection | 作为此代理标识所有者的目录对象。 所有者是一组允许修改此对象的非管理员用户或代理标识。 支持 $expand 和 $filter (/$count eq 0、 /$count ne 0、 /$count eq 1) /$count ne 1 。 继承自 microsoft.graph.servicePrincipal |
| 赞助商 | directoryObject collection | 此代理标识的发起人。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。 默认情况下,仅返回所有属性的子集。 只能使用 $select 检索所有其他属性。
{
"@odata.type": "#microsoft.graph.agentIdentity",
"id": "String (identifier)",
"accountEnabled": "Boolean",
"agentIdentityBlueprintId": "String",
"createdByAppId": "String",
"createdDateTime": "String (timestamp)",
"disabledByMicrosoftStatus": "String",
"displayName": "String",
"servicePrincipalType": "String",
"tags": [
"String"
]
}