Creación de samlOrWsFedExternalDomainFederation
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta
de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Cree un nuevo 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
POST /directory/federationConfigurations/microsoft.graph.samlOrWsFedExternalDomainFederation
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 una representación JSON del objeto samlOrWsFedExternalDomainFederation .
En la tabla siguiente se enumeran las propiedades necesarias al crear 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 | Cadena | Protocolo de autenticación preferido. Entre los valores admitidos se incluyen saml o wsfed . 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:
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 201 Created
código de respuesta y un objeto samlOrWsFedExternalDomainFederation en el cuerpo de la respuesta.
Ejemplos
Solicitud
POST https://graph.microsoft.com/beta/directory/federationConfigurations/microsoft.graph.samlOrWsFedExternalDomainFederation
Content-Type: application/json
{
"@odata.type": "microsoft.graph.samlOrWsFedExternalDomainFederation",
"issuerUri": "https://contoso.com/issuerUri",
"displayName": "contoso display name",
"metadataExchangeUri": "https://contoso.com/metadataExchangeUri",
"passiveSignInUri": "https://contoso.com/signin",
"preferredAuthenticationProtocol": "wsFed",
"domains": [
{
"@odata.type": "microsoft.graph.externalDomainName",
"id": "contoso.com"
}
],
"signingCertificate": "MIIDADCCAeigAwIBAgIQEX41y8r6"
}
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 201 Created
Content-Type: application/json
{
"id": "3c41f317-9af3-4266-8ccf-26283ceec888",
"displayName": "contoso display name"
}