servicePrincipal : addPassword

Espace de noms: microsoft.graph

Ajoutez un mot de passe ou un secret fort à un objet servicePrincipal .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Application.ReadWrite.All Directory.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Application.ReadWrite.OwnedBy Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All

Requête HTTP

Vous pouvez adresser le principal de service à l’aide de son id ou de son appId. id et appId sont respectivement appelés ID d’objet et ID d’application (client) dans les inscriptions d’applications dans le centre d'administration Microsoft Entra.

POST /servicePrincipals/{id}/addPassword
POST /servicePrincipals(appId='{appId}')/addPassword

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez un objet passwordCredential vide ou avec les propriétés facultatives suivantes.

Propriété Type Description
displayName Chaîne Nom convivial du mot de passe. Optional.
endDateTime DateTimeOffset La date et l’heure d’expiration du mot de passe sont représentées au format ISO 8601 et sont toujours en heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. Optional. La valeur par défaut est « startDateTime + 2 years ».
startDateTime DateTimeOffset Date et heure auxquelles le mot de passe devient valide. Le type d’horodatage représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. Optional. La valeur par défaut est « now ».

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un nouvel objet passwordCredential dans le corps de la réponse. La propriété secretText dans l’objet de réponse contient les mots de passe forts générés par Microsoft Entra ID d’une longueur de 16 à 64 caractères. Il n’existe aucun moyen de récupérer ce mot de passe à l’avenir.

Exemples

L’exemple ci-après montre comment appeler cette API.

Demande

L’exemple suivant illustre une demande.

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

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

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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"
}