Actualizar internalDomainFederation

Espacio de nombres: microsoft.graph

Actualice las propiedades de un objeto internalDomainFederation .

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	Domain.ReadWrite.All	No disponible.
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	Domain.ReadWrite.All	No disponible.

Importante

Este método tiene un problema de permisos conocido y puede requerir el consentimiento del permiso Directory.AccessAsUser.All para escenarios delegados.

Para escenarios delegados, al usuario que realiza la llamada se le debe asignar al menos uno de los siguientes roles de Microsoft Entra:

• Administrador de nombres de dominio
• Administrador del proveedor de identidades externo
• Administrador de identidades híbridas
• Administrador de seguridad

Solicitud HTTP

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

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type	application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, únicamente proporcione los valores de las propiedades que deben actualizarse. Las propiedades existentes que no se incluyen en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad.

En la tabla siguiente se especifican las propiedades que se pueden actualizar.

Propiedad	Tipo	Descripción
activeSignInUri	Cadena	Dirección URL del punto de conexión que usan los clientes activos al autenticarse con dominios federados configurados para el inicio de sesión único en Microsoft Entra ID. Corresponde a la propiedad ActiveLogOnUri del cmdlet de PowerShell Set-MsolDomainFederationSettings MSOnline v1.
displayName	Cadena	Nombre para mostrar del proveedor de identidades federadas (IdP).
federatedIdpMfaBehavior	federatedIdpMfaBehavior	Determina si Microsoft Entra ID acepta la MFA realizada por el IdP federado cuando un usuario federado accede a una aplicación que se rige por una directiva de acceso condicional que requiere MFA. Los valores posibles son: acceptIfMfaDoneByFederatedIdp, enforceMfaByFederatedIdp, rejectMfaByFederatedIdp y unknownFutureValue Para obtener más información, vea federatedIdpMfaBehavior values(Valores de federatedIdpMfaBehavior).
isSignedAuthenticationRequestRequired	Booleano	Si truees , cuando se envían solicitudes de autenticación SAML al IdP de SAML federado, Microsoft Entra ID firma esas solicitudes mediante la clave de firma orgID. Si false es (valor predeterminado), las solicitudes de autenticación SAML enviadas al IdP federado no están firmadas.
issuerUri	Cadena	URI del emisor del servidor de federación.
metadataExchangeUri	Cadena	URI del punto de conexión de intercambio de metadatos que se usa para la autenticación de aplicaciones cliente enriquecidas.
nextSigningCertificate	Cadena	Certificado de firma de token de reserva que se usa para firmar tokens cuando expira el certificado de firma principal. Con formato de cadenas codificadas en Base 64 de la parte pública del certificado de firma de tokens del IdP federado. Debe ser compatible con la clase X509Certificate2. Al igual que signingCertificate, se usa la propiedad nextSigningCertificate si se requiere una sustitución fuera de la actualización de inscripción automática, se está configurando un nuevo servicio de federación o si el nuevo certificado de firma de token no está presente en las propiedades de federación después de actualizar el certificado del servicio de federación.
passiveSignInUri	Cadena	URI al que se dirige a los clientes basados en web al iniciar sesión en Microsoft Entra servicios.
preferredAuthenticationProtocol	authenticationProtocol	Protocolo de autenticación preferido. Los valores posibles son: wsFed, saml, unknownFutureValue.
promptLoginBehavior	promptLoginBehavior	Establece el comportamiento preferido para el símbolo del sistema de inicio de sesión. Los valores posibles son: translateToFreshPasswordAuthentication, nativeSupport, disabled y unknownFutureValue
signingCertificate	Cadena	Certificado actual que se usa para firmar tokens pasados a la Plataforma de identidad de Microsoft. El certificado tiene el formato de cadena codificada en Base 64 de la parte pública del certificado de firma de token del IdP federado y debe ser compatible con la clase X509Certificate2. Esta propiedad se usa en los siguientes escenarios: Si se requiere una sustitución fuera de la actualización de inscripción automática Se está configurando un nuevo servicio de federación Si el nuevo certificado de firma de tokens no está presente en las propiedades de federación después de actualizar el certificado del servicio de federación. Microsoft Entra ID actualiza los certificados a través de un proceso de inscripción automática en el que intenta recuperar un nuevo certificado de los metadatos del servicio de federación, 30 días antes de la expiración del certificado actual. Si un nuevo certificado no está disponible, Microsoft Entra ID supervisa los metadatos diariamente y actualiza la configuración de federación del dominio cuando hay un nuevo certificado disponible. Se hereda de samlOrWsFedProvider.
signingCertificateUpdateStatus	signingCertificateUpdateStatus	Proporciona el estado y la marca de tiempo de la última actualización del certificado de firma.
signOutUri	Cadena	URI al que se redirigen los clientes cuando cierran la sesión de Microsoft Entra servicios. Corresponde a la propiedad LogOffUri del cmdlet de PowerShell Set-MsolDomainFederationSettings MSOnline v1.

Nota:

Los módulos de PowerShell de Azure AD y MSOnline quedarán obsoletos a partir del 30 de marzo de 2024. Para obtener más información, lea la actualización de desuso. Después de esta fecha, el soporte técnico de estos módulos se limita a la asistencia para la migración al SDK de Microsoft Graph PowerShell y a las correcciones de seguridad. Los módulos obsoletos seguirán funcionando hasta el 30 de marzo de 2025.

Se recomienda migrar a Microsoft Graph PowerShell para interactuar con Microsoft Entra ID (anteriormente Azure AD). Para obtener respuesta a las preguntas más comunes sobre la migración, consulte las Preguntas frecuentes sobre la migración. Nota: Las versiones 1.0.x de MSOnline pueden experimentar interrupciones después del 30 de junio de 2024.

valores federatedIdpMfaBehavior

Member	Descripción
acceptIfMfaDoneByFederatedIdp	Microsoft Entra ID acepta MFA que realiza el proveedor de identidades federado. Si el proveedor de identidades federado no realizó MFA, Microsoft Entra ID realiza la MFA.
enforceMfaByFederatedIdp	Microsoft Entra ID acepta MFA que realiza el proveedor de identidades federado. Si el proveedor de identidades federado no realizó MFA, redirige la solicitud al proveedor de identidades federado para realizar MFA.
rejectMfaByFederatedIdp	Microsoft Entra ID siempre realiza MFA y rechaza la MFA que realiza el proveedor de identidades federado.

Nota:

federatedIdpMfaBehavior es una versión evolucionada de la propiedad SupportsMfa del cmdlet de PowerShell Set-MsolDomainFederationSettings MSOnline v1.

• No se admite el cambio entre federatedIdpMfaBehavior y SupportsMfa .
• Cuando se establece la propiedad federatedIdpMfaBehavior, Microsoft Entra ID omite el valor SupportsMfa.
• Si la propiedad federatedIdpMfaBehavior nunca se establece, Microsoft Entra ID seguirá cumpliendo la configuración SupportsMfa.
• Si no se establecen federatedIdpMfaBehavior ni SupportsMfa, Microsoft Entra ID tendrá el comportamiento predeterminadoacceptIfMfaDoneByFederatedIdp.

Respuesta

Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y un objeto internalDomainFederation actualizado en el cuerpo de la respuesta.

Ejemplos

Solicitud

HTTP

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

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

C#

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

// Dependencies
using Microsoft.Graph.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);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

CLI

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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Ir

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-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)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Java

// 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);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

JavaScript

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')
	.update(internalDomainFederation);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PHP

<?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();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PowerShell

Import-Module Microsoft.Graph.Identity.DirectoryManagement

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

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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Python

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)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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"
}