Actualizar samlOrWsFedExternalDomainFederation

Espacio de nombres: microsoft.graph

Actualice las propiedades de un objeto samlOrWsFedExternalDomainFederation .

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)	IdentityProvider.ReadWrite.All	No disponible.
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	IdentityProvider.ReadWrite.All	No disponible.

Importante

En escenarios delegados con cuentas profesionales o educativas, al usuario que ha iniciado sesión se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. El administrador del proveedor de identidades externo es el rol con privilegios mínimos admitido para esta operación.

Solicitud HTTP

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

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, proporcione un objeto JSON con una o varias propiedades que deben actualizarse para un objeto samlOrWsFedExternalDomainFederation en Microsoft Entra inquilino.

En la tabla siguiente se muestran las propiedades que puede actualizar para un objeto samlOrWsFedExternalDomainFederation .

Propiedad	Tipo	Descripción
displayName	Cadena	Nombre para mostrar del proveedor de identidades basado en SAML/WS-Fed. Se hereda de identityProviderBase.
issuerUri	Cadena	URI del emisor del servidor de federación. Se hereda de samlOrWsFedProvider.
metadataExchangeUri	Cadena	URI del punto de conexión de intercambio de metadatos que se usa para la autenticación de aplicaciones cliente enriquecidas. Se hereda de samlOrWsFedProvider.
passiveSignInUri	Cadena	URI al que se dirige a los clientes basados en web al iniciar sesión en Microsoft Entra servicios. Se hereda de samlOrWsFedProvider.
preferredAuthenticationProtocol	authenticationProtocol	Protocolo de autenticación preferido. Los valores posibles son: wsFed, saml. Se hereda de samlOrWsFedProvider.
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 Base64 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 token 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 actualizará la configuración de federación del dominio cuando haya un nuevo certificado disponible.

Respuesta

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

Ejemplos

Solicitud

HTTP

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const samlOrWsFedExternalDomainFederation = {
  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'
};

await client.api('/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/d5a56845-6845-d5a5-4568-a5d54568a5d5')
	.version('beta')
	.update(samlOrWsFedExternalDomainFederation);

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

En el ejemplo siguiente se muestra la 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

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