Mettre à jour 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 .

Mettez à jour les propriétés d’un objet federatedIdentityCredential affecté à une application ou à un agentIdentityBlueprint.

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

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

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

Autorisations pour une application

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Application.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Application.ReadWrite.All Non disponible.
Application Application.ReadWrite.OwnedBy Application.ReadWrite.All

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération. Cette opération prend en charge les rôles intégrés suivants, qui n’offrent que le moindre privilège nécessaire :

  • Un utilisateur membre non administrateur disposant des autorisations d’utilisateur par défaut pour les applications dont il est propriétaire
  • Développeur d’applications : pour les applications dont il est propriétaire
  • Administrateur de l'application cloud
  • Administrateur de l'application

Autorisations pour un agentIdentityBlueprint

Type d’autorisation Autorisation de moindre privilège Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) AgentIdentityBlueprint.AddRemoveCreds.All, AgentIdentityBlueprint.UpdateBranding.All AgentIdentityBlueprint.ReadWrite.All, Directory.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application AgentIdentityBlueprint.AddRemoveCreds.All, AgentIdentityBlueprint.UpdateBranding.All AgentIdentityBlueprint.ReadWrite.All, Directory.ReadWrite.All

Importante

  • Un principal qui crée un blueprint d’identité d’agent ou un blueprint principal est automatiquement affecté en tant que propriétaire.
  • Les propriétaires peuvent créer et modifier des identités d’agent associées à un blueprint dont ils sont propriétaires sans qu’un rôle d’ID d’agent ne leur soit attribué.
  • Pour que les non-propriétaires puissent appeler cette API dans des scénarios de délégation à l’aide de comptes professionnels ou scolaires, un rôle Microsoft Entra pris en charge doit être attribué à l’administrateur. Cette opération prend en charge le rôle intégré de moindre privilège suivant :

Requête HTTP

Pour une application :

  • Vous pouvez vous adresser à l’application à l’aide de son ID ou de son AppId. id et appId sont appelés respectivement ID d’objet et ID d’application (client) dans les inscriptions d’applications dans le centre d’administration Microsoft Entra.
  • Vous pouvez également adresser les informations d’identification d’identité fédérées avec son ID ou son nom.
PATCH /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialId}

PATCH /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialName}

PATCH /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialId}

PATCH /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialName}

Pour un agentIdentityBlueprint :

  • Vous pouvez adresser les informations d’identification d’identité fédérées avec son ID ou son nom.
PATCH /applications/{id}/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials/{federatedIdentityCredentialId}

PATCH /applications/{id}/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials/{federatedIdentityCredentialName}

En-têtes de demande

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

Corps de la demande

Dans le corps de la demande, fournissez uniquement les valeurs des propriétés qui doivent être mises à 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.

Le tableau ci-dessous spécifie les propriétés pouvant être mises à jour.

Propriété Type Description
Audiences publiques String collection L’audience qui peut apparaître dans le jeton émis. Pour Microsoft Entra ID, définissez sa valeur sur api://AzureADTokenExchange. Ce champ ne peut accepter qu’une seule valeur et sa limite est de 600 caractères.
claimsMatchingExpression federatedIdentityExpression Pouvant accepter la valeur Null. Par défaut si null non défini. Permet d’utiliser des expressions de correspondance de revendications avec des revendications spécifiées. Si claimsMatchingExpression est défini, le sujet doit être null. Pour obtenir la liste de la syntaxe et des revendications d’expression prises en charge, consultez la référence FIC flexible.
description String Description fournie par l’utilisateur de l’utilisation de federatedIdentityCredential. Il a une limite de 600 caractères.
de l’émetteur String URL de l’émetteur approuvé entrant (Secure Token Service). Correspond à la revendication d’émetteur d’un jeton d’accès. Par exemple, dans le scénario de clés gérées par le client, Microsoft Entra ID est l’émetteur et une valeur valide serait https://login.microsoftonline.com/{tenantid}/v2.0. La combinaison des valeurs de l’émetteur et du sujet doit être unique sur l’application. Il a une limite de 600 caractères.
sujet String Pouvant accepter la valeur Null. Par défaut si null non défini.
  • Pour l’émetteur de Microsoft Entra, le objectId de servicePrincipal (peut représenter une identité gérée) qui peut emprunter l’identité de l’application. L’objet associé à ce GUID doit exister dans le client.
  • Pour tous les autres émetteurs, une chaîne sans validation supplémentaire

    La combinaison des valeurs de l’émetteur et du sujet doit être unique sur l’application. Si subject est défini, claimsMatchingExpression doit être null. Il a une limite de 600 caractères.
  • Réponse

    Si elle réussit, cette méthode renvoie un code de réponse 204 No Content.

    Exemples

    Exemple 1 : mise à jour d’informations d’identification d’identité fédérée pour une application

    Demande

    PATCH https://graph.microsoft.com/beta/applications/bcd7c908-1c4d-4d48-93ee-ff38349a75c8/federatedIdentityCredentials/15be77d1-1940-43fe-8aae-94a78e078da0
    Content-Type: application/json
    
    {
        "name": "testing02",
        "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
        "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
        "description": "Updated description",
        "audiences": [
            "api://AzureADTokenExchange"
        ]
    }
    

    Réponse

    HTTP/1.1 204 No Content
    

    Exemple 2 : mettre à jour les informations d’identification d’une identité fédérée pour un agentIdentityBlueprint

    Demande

    PATCH https://graph.microsoft.com/beta/applications/bcd7c908-1c4d-4d48-93ee-ff38349a75c8/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials/15be77d1-1940-43fe-8aae-94a78e078da0
    Content-Type: application/json
    
    {
        "name": "testing02",
        "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
        "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
        "description": "Updated description",
        "audiences": [
            "api://AzureADTokenExchange"
        ]
    }
    

    Réponse

    HTTP/1.1 204 No Content