Partager via


Type de ressource federatedIdentityCredential

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 .

Référence les informations d’identification d’identité fédérée pour une application ou agentIdentityBlueprint. Ces informations d’identification d’identité fédérée sont utilisées dans la fédération de l’identité de charge de travail lors de l’échange d’un jeton d’un émetteur approuvé contre un jeton d’accès lié à une application ou à un blueprint d’identité d’agent.

Hérite de l’entité.

Méthodes

Méthode Type de retour Description
List collection federatedIdentityCredential Obtenez la liste des objets federatedIdentityCredential et de leurs propriétés.
Create federatedIdentityCredential Créez un objet federatedIdentityCredential .
Obtenir federatedIdentityCredential Lisez les propriétés et les relations d’un objet federatedIdentityCredential .
Mettre à jour Aucun Mettez à jour les propriétés d’un objet federatedIdentityCredential .
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 Aucun Supprime un objet federatedIdentityCredential .

Propriétés

Propriété Type Description
Public String collection Audience qui peut apparaître dans le jeton externe. Ce champ est obligatoire et doit être défini sur api://AzureADTokenExchange pour Microsoft Entra ID. Il indique ce que Plateforme d'identités Microsoft devez accepter dans la aud revendication dans le jeton entrant. Cette valeur représente Microsoft Entra ID dans votre fournisseur d’identité externe et n’a aucune valeur fixe entre les fournisseurs d’identité. Vous devrez peut-être créer une inscription d’application dans votre fournisseur d’identité pour servir d’audience à ce jeton. Ce champ ne peut accepter qu’une seule valeur et a une limite de 600 caractères. Obligatoire.
claimsMatchingExpression federatedIdentityExpression Pouvant accepter la valeur Null. La valeur par défaut est null si elle n’est pas définie. Active l’utilisation d’expressions de correspondance de revendications par rapport à des revendications spécifiées. Si claimsMatchingExpression est défini, l’objet doit être null. Pour obtenir la liste des revendications et de la syntaxe d’expression prises en charge, consultez la référence FIC flexible.
description String Description non validée fournie par l’utilisateur des informations d’identification de l’identité fédérée. Il a une limite de 600 caractères. Facultatif.
id String Identificateur unique de l’identité fédérée. Obligatoire. En lecture seule.
émetteur String URL du fournisseur d’identité externe et doit correspondre à la issuer revendication du jeton externe échangé. La combinaison des valeurs de l’émetteur et de l’objet doit être unique sur l’application. Il a une limite de 600 caractères. Obligatoire.
nom String Identificateur unique pour les informations d’identification de l’identité fédérée, qui a une limite de 120 caractères et doit être convivial pour les URL. Il est immuable une fois créé. Autre clé. Obligatoire. Ne peut pas accepter une valeur null. Prend en charge $filter (eq).
sujet String Pouvant accepter la valeur Null. La valeur par défaut est null si elle n’est pas définie. Identificateur de la charge de travail logicielle externe au sein du fournisseur d’identité externe. Comme la valeur d’audience, il n’a pas de format fixe, car chaque fournisseur d’identité utilise son propre , parfois un GUID, parfois un identificateur délimité par deux-points, parfois des chaînes arbitraires. La valeur ici doit correspondre à la sub revendication dans le jeton présenté à Microsoft Entra ID. La combinaison de l’émetteur et de l’objet doit être unique sur l’application. Il a une limite de 600 caractères. Si subject est défini, claimsMatchingExpression doit être null. Prend en charge $filter (eq).

Relations

Aucun

Représentation JSON

La représentation JSON suivante montre le type de ressource.

{
  "@odata.type": "#microsoft.graph.federatedIdentityCredential",
  "id": "String (identifier)",
  "name": "String",
  "issuer": "String",
  "subject": "String",
  "description": "String",
  "audiences": [
    "String"
  ],
  "claimsMatchingExpression": {
    "@odata.type": "microsoft.graph.federatedIdentityExpression"
  }
}