Atualizar internalDomainFederation

Namespace: microsoft.graph

Atualize as propriedades de um objeto internalDomainFederation .

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Domain-InternalFederation.ReadWrite.All Domain.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Domain-InternalFederation.ReadWrite.All Domain.ReadWrite.All

Importante

Para atualizar a propriedade authenticationType , o aplicativo de chamada deve receber a permissão Domain-InternalFederation.ReadWrite.All .

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. Esta operação dá suporte às seguintes funções internas, que fornecem apenas o menor privilégio necessário:

  • Administrador de Nome de Domínio
  • Administrador de provedor de identidade externo
  • Administrador de Identidade Híbrida
  • Administrador de Segurança

Solicitação HTTP

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

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça apenas os valores das propriedades a serem atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base nas alterações de outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

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.
displayName Cadeia de caracteres O nome de exibição do IdP (provedor de identidade federada).
federatedIdpMfaBehavior federatedIdpMfaBehavior Determina se o Microsoft Entra ID aceita a MFA executada pelo IdP federado quando um usuário federado acessa um aplicativo 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, consulte valores federatedIdpMfaBehavior.
isSignedAuthenticationRequestRequired Booliano Se true, quando solicitações de autenticação SAML forem enviadas para o IdP SAML federado, o 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 ao IdP federado não serão assinadas.
issuerUri Cadeia de caracteres URI do emissor do servidor de federação.
metadataExchangeUri Cadeia de caracteres URI do ponto de extremidade de troca de metadados usado para autenticação de aplicativos cliente avançados.
nextSigningCertificate Cadeia de caracteres Certificado de assinatura de token de fallback que é usado para assinar tokens quando o certificado de assinatura principal expira. Formatado como strings codificadas em Base 64 da parte pública do certificado de assinatura de token do IdP federado. Precisa ser compatível com a classe X509Certificate2. Assim como o signingCertificate, a propriedade nextSigningCertificate será usada se uma substituição for necessária fora da atualização do autorollover, se um novo serviço de federação estiver sendo configurado ou se o novo certificado de assinatura de token não estiver presente nas propriedades de federação após o certificado do serviço de federação ter sido atualizado.
passiveSignInUri Cadeia de caracteres URI para o qual os clientes baseados na Web são direcionados ao entrar nos serviços do Microsoft Entra.
preferredAuthenticationProtocol authenticationProtocol Protocolo de autenticação preferencial. Esse parâmetro deve ser configurado explicitamente para que o fluxo de autenticação passiva de federação funcione. Os valores possíveis são: wsFed, saml, unknownFutureValue.
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 a plataforma de identidade da Microsoft. O certificado é formatado como uma cadeia de caracteres codificada em Base 64 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 substituição for necessária fora da atualização de substituição 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 de serviço de federação.
    O Microsoft Entra ID atualiza certificados por meio de um processo de substituição automática no qual tenta recuperar um novo certificado dos metadados do serviço de federação, 30 dias antes da expiração do certificado atual. Se um novo certificado não estiver disponível, o Microsoft Entra ID monitorará os metadados diariamente e atualizará as configurações de federação do domínio quando um novo certificado estiver disponível. Herdado de samlOrWsFedProvider.
  • signingCertificateUpdateStatus signingCertificateUpdateStatus Fornece o status e o 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 do Microsoft Entra.

    valores federatedIdpMfaBehavior

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

    Observação

    federatedIdpMfaBehavior é uma versão evoluída da propriedade SupportsMfa do Set-MsolDomainFederationSettings cmdlet do módulo desativado MSOnline do PowerShell.

    • Não há suporte para alternar entre federatedIdpMfaBehavior e SupportsMfa .
    • Quando a propriedade federatedIdpMfaBehavior é definida, o Microsoft Entra ID ignora a configuração SupportsMfa.
    • Se a propriedade federatedIdpMfaBehavior nunca for definida, o Microsoft Entra ID continuará a respeitar a configuração SupportsMfa.
    • Se nem federatedIdpMfaBehavior nem SupportsMfa estiverem definidos, o Microsoft Entra ID usará como padrão o acceptIfMfaDoneByFederatedIdp comportamento.

    Resposta

    Se tiver êxito, este método retornará um código de resposta 204 No Content.

    Exemplos

    Solicitação

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

    Resposta

    Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

    HTTP/1.1 204 No Content