Partager via


type de ressource agentIdentityBlueprint

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 .

Un blueprint d’identité d’agent sert de modèle pour créer des identités d’agent dans l’écosystème Microsoft Entra ID.

Hérite de l’application.

Cette ressource est un type ouvert qui autorise des propriétés supplémentaires au-delà de celles documentées ici.

Méthodes

Méthode Type de retour Description
List collection agentIdentityBlueprint Obtenez la liste des objets agentIdentityBlueprint et leurs propriétés.
Create agentIdentityBlueprint Créez (inscrivez) un agentIdentityBlueprint.
Obtenir agentIdentityBlueprint Lisez les propriétés et les relations de l’objet agentIdentityBlueprint .
Mettre à jour agentIdentityBlueprint Mettez à jour les propriétés d’un objet agentIdentityBlueprint.
Upsert agentIdentityBlueprint Créez un blueprint d’identité d’agent s’il n’existe pas ou mettez à jour les propriétés d’un blueprint existant.
Supprimer Aucun Supprime un objet agentIdentityBlueprint.
Identifiants
Ajouter un mot de passe passwordCredential Ajoutez un mot de passe ou un secret fort à un blueprint d’identité d’agent.
Supprimer le mot de passe passwordCredential Supprimez un mot de passe ou un secret d’un blueprint d’identité d’agent.
Touche Ajouter keyCredential Ajoutez des informations d’identification de clé à un blueprint d’identité d’agent.
Supprimer la touche Aucun Supprimez les informations d’identification d’une clé d’un blueprint d’identité d’agent.
Répertorier les informations d’identification d’identité fédérée collection federatedIdentityCredential Obtenez la liste des objets federatedIdentityCredential et de leurs propriétés.
Créer des informations d’identification d’identité fédérée federatedIdentityCredential Créez un objet federatedIdentityCredential .
Obtenir les informations d’identification de l’identité fédérée federatedIdentityCredential Lisez les propriétés et les relations d’un objet federatedIdentityCredential .
Mettre à jour les informations d’identification de l’identité fédérée Aucun Mettez à jour les propriétés d’un objet federatedIdentityCredential .
Informations d’identification d’identité fédérée Upsert federatedIdentityCredential Créez un objet federatedIdentityCredential s’il n’existe pas ou mettez à jour les propriétés d’un objet federatedIdentityCredential existant.
Supprimer les informations d’identification de l’identité fédérée Aucun Supprime un objet federatedIdentityCredential .
Éléments supprimés
List collection directoryObject Récupérez la liste des identités d’agent récemment supprimées.
Obtenir directoryObject Récupérer les propriétés d’une identité d’agent récemment supprimée.
Restaurer directoryObject Restaurer une identité d’agent récemment supprimée.
Supprimer définitivement Aucun Supprimez définitivement une identité d’agent.
Propriétaires
Liste des propriétaires collection directoryObject Obtenez les propriétaires de ce principal de blueprint d’identité d’agent.
Ajouter des propriétaires directoryObject Affectez un propriétaire à ce principal de blueprint d’identité d’agent.
Supprimer les propriétaires Aucun Supprimez un propriétaire de ce principal de blueprint d’identité d’agent.
Sponsors
Lister les sponsors collection directoryObject Obtenez les sponsors pour ce blueprint d’identité d’agent. Les sponsors sont des utilisateurs ou des principaux de service qui peuvent autoriser et gérer le cycle de vie des instances d’identité d’agent.
Ajouter des sponsors directoryObject Ajoutez des commanditaires en les publiant dans la collection de commanditaires.
Supprimer les sponsors Aucun Supprimez un objet directoryObject .
Serveur de publication vérifié
Ensemble Aucune Activez le serveur de publication vérifié d’une application.
Unset Aucune Annulez le serveur de publication vérifié d’une application.
Autorisations pouvant être héritées
Répertorier les autorisations pouvant être héritées collection inheritablePermission Obtenez la liste des objets inheritablePermission et leurs propriétés.
Ajouter une autorisation pouvant être héritée inheritablePermission Créez un objet inheritablePermission.
Supprimer l’autorisation pouvant être héritée Aucun Supprime un objet inheritablePermission.

