Mettre à jour servicePrincipal

Espace de noms : microsoft.graph

Important

Les API sous la /beta version de Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur de version .

Mettez à jour les propriétés de l’objet serviceprincipal.

Important

L’utilisation d’un correctif pour établir passwordCredential n’est pas prise en charge. Utilisez les méthodes addPassword et removePassword pour mettre à jour le mot de passe ou le secret d’un servicePrincipal.

Autorisations

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire) Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge.
Application Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All

Requête HTTP

PATCH /servicePrincipals/{id}

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez les valeurs pour les champs appropriés qui doivent être mis à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conserveront leurs valeurs précédentes ou seront recalculées en fonction des modifications apportées à d’autres valeurs des propriétés. Pour de meilleures performances, n’incluez pas de valeurs existantes qui n’ont pas changé.

Propriété Type Description
accountEnabled Booléen Valeur true si le compte du principal de service est activé ; sinon, valeur false.
addIns addIn Définit un comportement personnalisé qu’un service d’utilisation peut utiliser pour appeler une application dans des contextes spécifiques. Par exemple, les applications qui peuvent afficher les flux de fichier peuvent spécifier la propriété addIns pour sa fonctionnalité « FileHandler ». Cela permettra aux services tels que Microsoft 365 d’appeler l’application dans le contexte d’un document sur lequel travaille l’utilisateur.
alternativeNames String collection Utilisé pour récupérer les principaux de service par abonnement, identifiez les ID de groupe de ressources et de ressource complète pour les identités gérées.
appRoleAssignmentRequired Booléen Spécifie si un appRoleAssignment à un utilisateur ou groupe est requis avant qu’Azure AD émette un jeton utilisateur ou un jeton d’accès à l’application. N’autorise pas la valeur Null.
appRoles Collection de appRole Les rôles d’application exposés par l’application associée. Pour plus d’informations, voir la définition de propriété appRoles de la ressource de l’application. Ne pouvant accepter la valeur null.
customSecurityAttributes customSecurityAttributeValue Type complexe ouvert qui contient la valeur d’un attribut de sécurité personnalisé affecté à un objet d’annuaire.

Pour mettre à jour cette propriété, le principal appelant doit se voir attribuer le rôle d’Administrateur d’attribution d’attributs et doit avoir l’autorisation CustomSecAttributeAssignment.ReadWrite.All.
displayName Chaîne Le nom d’affichage pour le principal de service.
homepage String Page d’accueil ou page d’accueil de l’application.
keyCredentials Collection keyCredential La collection d’informations d’identification clés associées au principal du service. N’accepte pas la valeur Null.
loginUrl String Indique l’URL où le fournisseur de services redirige l’utilisateur vers Azure AD pour s’authentifier. Azure AD utilise l’URL pour lancer l’application à partir de Microsoft 365 ou de l’Azure AD mes applications. Lorsque ce n’est pas le cas, Azure AD effectue une connexion basée sur IdP pour les applications configurées avec l’authentification unique basée sur SAML. L’utilisateur lance l’application à partir de Microsoft 365, de l’Azure AD My applications (ou de l’URL Azure AD SSO).
logoutUrl String Spécifie l’URL qui sera utilisé par le service d’autorisation de Microsoft pour la déconnexion d’un utilisateur avec les protocoles front-channel, back-channel ou SAML.
notificationEmailAddresses String collection Indique la liste des adresses de courrier où Azure AD envoie une notification lorsque le certificat actif arrive à expiration. Il s’applique uniquement aux certificats utilisés pour signer le jeton SAML émis pour les applications Azure AD Gallery.
publishedPermissionScopes permissionScope collection Les permissions oAuth 2.0 exposées par l’application associée. Pour plus d’informations, voir la définition de propriété oauth2PermissionScopes de la ressource de l’application. Ne pouvant accepter la valeur null.
preferredSingleSignOnMode string Spécifie le mode d’authentification unique configuré pour cette application. Azure AD utilise le mode d’authentification unique par défaut pour lancer l’application à partir de Microsoft 365 ou de l’Azure AD mes applications. Les valeurs prises en charge sont mot de passe, SAML, External et OIDC.
preferredTokenSigningKeyEndDateTime DateTimeOffset Indique la date d’expiration de la keyCredential utilisée pour la signature de jetons, marquée par preferredTokenSigningKeyThumbprint.
preferredTokenSigningKeyThumbprint Chaîne Réservé à une utilisation interne. Ne pas écrire ni dépendre de cette propriété. Risque d’être supprimé dans les versions ultérieures.
publisherName Chaîne Le nom d’affichage du client dans lequel l’application associée est spécifiée.
replyUrls Collection de chaînes Les URL auxquelles les jetons utilisateur sont envoyés pour la connexion à l'application associée, ou les URIs de redirection vers lesquelles les codes d'autorisation et les jetons d'accès OAuth 2.0 sont envoyés pour l'application associée. N’accepte pas la valeur Null.
samlSingleSignOnSettings samlSingleSignOnSettings Collection pour les paramètres liés à l’authentification unique SAML.
servicePrincipalNames String collection Contient la liste de identifiersUris, copiée à partir de l’application associée. D’autres valeurs peuvent être ajoutées à des applications hybrides. Ces valeurs peuvent être utilisées pour identifier les autorisations exposées par cette application dans Azure AD. Par exemple :
  • Les applications clientes demandant l’autorisation d’accès à cette ressource peuvent utiliser ces URIs pour spécifier les autorisations requises dans la propriété requiredResourceAccess de leur manifeste d’application, ou dans la Blade «d’autorisations API » de l’expérience d’inscriptions d’applications.
  • Les applications clientes peuvent spécifier une URI de ressource basée sur les valeurs de cette propriété afin d’acquérir un jeton d’accès, qui est l’URI renvoyé dans la revendication « AUD ».

