Mettre à jour internalDomainFederation

Article
04/17/2024

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

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)	Domain.ReadWrite.All	Non disponible.
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Domain.ReadWrite.All	Non disponible.

Importante

Cette méthode présente un problème d’autorisations connu et peut nécessiter le consentement à l’autorisation Directory.AccessAsUser.All pour les scénarios délégués.

Pour les scénarios délégués, l’utilisateur appelant doit se voir attribuer au moins l’un des rôles Microsoft Entra suivants :

Administrateur de noms de domaine
Administrateur du fournisseur d’identité externe
Administrateur d’identité hybride
Administrateur de sécurité

Requête HTTP

PATCH /domains/{domainsId}/federationConfiguration/{internalDomainFederationId}

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 conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.

Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.

Propriété	Type	Description
activeSignInUri	Chaîne	URL du point de terminaison utilisé par les clients actifs lors de l’authentification avec des domaines fédérés configurés pour l’authentification unique dans Microsoft Entra ID. Correspond à la propriété ActiveLogOnUri de l’applet de commande PowerShell Set-MsolDomainFederationSettings MSOnline v1.
displayName	Chaîne	Nom complet du fournisseur d’identité fédérée (IdP).
federatedIdpMfaBehavior	federatedIdpMfaBehavior	Détermine si Microsoft Entra ID accepte l’authentification multifacteur effectuée par le fournisseur d’identité fédéré lorsqu’un utilisateur fédéré accède à une application régie par une stratégie d’accès conditionnel qui nécessite l’authentification multifacteur. Les valeurs possibles sont : `acceptIfMfaDoneByFederatedIdp`, `enforceMfaByFederatedIdp`, `rejectMfaByFederatedIdp`, `unknownFutureValue`. Pour plus d’informations, consultez Valeurs federatedIdpMfaBehavior.
isSignedAuthenticationRequestRequired	Valeur booléenne	Si la valeur est `true`, lorsque des demandes d’authentification SAML sont envoyées au fournisseur d’identité SAML fédéré, Microsoft Entra ID connectez-vous à ces demandes à l’aide de la clé de signature OrgID. Si `false` la valeur est (valeur par défaut), les demandes d’authentification SAML envoyées au fournisseur d’identité fédéré ne sont pas signées.
issuerUri	Chaîne	URI de l’émetteur du serveur de fédération.
metadataExchangeUri	Chaîne	URI du point de terminaison d’échange de métadonnées utilisé pour l’authentification à partir d’applications clientes enrichies.
nextSigningCertificate	Chaîne	Certificat de signature de jeton de secours utilisé pour signer des jetons à l’expiration du certificat de signature principal. Mise en forme en tant que chaînes encodées en Base 64 de la partie publique du certificat de signature de jeton du fournisseur d’identité fédéré. Doit être compatible avec la classe X509Certificate2. Tout comme signingCertificate, la propriété nextSigningCertificate est utilisée si une substitution est requise en dehors de la mise à jour automatique, si un nouveau service de fédération est en cours de configuration ou 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.
passiveSignInUri	Chaîne	URI vers lequel les clients web sont dirigés lors de la connexion à Microsoft Entra services.
preferredAuthenticationProtocol	authenticationProtocol	Protocole d’authentification préféré. Les valeurs possibles sont `wsFed`, `saml`, `unknownFutureValue`.
promptLoginBehavior	promptLoginBehavior	Définit le comportement par défaut pour l’invite de connexion. Les valeurs possibles sont : `translateToFreshPasswordAuthentication`, `nativeSupport`, `disabled`, `unknownFutureValue`.
signingCertificate	Chaîne	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 Base 64 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 aucun nouveau certificat n’est 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. Hérité de samlOrWsFedProvider.
signingCertificateUpdateStatus	signingCertificateUpdateStatus	Fournit status et l’horodatage de la dernière mise à jour du certificat de signature.
signOutUri	Chaîne	URI vers lequel les clients sont redirigés lorsqu’ils se déconnectent des services Microsoft Entra. Correspond à la propriété LogOffUri de l’applet de commande PowerShell Set-MsolDomainFederationSettings MSOnline v1.

