应用程序: addKey

命名空间:microsoft.graph

重要

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

向 应用程序添加密钥凭据。 此方法与 removeKey 一起可用于应用程序自动滚动其即将到期的密钥。

注意

可以继续使用 “创建应用程序 ”和 “更新应用程序 ”操作为任何应用程序添加和更新密钥凭据,无论是否包含用户上下文。

将证书凭据添加到应用程序时,应仅提供公钥值。 向应用程序添加私钥证书可能会危及应用程序。

作为此方法请求验证的一部分,在执行操作之前会验证现有密钥的所有权证明。

没有任何现有有效证书 (尚未添加证书或所有证书已过期) 的应用程序将无法使用此服务操作。 可改用更新应用程序操作来执行更新。

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

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

权限

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

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

注意

应用程序不需要任何特定权限来滚动自己的密钥。

重要

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

  • 具有默认用户权限的非管理员成员用户 - 对于他们拥有的应用程序
  • 应用程序开发人员 - 对于他们拥有的应用程序
  • 云应用程序管理员
  • 应用程序管理员

HTTP 请求

可以使用其 ID 或 appId 来寻址应用程序。 id 和appId 在Microsoft Entra 管理中心中的应用注册中分别称为对象 ID 和应用程序 (客户端) ID。

POST /applications/{id}/addKey
POST /applications(appId='{appId}')/addKey

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

请求正文

在请求正文中,提供以下必需属性。

属性 类型 说明
keyCredential keyCredential 要添加的新应用程序密钥凭据。 类型、用法和键是此用法所需的属性。 支持的密钥类型为:
  • AsymmetricX509Cert:用法必须是 Verify。
  • X509CertAndPassword:用法必须 Sign
passwordCredential passwordCredential 只需设置 secretText ,其中应包含密钥的密码。 仅对于类型的 X509CertAndPassword键,才需要此属性。 将其设置为“ null 否则”。
证明 String 自签名 JWT 令牌,用作拥有现有密钥的证明。 此 JWT 令牌必须使用应用程序现有有效证书之一的私钥进行签名。 令牌应包含以下声明:
  • aud:受众需要是00000002-0000-0000-c000-000000000000
  • iss:颁发者需要是发起请求的 应用程序 的 ID。
  • nbf:不会提前。
  • exp:过期时间应为 nbf + 10 分钟的值。

有关生成此所有权证明令牌的步骤,请参阅 为滚动密钥生成所有权证明令牌。 有关声明类型的详细信息,请参阅 声明有效负载。

响应

如果成功,此方法将在响应正文中返回响应 200 OK 代码和新的 keyCredential 对象。

示例

示例 1: 向应用程序添加新的密钥凭据

请求

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

POST https://graph.microsoft.com/beta/applications/{id}/addKey
Content-type: application/json

{
    "keyCredential": {
        "type": "AsymmetricX509Cert",
        "usage": "Verify",
        "key": "MIIDYDCCAki..."
    },
    "passwordCredential": null,
    "proof":"eyJ0eXAiOiJ..."
}

响应

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

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.keyCredential"
}

示例 2:为密钥添加密钥凭据和关联密码

请求

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

POST https://graph.microsoft.com/beta/applications/{id}/addKey
Content-type: application/json

{
    "keyCredential": {
        "type": "X509CertAndPassword",
        "usage": "Sign",
        "key": "MIIDYDCCAki..."
    },
    "passwordCredential": {
        "secretText": "MKTr0w1..."
    },
    "proof":"eyJ0eXAiOiJ..."
}

响应

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

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.keyCredential"
}