通过

Upsert agentIdentityBlueprint

命名空间：microsoft.graph

重要

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

创建新的 代理标识蓝图 对象（如果不存在），或更新现有对象的属性。

重要

不支持使用 PATCH 设置 passwordCredential。 使用 addPassword 和 removePassword 方法更新代理标识蓝图的密码或机密。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ✅

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） AgentIdentityBlueprint.ReadWrite.All Directory.ReadWrite.All
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 AgentIdentityBlueprint.ReadWrite.All Directory.ReadWrite.All

重要

AgentIdentity* 权限当前无法通过Microsoft Entra 管理中心上的 API 权限体验获得同意。 若要使用这些权限，可以通过Microsoft图形 API调用来同意这些权限，如以编程方式授予或撤销 API 权限中所述。 有关这些 权限的详细信息，请参阅管理代理标识 的权限。

使用委托权限时，必须为经过身份验证的用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 此作支持以下最低特权角色。

  • 代理 ID 管理员。
  • 代理 ID 开发人员 - 创建代理标识蓝图。 具有此角色的主体被分配为其创建的蓝图的所有权，并且可以对该蓝图执行写入作。

HTTP 请求

若要创建或更新应用程序，请指定 uniqueName 客户端提供的备用键。

PATCH /applications(uniqueName='{uniqueName}')/microsoft.graph.agentIdentityBlueprint

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。
Prefer create-if-missing. 对于 upsert 行为是必需的，否则请求被视为更新作。

请求正文

在请求正文中，提供 agentIdentityBlueprint 对象的 JSON 表示形式。 请求正文必须包含 displayName，这是必需属性。 为 agentIdentityBlueprint 指定其他可写属性，以便创建或更新。

响应

如果不存在具有 uniqueName 的对象，此方法在响应正文中返回响应 201 Created 代码和新的代理标识蓝图对象。 为代理标识蓝图分配了 uniqueName 值。

如果 不存在具有 uniqueName 的对象， Prefer: create-if-missing 并且 未 指定标头，则此方法将 404 Not Found 返回错误代码。

如果已存在具有 uniqueName 的应用程序对象，此方法将更新该对象并返回 204 No Content 响应代码。

有关代理标识 API 返回的错误的信息，请参阅 代理标识错误代码。

示例

请求

以下示例显示了一个请求。

PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')/microsoft.graph.agentIdentityBlueprint
Content-Type: application/json
Prefer: create-if-missing

{
  "displayName": "Display name"
}

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications/$entity",
    "id": "03ef14b0-ca33-4840-8f4f-d6e91916010e",
    "deletedDateTime": null,
    "appId": "00001111-aaaa-2222-bbbb-3333cccc4444",
    "identifierUris": [],
    "createdDateTime": "2019-09-17T19:10:35.2742618Z",
    "displayName": "Display name",
    "groupMembershipClaims": null,
    "optionalClaims": null,
    "publisherDomain": "contoso.onmicrosoft.com",
    "signInAudience": "AzureADandPersonalMicrosoftAccount",
    "tags": [],
    "tokenEncryptionKeyId": null,
    "api": {
        "requestedAccessTokenVersion": 2,
        "acceptMappedClaims": null,
        "knownClientApplications": [],
        "oauth2PermissionScopes": [],
        "preAuthorizedApplications": []
    },
    "appRoles": [],
    "info": {
        "termsOfServiceUrl": null,
        "supportUrl": null,
        "privacyStatementUrl": null,
        "marketingUrl": null,
        "logoUrl": null
    },
    "keyCredentials": [],
    "passwordCredentials": [],
    "uniqueName": "app-65278",
    "web": {
        "redirectUris": [],
        "homePageUrl": null,
        "logoutUrl": null,
        "implicitGrantSettings": {
            "enableIdTokenIssuance": false,
            "enableAccessTokenIssuance": false
        }
    }, 
}
  • Last updated on