Propriétés

Importante

Bien que cette ressource hérite de l’application, certaines propriétés ne sont pas applicables et retournent null ou les valeurs par défaut. Ces propriétés sont exclues du tableau ci-dessous.

Propriété Type Description
api apiApplication Spécifie les paramètres d’un blueprint d’identité d’agent qui implémente une API web. Hérité de l’application.
appId String Identificateur unique du blueprint d’identité de l’agent affecté par Microsoft Entra ID. Ne pouvant accepter la valeur null. En lecture seule. Hérité de l’application.
appRoles Collection de appRole Collection de rôles définis pour le blueprint d’identité de l’agent. Avec affectations de rôle d’application, ces rôles peuvent être affectés à des utilisateurs, des groupes ou des principaux de service associés à d’autres applications. Ne pouvant accepter la valeur null. Hérité de l’application.
certification certification Spécifie le status de certification du blueprint d’identité de l’agent. Hérité de l’application.
createdByAppId Chaîne Identificateur unique de l’application qui a créé ce blueprint d’identité d’agent. Défini en interne par Microsoft Entra ID. En lecture seule. Hérité de l’application.
createdDateTime DateTimeOffset Date et heure d’inscription du blueprint d’identité de l’agent. Le type DateTimeOffset représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. En lecture seule. Hérité de l’application.
createdByAppId Chaîne AppId (appelé ID d’application (client) sur le centre d’administration Microsoft Entra) de l’application qui a créé ce blueprint d’identité d’agent. Défini en interne par Microsoft Entra ID. En lecture seule. Hérité de l’application.
description String Champ de texte libre pour fournir une description du blueprint d’identité de l’agent aux utilisateurs finaux. La taille maximale autorisée est de 1 024 caractères. Hérité de l’application.
disabledByMicrosoftStatus String Spécifie si Microsoft a désactivé le blueprint d’identité de l’agent inscrit. 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). Hérité de l’application.
displayName String Nom complet du blueprint d’identité de l’agent. Longueur maximale : 256 caractères. Hérité de l’application.
groupMembershipClaims String Configure la groups revendication émise dans un utilisateur ou un jeton d’accès OAuth 2.0 attendu par le blueprint d’identité de l’agent. Pour définir cet attribut, utilisez l’une des valeurs de chaîne suivantes : None, SecurityGroup (pour les groupes de sécurité et les rôles Microsoft Entra), All (ceci obtient tous les groupes de sécurité, groupes de distribution et Microsoft Entra rôles d’annuaire dont l’utilisateur connecté est membre). Hérité de l’application.
id String Identificateur unique de l’objet blueprint d’identité de l’agent. Cette propriété est appelée ID d’objet dans le centre d’administration Microsoft Entra. Clé. Ne peut pas avoir la valeur Null. En lecture seule. Hérité de directoryObject.
identifierUris String collection Également appelée URI d’ID d’application, cette valeur est définie lorsqu’un blueprint d’identité d’agent est utilisé comme application de ressource. IdentifierUris agit comme préfixe pour les étendues que vous référencez dans le code de votre API, et il doit être globalement unique dans Microsoft Entra ID. Ne pouvant accepter la valeur null. Hérité de l’application.
info informationalUrl Informations de profil de base du blueprint d’identité de l’agent, telles que le marketing, 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. Hérité de l’application.
keyCredentials Collection keyCredential Collection d’informations d’identification de clé associée au blueprint d’identité de l’agent. Ne pouvant accepter la valeur null. Hérité de l’application.
optionalClaims optionalClaims Les développeurs d’applications peuvent configurer des revendications facultatives dans leurs blueprints d’identité d’agent Microsoft Entra pour spécifier les revendications envoyées à leur application par le service de jeton de sécurité Microsoft. Hérité de l’application.
passwordCredentials Collection passwordCredential Collection d’informations d’identification de mot de passe associée au blueprint d’identité de l’agent. Ne pouvant accepter la valeur null. Hérité de l’application.