Remarque

Les modules PowerShell Azure AD et MSOnline sont déconseillés à compter du 30 mars 2024. Pour en savoir plus, consultez la mise à jour sur l’obsolescence. Après cette date, la prise en charge de ces modules est limitée à l’assistance à la migration vers le Kit de développement logiciel (SDK) Microsoft Graph PowerShell et aux correctifs de sécurité. Les modules déconseillés continueront de fonctionner jusqu’au 30 mars 2025.

Nous vous recommandons de migrer vers Microsoft Graph PowerShell pour interagir avec Microsoft Entra ID (anciennement Azure AD). Pour les questions courantes sur la migration, reportez-vous au FAQ sur la migration. Note: Les versions 1.0.x de MSOnline peuvent être interrompues après le 30 juin 2024.

Valeurs federatedIdpMfaBehavior

Member	Description
acceptIfMfaDoneByFederatedIdp	Microsoft Entra ID accepte l’authentification multifacteur effectuée par le fournisseur d’identité fédérée. Si le fournisseur d’identité fédéré n’a pas effectué l’authentification multifacteur, Microsoft Entra ID effectue l’authentification multifacteur.
enforceMfaByFederatedIdp	Microsoft Entra ID accepte l’authentification multifacteur effectuée par le fournisseur d’identité fédérée. Si le fournisseur d’identité fédérée n’a pas effectué l’authentification multifacteur, il redirige la demande vers le fournisseur d’identité fédérée pour effectuer l’authentification multifacteur.
rejectMfaByFederatedIdp	Microsoft Entra ID effectue toujours l’authentification multifacteur et rejette l’authentification multifacteur effectuée par le fournisseur d’identité fédérée.

Remarque :federatedIdpMfaBehavior est une version évoluée de la propriété SupportsMfa de l’applet de commande PowerShell Set-MsolDomainFederationSettings MSOnline v1.

Le basculement entre federatedIdpMfaBehavior et SupportsMfa n’est pas pris en charge.
Une fois la propriété federatedIdpMfaBehavior définie, Microsoft Entra ID ignore le paramètre SupportsMfa.
Si la propriété federatedIdpMfaBehavior n’est jamais définie, Microsoft Entra ID continue à respecter le paramètre SupportsMfa.
Si ni federatedIdpMfaBehavior ni SupportsMfa n’est défini, Microsoft Entra ID comportement par défautacceptIfMfaDoneByFederatedIdp.

Réponse

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

Exemples

Demande

PATCH https://graph.microsoft.com/beta/domains/contoso.com/federationConfiguration/6601d14b-d113-8f64-fda2-9b5ddda18ecc
Content-Type: application/json

