更新插入应用程序

命名空间:microsoft.graph

重要

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

如果不存在,请创建新的 应用程序 对象,或更新现有 应用程序 对象的属性。

如果 agentIdentityBlueprint 对象不存在,则此 API 还可以从 agentIdentityBlueprint 创建 agentIdentityBlueprint 对象,或者在 @odata.type 属性设置为 #microsoft.graph.agentIdentityBlueprint时更新现有 agentIdentityBlueprint 的属性。

重要

不支持使用 PATCH 设置 passwordCredential。 使用 addPassword 和 removePassword 方法更新应用程序的密码或密码。

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

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

权限

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

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Application.ReadWrite.All 不可用。
委派(个人 Microsoft 帐户) Application.ReadWrite.All 不可用。
应用程序 Application.ReadWrite.OwnedBy Application.ReadWrite.All

重要

对于使用工作或学校帐户的委派访问权限,必须为管理员分配受支持的 Microsoft Entra 角色或授予此操作所需权限的自定义角色。 此操作支持以下内置角色,这些角色仅提供所需的最小权限:

  • 具有默认用户权限的非管理员成员或来宾,除非 租户管理员限制了访问权限。
  • 应用程序开发人员。 即使管理员限制了对成员和来宾的访问,此角色也可以创建应用。 具有此角色的主体被分配了他们创建的应用的所有权。
  • 目录写入者。 此角色可以更新扩展属性。
  • 混合标识管理员。 此角色只能更新基本属性。
  • 安全管理员
  • 云应用程序管理员
  • 应用程序管理员

在使用工作或学校帐户的委派方案中,支持以下权限来管理代理标识蓝图:

  • 登录用户是所有者,或
  • 为登录用户分配代理 ID 管理员 角色。

HTTP 请求

要创建或更新应用程序,请指定 uniqueName 客户端提供的备用密钥。

PATCH /applications(uniqueName='{uniqueName}')

请求标头

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

请求正文

在请求正文中,提供 应用程序 对象的 JSON 表示形式。 请求正文必须包含 displayName,这是必需的属性。 根据需要为您的应用程序指定其他可写属性,以进行创建或更新。

响应

如果具有 uniqueName 的应用程序或 agentIdentityBlueprint 对象不存在,则此方法将返回响应 201 Created 代码和一个新的 应用程序 或 agentIdentityBlueprint 对象,并在响应正文中分配了 uniqueName 值。

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

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

示例

示例 1:如果应用程序不存在,请创建新应用程序

以下示例创建应用程序是因为不存在具有指定 uniqueName 值的应用程序。

请求

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

PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')
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,
    "isFallbackPublicClient": null,
    "appId": "631a96bc-a705-4eda-9f99-fdaf9f54f6a2",
    "applicationTemplateId": null,
    "identifierUris": [],
    "createdDateTime": "2019-09-17T19:10:35.2742618Z",
    "displayName": "Display name",
    "isDeviceOnlyAuthSupported": null,
    "groupMembershipClaims": null,
    "optionalClaims": null,
    "addIns": [],
    "publisherDomain": "contoso.onmicrosoft.com",
    "samlMetadataUrl": "https://graph.microsoft.com/2h5hjaj542de/app",
    "signInAudience": "AzureADandPersonalMicrosoftAccount",
    "tags": [],
    "tokenEncryptionKeyId": null,
    "api": {
        "requestedAccessTokenVersion": 2,
        "acceptMappedClaims": null,
        "knownClientApplications": [],
        "oauth2PermissionScopes": [],
        "preAuthorizedApplications": []
    },
    "appRoles": [],
    "publicClient": {
        "redirectUris": []
    },
    "info": {
        "termsOfServiceUrl": null,
        "supportUrl": null,
        "privacyStatementUrl": null,
        "marketingUrl": null,
        "logoUrl": null
    },
    "keyCredentials": [],
    "parentalControlSettings": {
        "countriesBlockedForMinors": [],
        "legalAgeGroupRule": "Allow"
    },
    "passwordCredentials": [],
    "requiredResourceAccess": [],
    "uniqueName": "app-65278",
    "web": {
        "redirectUris": [],
        "homePageUrl": null,
        "logoutUrl": null,
        "implicitGrantSettings": {
            "enableIdTokenIssuance": false,
            "enableAccessTokenIssuance": false
        }
    }, 
    "windows" : null
}

示例 2:更新现有应用程序

以下示例更新了应用程序,因为存在具有指定 uniqueName 值的应用程序。

请求

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

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

{
  "displayName": "Display name"
}

响应

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

HTTP/1.1 204 No Content