L’opérateur est requis pour les expressions de filtre sur des propriétés à valeurs multiples. N’accepte pas la valeur Null.
étiquettes Collection de chaînes Ne pouvant accepter la valeur null.
tokenEncryptionKeyId String Spécifie la keyId d’une clé publique de la collection keyCredentials. Lorsque la configuration est configurée, les jetons des problèmes Azure AD pour cette application sont chiffrés à l’aide de la clé spécifiée par cette propriété. Le code d'application qui reçoit le jeton chiffré doit utiliser la clé privée correspondante pour déchiffrer le jeton avant de pouvoir l'utiliser pour l'utilisateur connecté.

Réponse

En cas de réussite, cette méthode renvoie un 204 No Contentcode de réponse et l’objet servicePrincipal mis à jour dans le corps de la réponse.

Exemples

Exemple 1 : mettre à jour les propriétés du principal du service spécifié

Demande

Voici un exemple de demande.

PATCH https://graph.microsoft.com/beta/servicePrincipals/{id}
Content-type: application/json

{
  "appRoleAssignmentRequired": true
}

Réponse

Voici un exemple de réponse. Remarque : l’objet de réponse affiché ici peut être raccourci pour plus de lisibilité.

HTTP/1.1 204 No Content

Exemple 2 : attribuer un attribut de sécurité personnalisé avec une valeur de chaîne à un principal du service

L’exemple suivant montre comment affecter un attribut de sécurité personnalisé avec une valeur de chaîne à un principal du service.

  • Jeu d’attributs : Engineering
  • Attribut : ProjectDate
  • Type de données d’attribut : chaîne
  • Valeur d’attribut : "2022-10-01"

Pour attribuer des attributs de sécurité personnalisés, le principal appelant doit se voir attribuer le rôle d’Administrateur d’attribution d’attributs et doit avoir l’autorisation CustomSecAttributeAssignment.ReadWrite.All.

Pour d’autres exemples similaires pour les utilisateurs, voir Attribuer, mettre à jour ou supprimer des attributs de sécurité personnalisés à l’aide de l’API Microsoft Graph.

Demande

PATCH https://graph.microsoft.com/beta/servicePrincipals/{id}
Content-type: application/json

{
    "customSecurityAttributes":
    {
        "Engineering":
        {
            "@odata.type":"#Microsoft.DirectoryServices.CustomSecurityAttributeValue",
            "ProjectDate":"2022-10-01"
        }
    }
}

Réponse

HTTP/1.1 204 No Content