Upsert 应用程序

  • 项目

命名空间：microsoft.graph

重要

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

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

重要

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

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

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

权限

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

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

HTTP 请求

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

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

请求标头

名称 说明
Authorization 持有者 {token}。 必填。
Content-Type application/json. 必需。
Prefer create-if-missing. 对于 upsert 行为是必需的，否则请求被视为更新操作。

请求正文

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

响应

如果成功，如果不存在具有 uniqueName 的应用程序对象，此方法在 201 Created 响应正文中返回响应代码和新的 应用程序 对象。

如果已存在具有 uniqueName 的应用程序对象，此方法将更新 应用程序 对象并返回 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