Skip to content

application-addpassword.md

Latest commit

 

History

History
147 lines (108 loc) · 5.93 KB

application-addpassword.md

File metadata and controls

147 lines (108 loc) · 5.93 KB
title application: addPassword
description Add a strong password to an application.
ms.localizationpriority medium
author Jackson-Woods
ms.subservice entra-applications
doc_type apiPageType
ms.date 04/16/2024

application: addPassword

Namespace: microsoft.graph

Adds a strong password or secret to an application. You can also add passwords while creating the application.

[!INCLUDE national-cloud-support]

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-apps-serviceprincipal-creds-apis]

HTTP request

You can address the application using either its id or appId. id and appId are referred to as the Object ID and Application (Client) ID, respectively, in app registrations in the Microsoft Entra admin center.

POST /applications/{id}/addPassword
POST /applications(appId='{appId}')/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/secrets 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

The following example shows a request. The id that is specified in the request is the value of the id property of the application, not the value of the appId property.

HTTP

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

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

C#

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

Go

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

Java

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

JavaScript

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

PHP

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

PowerShell

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

Python

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

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": "[6gyXA5S20@MN+WRXAJ]I-TO7g1:h2P8",
    "hint": "[6g",
    "displayName": "Password friendly name"
}