Skip to content

agentidentityblueprint-removekey.md

Latest commit

 

History

History
98 lines (71 loc) · 3.46 KB

agentidentityblueprint-removekey.md

File metadata and controls

98 lines (71 loc) · 3.46 KB
title agentIdentityBlueprint: removeKey
description Remove a key credential from an agent identity blueprint.
author zallison22
ms.date 10/27/2025
ms.localizationpriority medium
ms.subservice entra-agent-id
doc_type apiPageType

agentIdentityBlueprint: removeKey

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Remove a key credential from an agentIdentityBlueprint. This method along with addKey can be used to automate rolling its expiring keys.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-agentid-apis-write]

HTTP request

POST /applications/{id}/microsoft.graph.agentIdentityBlueprint/removeKey

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, provide the following required properties.

Property Type Description
keyId Guid The unique identifier for the key.
proof String A self-signed JWT token used as a proof of possession of the existing keys. This JWT token must be signed using the private key of one of the application's existing valid certificates. The token should contain the following claims:
  • aud: Audience needs to be 00000002-0000-0000-c000-000000000000.
  • iss: Issuer needs to be the ID of the application that initiates the request.
  • nbf: Not before time.
  • exp: Expiration time should be the value of nbf + 10 minutes.

For steps to generate this proof of possession token, see Generating proof of possession tokens for rolling keys.

Response

If successful, this action returns a 204 No Content response code.

Examples

Request

The following example shows a request.

HTTP

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

{
  "keyId": "Guid",
  "proof": "String"
}

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 204 No Content