Partager via

Mettre à jour samlOrWsFedExternalDomainFederation

  • Article

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 samlOrWsFedExternalDomainFederation .

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.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) IdentityProvider.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application IdentityProvider.ReadWrite.All Non disponible.

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. L’administrateur du fournisseur d’identité externe est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

PATCH directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/{samlOrWsFedExternalDomainFederation ID}

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 un objet JSON avec une ou plusieurs propriétés qui doivent être mises à jour pour un objet samlOrWsFedExternalDomainFederation dans Microsoft Entra locataire.

Le tableau suivant présente les propriétés que vous pouvez mettre à jour pour un objet samlOrWsFedExternalDomainFederation .

Propriété Type Description
displayName String Nom complet du fournisseur d’identité basé sur SAML/WS-Fed. Hérité de identityProviderBase.
issuerUri String URI de l’émetteur du serveur de fédération. Hérité de samlOrWsFedProvider.
metadataExchangeUri String URI du point de terminaison d’échange de métadonnées utilisé pour l’authentification à partir d’applications clientes enrichies. Hérité de samlOrWsFedProvider.
passiveSignInUri String URI vers lequel les clients web sont dirigés lors de la connexion à Microsoft Entra services. Hérité de samlOrWsFedProvider.
preferredAuthenticationProtocol String Protocole d’authentification préféré. Les valeurs prises en charge sont ou samlwsfed. Hérité de samlOrWsFedProvider.
signingCertificate String Certificat actuel utilisé pour signer les jetons passés à l’Plateforme d'identités Microsoft. Le certificat est au format d’une chaîne codée en Base64 de la partie publique du certificat de signature de jeton du fournisseur d’identité fédéré et doit être compatible avec la classe X509Certificate2.

Cette propriété est utilisée dans les scénarios suivants :
  • si une substitution est requise en dehors de la mise à jour de la substitution automatique
  • un nouveau service de fédération est en cours de configuration
  • si le nouveau certificat de signature de jeton n’est pas présent dans les propriétés de fédération après la mise à jour du certificat de service de fédération.


Microsoft Entra ID met à jour les certificats via un processus de substitution automatique dans lequel il tente de récupérer un nouveau certificat à partir des métadonnées du service de fédération, 30 jours avant l’expiration du certificat actuel. Si un nouveau certificat n’est pas disponible, Microsoft Entra ID surveille quotidiennement les métadonnées et met à jour les paramètres de fédération du domaine lorsqu’un nouveau certificat est disponible.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet samlOrWsFedExternalDomainFederation mis à jour dans le corps de la réponse.

Exemples

Demande

PATCH https://graph.microsoft.com/beta/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/d5a56845-6845-d5a5-4568-a5d54568a5d5
Content-Type: application/json

{
  "displayName": "Contoso name change",
  "issuerUri": "http://contoso-test.com/adfs/services/trust",
  "metadataExchangeUri": null,
  "signingCertificate": "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
  "passiveSignInUri": "https://contoso-test.com/adfs/ls/",
  "preferredAuthenticationProtocol": "wsFed"
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-Type: application/json

{
 "id": "d5a56845-6845-d5a5-4568-a5d54568a5d5",
  "displayName": "Contoso name change",
  "issuerUri": "http://contoso-test.com/adfs/services/trust",
  "metadataExchangeUri": null,
  "signingCertificate": "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
  "passiveSignInUri": "https://contoso-test.com/adfs/ls/",
  "preferredAuthenticationProtocol": "wsFed",
  "domains": [
      {
          "id": "contoso.com"
      }
  ]
}