应用程序: removeKey

命名空间:microsoft.graph

重要

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

从 应用程序中删除密钥凭据。 此方法与 addKey 一起使用,应用程序可以用来自动滚动其即将到期的密钥。

注意

创建服务主体 和更新服务 主体 操作可以继续用于为具有应用程序或用户上下文的任何应用程序添加和更新密钥凭据。

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

此 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}/removeKey
POST /applications(appId='{appId}')/removeKey

请求标头

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

请求正文

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

属性 类型 说明
keyId Guid 密码的唯一标识符。
证明 String 自签名 JWT 令牌,用作拥有现有密钥的证明。 此 JWT 令牌必须使用应用程序现有有效证书之一的私钥进行签名。 令牌应包含以下声明:
  • aud:受众需要是00000002-0000-0000-c000-000000000000
  • iss:颁发者需要是发起请求的 应用程序 的 ID。
  • nbf:不会提前。
  • exp:过期时间应为 nbf + 10 分钟的值。

有关生成此所有权证明令牌的步骤,请参阅 为滚动密钥生成所有权证明令牌。

响应

如果成功,此方法返回 204 No content 响应代码。

示例

下面的示例演示如何调用此 API。

请求

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

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

{
    "keyId": "f0b0b335-1d71-4883-8f98-567911bfdca6",
    "proof":"eyJ0eXAiOiJ..."
}

响应

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

HTTP/1.1 204 No Content