Type de ressource servicePrincipal
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta dans 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 Version .
Représente une instance d’une application dans un répertoire. Hérite de directoryObject.
Cette ressource prend en charge l’utilisation d’une requête delta pour effectuer un suivi des suppressions, des mises à jour et des ajouts incrémentiels à l’aide d’une fonction delta. Cette ressource est un type ouvert qui permet de transmettre d’autres propriétés.
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| List | Collection servicePrincipal | Récupérer une liste d’objets servicePrincipal. |
| Create | servicePrincipal | Créer un nouvel objet servicePrincipal. |
| Obtenir | servicePrincipal | Lit les propriétés et les relations de l’objet serviceprincipal. |
| Mettre à jour | Aucun | Mettre à jour l’objet servicePrincipal. |
| Upsert | servicePrincipal | Créez un servicePrincipal s’il n’existe pas ou mettez à jour les propriétés d’un servicePrincipal existant. |
| Supprimer | Aucun | Supprimer l’objet servicePrincipal. |
| Obtenir delta | Collection servicePrincipal | Obtenez des modifications incrémentielles des principaux de service. |
| Répertorier les objets créés | collection directoryObject | Procurez-vous une collection d’objets createdObject. |
| Répertorier les objets possédés | collection directoryObject | Obtenir une collection d’objets ownedObject. |
| Éléments supprimés | ||
| List | collection directoryObject | Récupérer une liste d’objets servicePrincipal |
| Obtenir | directoryObject | Récupérer les propriétés et les relations de l’objetservicePrincipal |
| Restaurer | directoryObject | Restaurer un objet servicePrincipal récemment supprimé |
| Supprimer définitivement | Aucun | Supprimer définitivement un objet servicePrincipal |
| Attribution de rôle d’application | ||
| Liste des appRoleAssignments | Collection appRoleAssignment | Obtenez les rôles d’application attribués à ce principal de service. |
| Ajouter appRoleAssignment | appRoleAssignment | Affecter un rôle d’application à ce principal de service. |
| Supprimer appRoleAssignment | Aucun | Supprimer une affectation de rôle d’application de ce principal de service. |
| Liste appRoleAssignedTo | Collection appRoleAssignment | Obtenir les rôles d’application attribués aux utilisateurs, groupes et principaux de service pour ce principal de service. |
| Ajouter appRoleAssignedTo | appRoleAssignment | Affectez un rôle d’application pour ce principal de service à un utilisateur, à un groupe ou à un principal de service. |
| Supprimer appRoleAssignedTo | Aucun | Supprimez une affectation de rôle d’application pour ce principal de service auprès d’un utilisateur, d’un groupe ou d’un principal de service. |
| Certificats et secrets | ||
| Ajouter un mot de passe | passwordCredential | Ajouter un mot de passe fort ou un secret à un servicePrincipal. |
| Supprimer le mot de passe | passwordCredential | Supprimer un mot de passe ou un secret d’un servicePrincipal. |
| Touche Ajouter | keyCredential | Ajouter une clé d’identification à une servicePrincipal. |
| Supprimer la touche | Aucun | Supprimer une information d’identification clé d’un servicePrincipal. |
| Ajouter un certificat de signature de jeton | selfSignedCertificate | Ajoutez un certificat auto-signé au principal du service. Utilisez principalement pour configurer des applications d’authentification unique SAML à partir de la galerie Microsoft Entra. |
| Classifications d’autorisations déléguées | ||
| List | Collection delegatedPermissionClassification | Obtenez les classifications d’autorisations pour les autorisations déléguées exposées par ce principal de service. |
| Add | delegatedPermissionClassification | Ajouter une classification d’autorisation pour une autorisation déléguée exposée par ce principal de service. |
| Remove | Aucun | Supprimer une classification d’autorisation pour une autorisation déléguée exposée par ce principal de service. |
| Octrois d’autorisations déléguées (OAuth2) | ||
| List | Collection oAuth2PermissionGrant | Obtenir les autorisations déléguées octroyant l’autorisation à ce principal de service d’accéder à une API au nom d’un utilisateur connecté. |
| Appartenance | ||
| Répertorier memberOf | collection directoryObject | Obtient les groupes dont ce principal de service est un membre direct, à partir de la propriété de navigation memberOf. |
| Lister le membre transitif de | collection directoryObject | Liste de groupes dont ce principal de service est membre. Cette opération est transitive et comprend les groupes dont ce principal de service est un membre imbriqué. |
| Vérifier des groupes de membres | Collection de chaînes | Vérifiez les appartenances dans une liste de groupes spécifiée. |
| Vérifier les objets membres | Collection de chaînes | Vérifiez l'appartenance à une liste spécifiée d'objets de groupes, de rôles d'annuaire ou d'unité administrative. |
| Obtenir des groupes de membres | Collection de chaînes | Obtenez la liste de groupes dont ce principal de service est membre. |
| Obtenir des objets de membre | String collection | Obtenir la liste des groupes, des unités administratives et des rôles d’annuaire dont ce principal de service est membre. |
| Propriétaires | ||
| List | collection directoryObject | Obtenez les propriétaires d’un principal de service. |
| Add | directoryObject | Affecter un propriétaire à un principal de service. Les propriétaires de principal de service peuvent être des utilisateurs ou d’autres principaux de service. |
| Remove | Aucun | Supprimer un propriétaire d’un principal de service. Comme meilleure pratique recommandée, les principaux de service doivent avoir au moins deux propriétaires. |
| Informations d’identification de l’authentification unique par mot de passe | ||
| Create | passwordSingleSignOnCredentialSet | Créez un ensemble de références pour l’utilisateur ou le groupe spécifié dans le corps du message. |
| Obtenir | passwordSingleSignOnCredentialSet | Obtenez un ensemble de références pour l’utilisateur ou le groupe spécifié dans le corps du message. |
| Mettre à jour | Aucun | Mettez à jour un ensemble de références pour l’utilisateur ou le groupe spécifié dans le corps du message. |
| Supprimer | Aucun | Supprimez un ensemble de références pour l’utilisateur ou le groupe spécifié dans le corps du message. |
Propriétés
Importante
L’utilisation spécifique de $filter et du paramètre de requête $search n’est prise en charge que lorsque vous utilisez l’en-tête ConsistencyLevel défini sur eventual et $count. Pour plus d’informations, consultez Fonctionnalités de requête avancées sur les objets d’annuaire.
| Propriété | Type | Description |
|---|---|---|
| accountEnabled | Boolean | Valeur true si le compte du principal de service est activé ; sinon, valeur false. Si la falsevaleur est définie sur , aucun utilisateur ne peut se connecter à cette application, même s’il lui est affecté. Prend en charge $filter (eq, ne, not, in). |
| addIns | Collection 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 permet à des services tels que Microsoft 365 d’appeler l’application dans le contexte d’un document sur lequel l’utilisateur travaille. |
| alternativeNames | String collection | Permet de récupérer les principaux de service par abonnement, d’identifier les ID de groupe de ressources et de ressources complètes pour les identités managées. Prend en charge $filter (eq, not, ge, le, startsWith). |
| appDescription | String | La description présentée par l’application associée. |
| appDisplayName | Chaîne | Le nom d’affichage exposé par l’application associée. Longueur maximale : 256 caractères. |
| appId | Chaîne | L’identificateur unique de l’application associée (sa propriété appId). Autre clé. Prend en charge $filter (eq, ne, not, in, startsWith). |
| applicationTemplateId | String | Identificateur unique de l’applicationTemplate. Prend en charge $filter (eq, not, ne). En lecture seule.
null si l’application n’a pas été créée à partir d’un modèle d’application. |
| appOwnerOrganizationId | Guid | Contient l’ID de locataire où l’application est inscrite. Applicable uniquement aux entités de service sauvegardées par les applications. Prend en charge $filter (eq, ne, NOT, ge, le). |
| appRoleAssignmentRequired | Booléen | Spécifie si des utilisateurs ou d’autres entités de service doivent se voir octroyer une affectation de rôle d’application pour ce principal de service avant que les utilisateurs puissent se connecter ou que les applications puissent obtenir des jetons. La valeur par défaut est false. Ne peut pas accepter une valeur null. Prend en charge $filter (eq, ne, NOT). |
| appRoles | Collection de appRole | Rôles exposés par l’application, que ce principal de service représente. Pour plus d’informations, consultez la définition de propriété appRoles sur l’entité d’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. Pouvant accepter la valeur Null. Renvoyé uniquement sur $select. Prend en charge $filter (eq, ne, not, startsWith). La valeur de filtre respecte la casse. |
| deletedDateTime | DateTimeOffset | Date et heure de suppression du principal de service. En lecture seule. |
| description | String | Champ de texte gratuit pour fournir une description interne pour l’utilisateur final du principal du service. Les portails des utilisateurs finaux tels que MyApps affichent la description de l’application dans ce champ. La taille maximale autorisée est de 1 024 caractères. Prend en charge $filter (eq, ne, not, ge, le, startsWith, $search). |
| disabledByMicrosoftStatus | String | Spécifie si Microsoft a désactivé l’application inscrite. Les valeurs possibles sont les suivantes : null (valeur par défaut), NotDisabledet DisabledDueToViolationOfServicesAgreement (les raisons peuvent inclure des activités suspectes, abusives ou malveillantes, ou une violation du Contrat de services Microsoft). Prend en charge $filter (eq, ne, not). |
| displayName | Chaîne | Le nom d’affichage pour le principal de service. Prend en charge $filter (eq, ne, not, ge, le, in, startsWithet eq sur null valeurs), $searchet $orderby. |
| errorUrl | String | Déconseillé. Ne pas utiliser. |
| homepage | String | Page d’accueil ou page d’accueil de l’application. |
| id | String | Identificateur unique du principal de service. Hérité de directoryObject. Clé. Ne peut pas avoir la valeur Null. En lecture seule. Prend en charge $filter (eq, ne, not, in). |
| info | informationalUrl | Les informations de profil de base de l’application acquise, telles que le marketing de l’application, le support, les conditions d’utilisation et les URL de déclaration de confidentialité. Les conditions d’utilisation et la déclaration de confidentialité sont présentées aux utilisateurs par le biais de l’expérience de consentement de l’utilisateur. Pour plus d’informations, consultez Guide pratique pour ajouter des conditions d’utilisation et déclaration de confidentialité pour les applications Microsoft Entra inscrites. Prend en charge $filter (eq, ne, not, ge, leet eq sur null valeurs). |
| keyCredentials | Collection keyCredential | Collection d’informations d’identification clées associées au principal de service. Ne pouvant accepter la valeur null. Prend en charge $filter (eq, not, ge, le). |
| loginUrl | String | Spécifie l’URL où le fournisseur de services redirige l’utilisateur vers Microsoft Entra ID pour s’authentifier. Microsoft Entra ID utilise l’URL pour lancer l’application à partir de Microsoft 365 ou du Microsoft Entra Mes applications. Lorsqu’il est vide, Microsoft Entra ID effectue l’authentification lancée par le fournisseur d’identité pour les applications configurées avec l’authentification unique SAML. L’utilisateur lance l’application à partir de Microsoft 365, du Microsoft Entra Mes applications ou de l’URL d’authentification unique Microsoft Entra. |
| logoutUrl | String | Spécifie l’URL que le service d’autorisation de Microsoft utilise pour déconnecter un utilisateur à l’aide des protocoles de déconnexion front-channel, back-channel ou SAML OpenId Connect. |
| notes | String | Champ de texte gratuit pour capturer des informations sur le principal du service, généralement utilisé à des fins opérationnelles. La taille maximale autorisée est de 1 024 caractères. |
| notificationEmailAddresses | String collection | Spécifie la liste des adresses e-mail où Microsoft Entra ID envoie une notification lorsque le certificat actif est proche de la date d’expiration. Il s’agit uniquement des certificats utilisés pour signer le jeton SAML émis pour les applications Microsoft Entra Gallery. |
| passwordCredentials | Collection passwordCredential | Collection d’informations sur les mots de passe associées au principal de service. Ne pouvant accepter la valeur null. |
| passwordSingleSignOnSettings | passwordSingleSignOnSettings | Collection pour les paramètres liés à l’authentification unique de mot de passe. Utilisez $select=passwordSingleSignOnSettings pour lire la propriété. En lecture seule pour applicationTemplates sauf pour les applicationTemplates personnalisés. |
| preferredSingleSignOnMode | string | Spécifie le mode d’authentification unique configuré pour cette application. Microsoft Entra ID utilise le mode d’authentification unique préféré pour lancer l’application à partir de Microsoft 365 ou du Microsoft Entra Mes applications. Les valeurs prises en charge sont : password, saml, notSupported et oidc.
Note: Ce champ peut concerner null les applications SAML plus anciennes et les applications OIDC où il n’est pas défini automatiquement. |
| permissionGrantPreApprovalPolicies | collection permissionGrantPreApprovalPolicy | Liste des stratégies de préapprobation qui ont été affectées au principal de service. |
| preferredTokenSigningKeyEndDateTime | DateTimeOffset | Indique la date d’expiration de la keyCredential utilisée pour la signature de jetons, marquée par preferredTokenSigningKeyThumbprint. La mise à jour de cet attribut n’est pas prise en charge actuellement. Pour plus d’informations, consultez Différences des propriétés ServicePrincipal. |
| preferredTokenSigningKeyThumbprint | Chaîne | Cette propriété peut être utilisée sur les applications SAML (applications qui ont la valeurreferredSingleSignOnModesaml) pour contrôler le certificat utilisé pour signer les réponses SAML. Pour les applications qui ne sont pas SAML, n’écrivez pas ou ne vous fiez pas à cette propriété. |
| publishedPermissionScopes | permissionScope collection | Autorisations déléguées exposées par l’application. Pour plus d’informations, consultez la propriété oauth2PermissionScopes sur la propriété API de l’entité d’application. Ne pouvant accepter la valeur null. Remarque : Cette propriété est nommée oauth2PermissionScopes dans la version 1.0. |
| publisherName | Chaîne | Nom du locataire Microsoft Entra qui a publié l’application. |
| replyUrls | Collection de chaînes | Les URL auxquelles les jetons utilisateur sont envoyés pour se connecter avec l'application associée, ou les URI 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. Ne peut pas accepter une valeur null. |
| samlMetadataUrl | String | URL dans laquelle le service affiche les métadonnées SAML pour la fédération. |
| 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 aux applications hybrides. Ces valeurs peuvent être utilisées pour identifier les autorisations exposées par cette application dans Microsoft Entra ID. Par exemple,
L’opérateur est requis pour les expressions de filtre sur des propriétés à valeurs multiples. Ne pouvant accepter la valeur null. Prend en charge $filter (eq, not, ge, le, startsWith). |
| servicePrincipalType | String | Indique si le principal de service représente une application ou une identité gérée. Ce paramètre est défini par Microsoft Entra ID en interne. Pour un principal de service qui représente une application il s’agit de l’application. Pour un principal de service qui représente une identité managée , il est défini sur ManagedIdentity. Le type SocialIdp est pour une utilisation interne. |
| signInAudience | String | Spécifie les comptes Microsoft qui sont pris en charge pour l’application actuelle. En lecture seule. Les valeurs prises en charge sont :
|
| étiquettes | String collection | Chaînes personnalisées pouvant être utilisées pour catégoriser et identifier le principal de service. Ne pouvant accepter la valeur null. La valeur est l’union des chaînes définies ici et sur la propriété de balises de l’entité d’application associée. Prend en charge $filter (eq, not, ge, le, startsWith). |
| tokenEncryptionKeyId | String | Spécifie la keyId d’une clé publique de la collection keyCredentials. Une fois configuré, Microsoft Entra ID émet des jetons pour cette application 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é. |
| verifiedPublisher | verifiedPublisher | Spécifie l’éditeur vérifié de l’application liée à ce principal de service. |
Relations
Importante
L’utilisation spécifique du $filter paramètre de requête est prise en charge uniquement lorsque vous utilisez l’en-tête ConsistencyLevel défini sur eventual et $count. Pour plus d’informations, consultez Fonctionnalités de requête avancées sur les objets d’annuaire.
| Relation | Type | Description |
|---|---|---|
| appManagementPolicies | Collection appManagementPolicy | AppManagementPolicy appliqué à ce principal de service. |
| appRoleAssignedTo | appRoleAssignment | Attribution de rôles pour cette application ou ce service, accordée aux utilisateurs, groupes et autres principaux de service. Prend en charge $expand. |
| appRoleAssignments | Collection appRoleAssignment | Attribution d'un rôle pour une autre application ou un autre service, accordée à ce directeur de service. Prend en charge $expand. |
| claimsMappingPolicies | Collection de claimsMappingPolicy | Les claimsMappingPolicies attribuées à ce principal du service. Prend en charge $expand. |
| claimsPolicy | customClaimsPolicy | Stratégie de revendications qui permet aux administrateurs d’application de personnaliser les revendications qui seront émises dans les jetons affectés par cette stratégie. |
| createdObjects | collection directoryObject | Objets de répertoire créés par ce principal de service. En lecture seule. Peut avoir la valeur Null. |
| delegatedPermissionClassifications | Collection delegatedPermissionClassification | Les classifications d’autorisations pour les autorisations déléguées exposées par l’application que ce principal de service représente. Prend en charge $expand. |
| Points de terminaison | collectionpoint de terminaison | Points de terminaison disponibles pour la découverte. Les services tels que SharePoint remplissent cette propriété avec des points de terminaison SharePoint spécifiques aux clients que d’autres applications peuvent découvrir et utiliser dans leurs expériences. |
| homeRealmDiscoveryPolicies | Collection de homeRealmDiscoveryPolicy | Les homeRealmDiscoveryPolicies attribuées à ce principal de service. Prend en charge $expand. |
| memberOf | collection directoryObject | Rôles dont ce principal de service est membre. Méthodes HTTP : GET en lecture seule. Pouvant accepter la valeur Null. Prend en charge $expand. |
| oauth2PermissionGrants | Collection oAuth2PermissionGrant | Les autorisations déléguées octroient l’autorisation à ce principal de service d’accéder à une API au nom d’un utilisateur connecté. En lecture seule. Peut avoir la valeur Null. |
| ownedObjects | collection directoryObject | Objets de répertoire possédés par ce principal de service. En lecture seule. Pouvant accepter la valeur Null. Prend en charge $expand et $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1). |
| Propriétaires | collection directoryObject | Objets de répertoire qui sont propriétaires de ce principal de service. Les propriétaires sont un ensemble d’utilisateurs non administrateurs ou servicePrincipals autorisés à modifier cet objet. En lecture seule. Pouvant accepter la valeur Null. Prend en charge $expand et $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1). |
| remoteDesktopSecurityConfiguration | remoteDesktopSecurityConfiguration | Objet remoteDesktopSecurityConfiguration appliqué à ce principal de service. Prend en charge $filter (eq) pour la propriété isRemoteDesktopProtocolEnabled . |
| synchronisation | synchronisation | Représente la fonctionnalité de synchronisation d’identité Microsoft Entra via le API Graph Microsoft. |
| tokenIssuancePolicies | Collection de tokenIssuancePolicy | TokenIssuancePolicies affecté à ce principal de service. Prend en charge $expand. |
| tokenLifetimePolicies | Collection de tokenLifetimePolicy | Les tokenLifetimePolicies attribuées à ce principal du service. Prend en charge $expand. |
Représentation JSON
La représentation JSON suivante montre le type de ressource.
{
"accountEnabled": true,
"addIns": [{"@odata.type": "microsoft.graph.addIn"}],
"alternativeNames": "String",
"appDisplayName": "String",
"appId": "String",
"appOwnerOrganizationId": "Guid",
"applicationTemplateId": "String",
"appRoleAssignmentRequired": true,
"appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
"customSecurityAttributes": {
"@odata.type": "microsoft.graph.customSecurityAttributeValue"
},
"disabledByMicrosoftStatus": "String",
"displayName": "String",
"errorUrl": "String",
"homepage": "String",
"id": "String (identifier)",
"info": {"@odata.type": "microsoft.graph.informationalUrl"},
"keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
"loginUrl": "String",
"logoutUrl": "String",
"notes": "String",
"notificationEmailAddresses": ["String"],
"publishedPermissionScopes": [{"@odata.type": "microsoft.graph.permissionScope"}],
"passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
"passwordSingleSignOnSettings": {"@odata.type": "microsoft.graph.passwordSingleSignOnSettings"},
"preferredSingleSignOnMode": "String",
"preferredTokenSigningKeyEndDateTime": "DateTime",
"preferredTokenSigningKeyThumbprint": "String",
"publisherName": "String",
"replyUrls": ["String"],
"samlMetadataUrl": "String",
"samlSingleSignOnSettings": "microsoft.DirectoryServices.SamlSingleSignOnSettings",
"servicePrincipalNames": ["String"],
"servicePrincipalType": "String",
"signInAudience": "String",
"tags": ["String"],
"tokenEncryptionKeyId": "String",
"verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"}
}