tipo de recurso internalDomainFederation

Namespace: microsoft.graph

Representa configurações de domínios de locatário federados e verificados com Microsoft Entra ID. Use esse recurso para configurar as configurações de federação ao configurar a federação com Microsoft Entra ID. Para obter informações sobre federação, consulte O que é federação com Microsoft Entra ID?.

Herda de samlOrWsFedProvider.

Métodos

Método Tipo de retorno Descrição
Listar internalDomainFederations coleção internalDomainFederation Leia as propriedades do objeto internalDomainFederation para o domínio.
Criar federationConfiguration internalDomainFederation Crie um novo objeto internalDomainFederation .
Obter internalDomainFederation internalDomainFederation Leia as propriedades e as relações de um objeto internalDomainFederation .
Atualizar internalDomainFederation internalDomainFederation Atualize as propriedades de um objeto internalDomainFederation .
Excluir internalDomainFederation Nenhum Exclua um objeto internalDomainFederation .

Propriedades

Propriedade Tipo Descrição
activeSignInUri Cadeia de caracteres URL do ponto de extremidade usado por clientes ativos ao autenticar com domínios federados configurados para logon único no Microsoft Entra ID. Corresponde à propriedade ActiveLogOnUri do cmdlet Set-MsolDomainFederationSettings MSOnline v1 PowerShell.
displayName Cadeia de caracteres O nome de exibição do provedor de identidade federado (IdP). Herdado de identityProviderBase.
federatedIdpMfaBehavior federatedIdpMfaBehavior Determina se Microsoft Entra ID aceita o MFA executado pelo IdP federado quando um usuário federado acessa um aplicativo que é regido por uma política de acesso condicional que requer MFA. Os valores possíveis são: acceptIfMfaDoneByFederatedIdp, enforceMfaByFederatedIdp, rejectMfaByFederatedIdp, unknownFutureValue. Para obter mais informações, confira valores federatedIdpMfaBehavior.
id Cadeia de caracteres O identificador do provedor de identidade federado. Herdado da entidade.
isSignedAuthenticationRequestRequired Booliano Se true, quando as solicitações de autenticação SAML forem enviadas para o IdP saml federado, Microsoft Entra ID assinará essas solicitações usando a chave de assinatura OrgID. Se false (padrão), as solicitações de autenticação SAML enviadas para o IdP federado não forem assinadas.
issuerUri Cadeia de caracteres URI do emissor do servidor de federação. Herdado de samlOrWsFedProvider.
metadadosExchangeUri Cadeia de caracteres URI do ponto de extremidade de troca de metadados usado para autenticação de aplicativos cliente avançados. Herdado de samlOrWsFedProvider.
nextSigningCertificate Cadeia de caracteres Certificado de assinatura de token de fallback que também pode ser usado para assinar tokens, por exemplo, quando o certificado de assinatura primária expira. Formatada como cadeias de caracteres codificadas base64 da parte pública do certificado de assinatura de token do IdP federado. Precisa ser compatível com a classe X509Certificate2. Assim como a assinaturaCertificate, a propriedade nextSigningCertificate será usada se uma rolagem for necessária fora da atualização de rolagem automática, um novo serviço de federação está sendo configurado ou se o novo certificado de assinatura de token não estiver presente nas propriedades da federação após a atualização do certificado de serviço de federação.
passiveSignInUri Cadeia de caracteres URI ao qual os clientes baseados na Web são direcionados ao entrar em serviços de Microsoft Entra. Herdado de samlOrWsFedProvider.
preferredAuthenticationProtocol authenticationProtocol Protocolo de autenticação preferencial. Os valores possíveis são: wsFed, saml, unknownFutureValue. Herdado de samlOrWsFedProvider.
promptLoginBehavior promptLoginBehavior Define o comportamento preferencial para o prompt de entrada. Os valores possíveis são: translateToFreshPasswordAuthentication, nativeSupport, disabled, unknownFutureValue.
signingCertificate Cadeia de caracteres Certificado atual usado para assinar tokens passados para o plataforma de identidade da Microsoft. O certificado é formatado como uma cadeia de caracteres codificada base64 da parte pública do certificado de assinatura de token do IdP federado e deve ser compatível com a classe X509Certificate2.
Essa propriedade é usada nos seguintes cenários:
  • Se uma rolagem for necessária fora da atualização de rolagem automática
  • Um novo serviço de federação está sendo configurado
  • Se o novo certificado de assinatura de token não estiver presente nas propriedades de federação após a atualização do certificado do serviço de federação.
    Microsoft Entra ID atualiza certificados por meio de um processo de autorollover no qual tenta recuperar um novo certificado dos metadados do serviço de federação, 30 dias antes do término do certificado atual. Se um novo certificado não estiver disponível, Microsoft Entra ID monitorará os metadados diariamente e atualizará as configurações de federação para o domínio quando um novo certificado estiver disponível. Herdado de samlOrWsFedProvider.
  • signingCertificateUpdateStatus signingCertificateUpdateStatus Fornece status e carimbo de data/hora da última atualização do certificado de assinatura.
    signOutUri Cadeia de caracteres URI para o qual os clientes são redirecionados quando saem dos serviços de Microsoft Entra. Corresponde à propriedade LogOffUri do cmdlet Set-MsolDomainFederationSettings MSOnline v1 PowerShell.

    Observação

    os módulos Azure AD e MSOnline PowerShell são preteridos a partir de 30 de março de 2024. Para saber mais, leia a atualização sobre substituição. Após essa data, o suporte para esses módulos é limitado à assistência de migração para o SDK do Microsoft Graph PowerShell e correções de segurança. Os módulos preteridos continuarão funcionando até março de 2025.

    Recomendamos migrar para o Microsoft Graph PowerShell para interagir com o Microsoft Entra ID (anteriormente Azure AD). Para perguntas comuns sobre migração, consulte as perguntas frequentes sobre migração. Nota: As versões 1.0.x do MSOnline podem sofrer interrupções após 30 de junho de 2024.

    valores federatedIdpMfaBehavior

    Member Descrição
    acceptIfMfaDoneByFederatedIdp Microsoft Entra ID aceita o MFA executado pelo provedor de identidade federado. Se o provedor de identidade federado não executou o MFA, Microsoft Entra ID executará o MFA.
    enforceMfaByFederatedIdp Microsoft Entra ID aceita o MFA executado pelo provedor de identidade federado. Se o provedor de identidade federado não executou o MFA, ele redirecionará a solicitação ao provedor de identidade federado para executar o MFA.
    rejectMfaByFederatedIdp Microsoft Entra ID sempre executa mfa e rejeita MFA executada pelo provedor de identidade federado.

    Observação

    federatedIdpMfaBehavior é uma versão evoluída da propriedade SupportsMfa do cmdlet Set-MsolDomainFederationSettings MSOnline v1 PowerShell.

    • Não há suporte para alternar entre federatedIdpMfaBehavior e SupportsMfa .
    • Quando a propriedade federatedIdpMfaBehavior é definida, Microsoft Entra ID ignora a configuração SupportsMfa.
    • Se a propriedade federatedIdpMfaBehavior nunca for definida, Microsoft Entra ID continuará honrando a configuração SupportsMfa.
    • Se nem federatedIdpMfaBehavior nem SupportsMfa estiver definido, Microsoft Entra ID será padrão para o acceptIfMfaDoneByFederatedIdp comportamento.

    Relações

    Nenhum

    Representação JSON

    A representação JSON a seguir mostra o tipo de recurso.

    {
      "@odata.type": "#microsoft.graph.internalDomainFederation",
      "id": "String (identifier)",
      "displayName": "String",
      "issuerUri": "String",
      "metadataExchangeUri": "String",
      "signingCertificate": "String",
      "passiveSignInUri": "String",
      "preferredAuthenticationProtocol": "String",
      "activeSignInUri": "String",
      "signOutUri": "String",
      "promptLoginBehavior": "String",
      "isSignedAuthenticationRequestRequired": "Boolean",
      "nextSigningCertificate": "String",
      "signingCertificateUpdateStatus": {
        "certificateUpdateResult": "String",
        "@odata.type": "microsoft.graph.signingCertificateUpdateStatus"
      },
      "federatedIdpMfaBehavior": "String"
    }