Partager via


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 de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

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

Autorisations pour une application

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
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

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. Les rôles les moins privilégiés suivants sont pris en charge pour cette opération.

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

Autorisations pour un agentIdentityBlueprint

Type d’autorisation Autorisation avec privilèges minimum Autorisations privilégiées plus élevées
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

Lors de l’utilisation d’autorisations déléguées, l’utilisateur authentifié doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. Les rôles les moins privilégiés suivants sont pris en charge pour cette opération.

  • Administrateur d’ID d’agent.
  • Développeur d’ID d’agent : créez des blueprints d’identité d’agent. Le principal disposant de ce rôle se voit attribuer la propriété du blueprint qu’il crée et peut effectuer des opérations d’écriture sur ce blueprint.

Requête HTTP

Pour une application :

  • Vous pouvez traiter l’application à l’aide de son id ou de son id d’application. id et appId sont respectivement appelés ID d’objet et ID d’application (client) dans les inscriptions d’applications dans le centre d’administration Microsoft Entra.
  • Vous pouvez également traiter les informations d’identification de l’identité fédérée avec leur ID ou leur 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 traiter les informations d’identification de l’identité fédérée avec leur ID ou leur 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 l’autorisation.
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
Public Collection de chaînes 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 a une limite de 600 caractères.
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 fournie par l’utilisateur de l’utilisation de federatedIdentityCredential. Il a une limite de 600 caractères.
Émetteur String URL de l’émetteur approuvé entrant (Secure Token Service). Correspond à la revendication de l’émetteur d’un jeton d’accès. Par exemple, avec le scénario 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 de l’objet doit être unique sur l’application. Il a une limite de 600 caractères.
sujet String Pouvant accepter la valeur Null. La valeur par défaut est null si elle n’est pas définie.
  • Pour Microsoft Entra’émetteur, le objectId du servicePrincipal (peut représenter une identité managée) qui peut emprunter l’identité de l’application. L’objet associé à ce GUID doit exister dans le locataire.
  • Pour tous les autres émetteurs, une chaîne sans validation supplémentaire

    La combinaison des valeurs de l’émetteur et de l’objet 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 : Mettre à jour les informations d’identification d’une 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