application: addPassword
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Fügt einer Anwendung ein sicheres Kennwort hinzu. Sie können beim Erstellen der Anwendung auch Kennwörter hinzufügen.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
Globaler Dienst | US Government L4 | US Government L5 (DOD) | China, betrieben von 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Berechtigungen
Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
Berechtigungstyp | Berechtigungen mit den geringsten Berechtigungen | Berechtigungen mit höheren Berechtigungen |
---|---|---|
Delegiert (Geschäfts-, Schul- oder Unikonto) | Application.ReadWrite.All | Directory.ReadWrite.All |
Delegiert (persönliches Microsoft-Konto) | Application.ReadWrite.All | Nicht verfügbar. |
App | Application.ReadWrite.OwnedBy | Application.ReadWrite.All, Directory.ReadWrite.All |
HTTP-Anforderung
Sie können die Anwendung entweder mit ihrer ID oder appId adressieren. id und appId werden in App-Registrierungen im Microsoft Entra Admin Center als Objekt-ID bzw. Anwendungs-ID (Client-ID) bezeichnet.
POST /applications/{id}/addPassword
POST /applications(appId='{appId}')/addPassword
Anforderungsheader
Name | Beschreibung |
---|---|
Authorization | Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung. |
Content-Type | application/json. Erforderlich. |
Anforderungstext
Geben Sie im Anforderungstext ein optionales passwordCredential
-Objekt mit den folgenden Eigenschaften an.
Eigenschaft | Typ | Beschreibung |
---|---|---|
displayName | String | Anzeigename für das Kennwort. Optional. |
endDateTime | DateTimeOffset | Das Datum und die Uhrzeit, zu dem das Kennwort abläuft, wird im ISO 8601-Format dargestellt und ist immer in UTC-Zeit angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z . Optional. Der Standardwert ist "startDateTime + 2 Years". |
startDateTime | DateTimeOffset | Das Datum und die Uhrzeit, zu dem das Kennwort gültig wird. Der Timestamp-Typ stellt die Datums- und Uhrzeitinformationen mithilfe des ISO 8601-Formats dar und wird immer in UTC-Zeit angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z . Optional. Der Standardwert ist "now". |
Antwort
Bei erfolgreicher Ausführung gibt die Methode den 200 OK
Antwortcode und ein neues passwordCredential-Objekt im Antworttext zurück. Die secretText-Eigenschaft im Antwortobjekt enthält die sicheren Kennwörter, die von Microsoft Entra ID generiert werden und 16 bis 64 Zeichen lang sind. Es gibt keine Möglichkeit, dieses Kennwort in Zukunft abzurufen.
Beispiele
Das folgende Beispiel illustriert, wie Sie diese API aufrufen können.
Anforderung
Das folgende Beispiel zeigt eine Anfrage. Die id, die in der Anforderung angegeben wird, ist der Wert der id-Eigenschaft der Anwendung, nicht der Wert der appId-Eigenschaft.
POST https://graph.microsoft.com/beta/applications/{id}/addPassword
Content-type: application/json
{
"passwordCredential": {
"displayName": "Password friendly name"
}
}
Antwort
Das folgende Beispiel zeigt die Antwort.
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"
}