Skip to content

agentidentityblueprint-addpassword.md

Latest commit

 

History

History
98 lines (71 loc) · 3.65 KB

agentidentityblueprint-addpassword.md

File metadata and controls

98 lines (71 loc) · 3.65 KB
title agentIdentityBlueprint: addPassword
description Adds a strong password to an agent identity blueprint. You can also add passwords while creating the blueprint.
author zallison22
ms.date 10/27/2025
ms.localizationpriority medium
ms.subservice entra-agent-id
doc_type apiPageType

agentIdentityBlueprint: addPassword

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Adds a strong password to an agentIdentityBlueprint. You can also add passwords while creating the blueprint by posting to the passwordCredentials collection.

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

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 an optional passwordCredential object with the following properties.

Property Type Description
displayName String Friendly name for the password. Optional.
endDateTime DateTimeOffset The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. The default value is "startDateTime + 2 years".
startDateTime DateTimeOffset The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. The default value is "now".

Response

If successful, this method returns a 200 OK response code and a new passwordCredential object in the response body. The secretText property in the response object contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length. There is no way to retrieve this password in the future.

Examples

The following example shows how to call this API.

Request

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

{
  "passwordCredential": {
    "displayName": "Password friendly name"
  }
}

Response

The following example shows the response.

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

{
    "customKeyIdentifier": null,
    "endDateTime": "2021-09-09T19:50:29.3086381Z",
    "keyId": "f0b0b335-1d71-4883-8f98-567911bfdca6",
    "startDateTime": "2019-09-09T19:50:29.3086381Z",
    "secretText": "[6gyXA5...-TO7g1:h2P8",
    "hint": "[6g",
    "displayName": "Password friendly name"
}