internalDomainFederation resource type

  • Artigo

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Representa configurações dos domínios num inquilino que são federados e verificados com Microsoft Entra ID. Utilize este recurso para configurar as definições de federação ao configurar a federação com Microsoft Entra ID. Para obter informações sobre a federação, consulte O que é a federação com Microsoft Entra ID?.

Herda de samlOrWsFedProvider.

Métodos

Método Tipo de retorno Descrição
List internalDomainFederation collection Leia as propriedades do objeto internalDomainFederation do domínio.
Create internalDomainFederation Crie um novo objeto internalDomainFederation .
Get internalDomainFederation Leia as propriedades e relações de um objeto internalDomainFederation .
Atualizar internalDomainFederation Atualize as propriedades de um objeto internalDomainFederation .
Delete Nenhum Elimine um objeto internalDomainFederation .

Propriedades

Propriedade Tipo Descrição
activeSignInUri Cadeia de caracteres URL do ponto final utilizado pelos clientes ativos ao autenticar com domínios federados configurados para início de sessão único no Microsoft Entra ID. Corresponde à propriedade ActiveLogOnUri do cmdlet Set-MsolDomainFederationSettings MSOnline v1 do PowerShell.
displayName Cadeia de caracteres O nome a apresentar do Fornecedor de identidade federado (IdP). Herdado de identityProviderBase.
federatedIdpMfaBehavior federatedIdpMfaBehavior Determina se Microsoft Entra ID aceita a MFA realizada pelo IdP federado quando um utilizador federado acede a uma aplicação que é regida 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, veja federatedIdpMfaBehavior values (Valores federatedIdpMfaBehavior).
id Cadeia de caracteres O identificador do fornecedor de identidade federado. Herdado da entidade.
isSignedAuthenticationRequestRequired Booliano Se true, quando os pedidos de autenticação SAML forem enviados para o IdP de SAML federado, Microsoft Entra ID assinará esses pedidos com a chave de assinatura OrgID. Se false (predefinição), os pedidos de autenticação SAML enviados para o IdP federado não estiverem assinados.
issuerUri Cadeia de caracteres URI do emissor do servidor de federação. Herdado de samlOrWsFedProvider.
metadataExchangeUri Cadeia de caracteres URI do ponto final do exchange de metadados utilizado para autenticação a partir de aplicações cliente avançadas. Herdado de samlOrWsFedProvider.
nextSigningCertificate Cadeia de caracteres Certificado de assinatura de token de contingência que também pode ser utilizado para assinar tokens, por exemplo, quando o certificado de assinatura principal expira. Formatado como cadeias codificadas com Base64 da parte pública do certificado de assinatura de tokens do IdP federado. Tem de ser compatível com a classe X509Certificate2. Tal como acontece com signingCertificate, a propriedade nextSigningCertificate é utilizada se for necessário um rollover fora da atualização de rollover automático, se estiver a ser configurado um novo serviço de federação ou 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.
passiveSignInUri Cadeia de caracteres O URI para o qual os clientes baseados na Web são direcionados ao iniciar sessão nos serviços Microsoft Entra. Herdado de samlOrWsFedProvider.
passwordResetUri Cadeia de caracteres URI para o qual os clientes são redirecionados para para repor a palavra-passe.
preferredAuthenticationProtocol authenticationProtocol Protocolo de autenticação preferencial. Este parâmetro tem de ser configurado explicitamente para que o fluxo de autenticação passiva de federação funcione. Os valores possíveis são: wsFed, saml, unknownFutureValue. Herdado de samlOrWsFedProvider.
promptLoginBehavior promptLoginBehavior Define o comportamento preferencial para o pedido de início de sessão. Os valores possíveis são: translateToFreshPasswordAuthentication, nativeSupport, disabled, unknownFutureValue.
signingCertificate Cadeia de caracteres Certificado atual utilizado para assinar tokens transmitidos para o plataforma de identidade da Microsoft. O certificado é formatado como uma cadeia codificada base64 da parte pública do certificado de assinatura de tokens do IdP federado e tem de ser compatível com a classe X509Certificate2.
Esta propriedade é utilizada nos seguintes cenários:
  • Se for necessário um rollover fora da atualização de inscrição automática
  • Está a ser configurado um novo serviço de federação
  • Se o novo certificado de assinatura de token não estiver presente nas propriedades de federação depois de o certificado do serviço de federação ter sido atualizado.
    Microsoft Entra ID atualiza certificados através de um processo de inscrição automática no qual tenta obter um novo certificado a partir dos metadados do serviço de federação, 30 dias antes da expiração do certificado atual. Se não estiver disponível um novo certificado, Microsoft Entra ID monitoriza os metadados diariamente e atualizará as definições de federação do domínio quando estiver disponível um novo certificado. 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 terminem sessão nos serviços Microsoft Entra. Corresponde à propriedade LogOffUri do cmdlet Set-MsolDomainFederationSettings MSOnline v1 do PowerShell.

    Observação

    Os módulos Azure AD e MSOnline PowerShell foram 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é 30 de março de 2025.

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

    federatedIdpMfaBehavior values (valores federatedIdpMfaBehavior)

    Member Descrição
    acceptIfMfaDoneByFederatedIdp Microsoft Entra ID aceita a MFA efetuada pelo fornecedor de identidade federado. Se o fornecedor de identidade federado não tiver executado a MFA, Microsoft Entra ID efetua a MFA.
    enforceMfaByFederatedIdp Microsoft Entra ID aceita a MFA efetuada pelo fornecedor de identidade federado. Se o fornecedor de identidade federado não tiver executado a MFA, redireciona o pedido para o fornecedor de identidade federado para executar a MFA.
    rejectMfaByFederatedIdp Microsoft Entra ID executa sempre a MFA e rejeita a MFA executada pelo fornecedor de identidade federado.

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

    • A mudança entre federatedIdpMfaBehavior e SupportsMfa não é suportada.
    • Assim que a propriedade federatedIdpMfaBehavior estiver definida, Microsoft Entra ID ignora a definição SupportsMfa.
    • Se a propriedade federatedIdpMfaBehavior nunca estiver definida, Microsoft Entra ID continua a respeitar a definição SupportsMfa.
    • Se nem federatedIdpMfaBehavior nem SupportsMfa estiverem definidos, Microsoft Entra ID predefinição é o acceptIfMfaDoneByFederatedIdp comportamento.

    Relações

    Nenhum

    Representação JSON

    A representação JSON seguinte 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",
  "passwordResetUri": "String"
}