{
  "displayName": "Contoso name change",  
  "federatedIdpMfaBehavior": "acceptIfMfaDoneByFederatedIdp"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new InternalDomainFederation
{
	DisplayName = "Contoso name change",
	FederatedIdpMfaBehavior = FederatedIdpMfaBehavior.AcceptIfMfaDoneByFederatedIdp,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Domains["{domain-id}"].FederationConfiguration["{internalDomainFederation-id}"].PatchAsync(requestBody);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta domains federation-configuration patch --domain-id {domain-id} --internal-domain-federation-id {internalDomainFederation-id} --body '{\
  "displayName": "Contoso name change",  \
  "federatedIdpMfaBehavior": "acceptIfMfaDoneByFederatedIdp"\
}\
'

Importante



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewInternalDomainFederation()
displayName := "Contoso name change"
requestBody.SetDisplayName(&displayName) 
federatedIdpMfaBehavior := graphmodels.ACCEPTIFMFADONEBYFEDERATEDIDP_FEDERATEDIDPMFABEHAVIOR 
requestBody.SetFederatedIdpMfaBehavior(&federatedIdpMfaBehavior) 

federationConfiguration, err := graphClient.Domains().ByDomainId("domain-id").FederationConfiguration().ByInternalDomainFederationId("internalDomainFederation-id").Patch(context.Background(), requestBody, nil)

Importante


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

InternalDomainFederation internalDomainFederation = new InternalDomainFederation();
internalDomainFederation.setDisplayName("Contoso name change");
internalDomainFederation.setFederatedIdpMfaBehavior(FederatedIdpMfaBehavior.AcceptIfMfaDoneByFederatedIdp);
InternalDomainFederation result = graphClient.domains().byDomainId("{domain-id}").federationConfiguration().byInternalDomainFederationId("{internalDomainFederation-id}").patch(internalDomainFederation);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const internalDomainFederation = {
  displayName: 'Contoso name change',  
  federatedIdpMfaBehavior: 'acceptIfMfaDoneByFederatedIdp'
};

await client.api('/domains/contoso.com/federationConfiguration/6601d14b-d113-8f64-fda2-9b5ddda18ecc')
	.version('beta')
	.update(internalDomainFederation);

Importante


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\InternalDomainFederation;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new InternalDomainFederation();
$requestBody->setDisplayName('Contoso name change');
$requestBody->setFederatedIdpMfaBehavior(new FederatedIdpMfaBehavior('acceptIfMfaDoneByFederatedIdp'));

$result = $graphServiceClient->domains()->byDomainId('domain-id')->federationConfiguration()->byInternalDomainFederationId('internalDomainFederation-id')->patch($requestBody)->wait();

Importante


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	displayName = "Contoso name change"
	federatedIdpMfaBehavior = "acceptIfMfaDoneByFederatedIdp"
}

Update-MgBetaDomainFederationConfiguration -DomainId $domainId -InternalDomainFederationId $internalDomainFederationId -BodyParameter $params

Importante


from msgraph import GraphServiceClient
from msgraph.generated.models.internal_domain_federation import InternalDomainFederation

graph_client = GraphServiceClient(credentials, scopes)

request_body = InternalDomainFederation(
	display_name = "Contoso name change",
	federated_idp_mfa_behavior = FederatedIdpMfaBehavior.AcceptIfMfaDoneByFederatedIdp,
)

result = await graph_client.domains.by_domain_id('domain-id').federation_configuration.by_internal_domain_federation_id('internalDomainFederation-id').patch(request_body)

Importante

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

{
  "@odata.type": "#microsoft.graph.internalDomainFederation",
  "id": "6601d14b-d113-8f64-fda2-9b5ddda18ecc",
   "displayName": "Contoso name change",
   "issuerUri": "http://contoso.com/adfs/services/trust",
   "metadataExchangeUri": "https://sts.contoso.com/adfs/services/trust/mex",
   "signingCertificate": "MIIE3jCCAsagAwIBAgIQQcyDaZz3MI",
   "passiveSignInUri": "https://sts.contoso.com/adfs/ls",
   "preferredAuthenticationProtocol": "wsFed",
   "activeSignInUri": "https://sts.contoso.com/adfs/services/trust/2005/usernamemixed",
   "signOutUri": "https://sts.contoso.com/adfs/ls",
   "promptLoginBehavior": "nativeSupport",
   "isSignedAuthenticationRequestRequired": true,
   "nextSigningCertificate": "MIIE3jCCAsagAwIBAgIQQcyDaZz3MI",
   "signingCertificateUpdateStatus": {
        "certificateUpdateResult": "Success",
        "lastRunDateTime": "2021-08-25T07:44:46.2616778Z"
    },
   "federatedIdpMfaBehavior": "acceptIfMfaDoneByFederatedIdp"
}

Mettre à jour internalDomainFederation

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Valeurs federatedIdpMfaBehavior

Réponse

Exemples

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires