Skip to content

agentidentityblueprint-addkey.md

Latest commit

 

History

History
127 lines (93 loc) · 5.34 KB

agentidentityblueprint-addkey.md

File metadata and controls

127 lines (93 loc) · 5.34 KB
title agentIdentityBlueprint: addKey
description Add a key credential to an agent identity blueprint. This method, along with removeKey, can be used to automate rolling its expiring keys.
author zallison22
ms.date 10/27/2025
ms.localizationpriority medium
ms.subservice entra-agent-id
doc_type apiPageType

agentIdentityBlueprint: addKey

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Add a key credential to an agentIdentityBlueprint. This method, along with removeKey, can be used to automate rolling its expiring keys.

Note

You should only provide the public key value when adding a certificate credential to your application. Adding a private key certificate to your application risks compromising the application.

As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed.

Agent identity blueprints that don't have any existing valid certificates (no certificates have been added yet, or all certificates have expired), won't be able to use this service action. You can use the Update agent identity blueprint operation to perform an update instead.

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/addKey

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, supply a JSON representation of the parameters. The following table lists the parameters that are required when you call this action.

Property Type Description
keyCredential keyCredential The new application key credential to add. The type, usage and key are required properties for this usage. Supported key types are:
  • AsymmetricX509Cert: The usage must be Verify.
  • X509CertAndPassword: The usage must be Sign
passwordCredential passwordCredential Only secretText is required to be set which should contain the password for the key. This property is required only for keys of type X509CertAndPassword. Set it to null otherwise.
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. For more information about the claim types, see Claims payload.

Response

If successful, this action returns a 200 OK response code and a keyCredential in the response body.

Examples

Request

The following example shows a request.

HTTP

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

{
  "keyCredential": {
    "@odata.type": "microsoft.graph.keyCredential"
  },
  "passwordCredential": {
    "@odata.type": "microsoft.graph.passwordCredential"
  },
  "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 200 OK
Content-Type: application/json

{
  "value": {
    "@odata.type": "microsoft.graph.keyCredential"
  }
}