Vous pouvez également ajouter des mots de passe après avoir créé le blueprint d’identité de l’agent en appelant l’API Ajouter un mot de passe .
publisherDomain String Domaine d’éditeur vérifié pour le blueprint d’identité de l’agent. En lecture seule. Hérité de l’application.
serviceManagementReference Chaîne Fait référence aux informations de contact d’application ou de service à partir d’une base de données Service ou Gestion des actifs. Pouvant accepter la valeur Null. Hérité de l’application.
signInAudience String Spécifie les comptes Microsoft pris en charge pour le blueprint d’identité de l’agent actuel. Les valeurs possibles sont : AzureADMyOrg (par défaut), AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccountet PersonalMicrosoftAccount. Hérité de l’application.
étiquettes String collection Chaînes personnalisées qui peuvent être utilisées pour catégoriser et identifier le blueprint d’identité de l’agent. Ne pouvant accepter la valeur null. Hérité de l’application.
tokenEncryptionKeyId Guid Spécifie la keyId d’une clé publique de la collection keyCredentials. Une fois configuré, Microsoft Entra ID chiffre tous les jetons qu’il émet à l’aide de la clé vers laquelle pointe cette propriété. Hérité de l’application.
uniqueName String Identificateur unique qui peut être affecté à un blueprint d’identité d’agent et utilisé comme clé de remplacement. Non modifiable. En lecture seule. Hérité de l’application.
verifiedPublisher verifiedPublisher Spécifie l’éditeur vérifié du blueprint d’identité de l’agent. Hérité de l’application.
web WebApplication Spécifie les paramètres d’une application web. Hérité de l’application.

Relations

Relation Type Description
appManagementPolicies Collection appManagementPolicy AppManagementPolicy appliqué à ce blueprint d’identité d’agent. Hérité de microsoft.graph.application
federatedIdentityCredentials collection federatedIdentityCredential Identités fédérées pour les blueprints d’identité d’agent. Hérité de microsoft.graph.application
inheritablePermissions collection inheritablePermission Définit les étendues d’une application de ressources qui peuvent être automatiquement accordées aux identités d’agent sans consentement supplémentaire.
Propriétaires collection directoryObject Objets d’annuaire qui sont propriétaires de ce blueprint d’identité d’agent. Les propriétaires sont un ensemble d’utilisateurs non administrateurs ou de principaux de service autorisés à modifier cet objet. En lecture seule. Pouvant accepter la valeur Null. Hérité de microsoft.graph.application
Sponsors collection directoryObject Sponsors pour ce blueprint d’identité d’agent. Les sponsors sont des utilisateurs ou des groupes qui peuvent autoriser et gérer le cycle de vie des instances d’identité d’agent. Obligatoire pendant l’opération de création.

Représentation JSON

La représentation JSON suivante montre le type de ressource. Seul un sous-ensemble de toutes les propriétés est retourné par défaut. Toutes les autres propriétés peuvent uniquement être récupérées à l’aide $selectde .

{
  "@odata.type": "#microsoft.graph.agentIdentityBlueprint",
  "id": "String (identifier)",
  "appId": "String",
  "identifierUris": ["String"],
  "createdByAppId": "String",
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "disabledByMicrosoftStatus": "String",
  "displayName": "String",
  "groupMembershipClaims": "String",
  "publisherDomain": "String",
  "signInAudience": "String",
  "tags": ["String"],
  "tokenEncryptionKeyId": "Guid",
  "uniqueName": "String",
  "serviceManagementReference": "String",
  "certification": {
    "@odata.type": "microsoft.graph.certification"
  },
  "optionalClaims": {
    "@odata.type": "microsoft.graph.optionalClaims"
  },
  "api": {
    "@odata.type": "microsoft.graph.apiApplication"
  },
  "appRoles": [
    {
      "@odata.type": "microsoft.graph.appRole"
    }
  ],
  "info": {
    "@odata.type": "microsoft.graph.informationalUrl"
  },
  "keyCredentials": [
    {
      "@odata.type": "microsoft.graph.keyCredential"
    }
  ],
  "passwordCredentials": [
    {
      "@odata.type": "microsoft.graph.passwordCredential"
    }
  ],
  "verifiedPublisher": {
    "@odata.type": "microsoft.graph.verifiedPublisher"
  },
  "web": {
    "@odata.type": "microsoft.graph.webApplication"
  }
}