Atualizar internalDomainFederation

Artigo
07/04/2024

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.

Atualize as propriedades de um objeto internalDomainFederation .

Esta API está disponível nas seguintes implementações de cloud nacionais.

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

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	Domain.ReadWrite.All	Indisponível.
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Aplicativo	Domain.ReadWrite.All	Indisponível.

Importante

Este método tem um problema de permissões conhecido e pode exigir consentimento para a permissão Directory.AccessAsUser.All para cenários delegados.

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.

Administrador de Nomes de Domínio
Administrador do Fornecedor 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 do pedido, forneça apenas os valores das propriedades a atualizar. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em alterações a 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 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).
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).
isSignedAuthenticationRequestRequired	Booliano	Se `true`, quando os pedidos de autenticação SAML forem enviados para o IdP de SAML federado, Microsoft Entra ID iniciar sessão nesses 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.
metadataExchangeUri	Cadeia de caracteres	URI do ponto final do exchange de metadados utilizado para autenticação a partir de aplicações cliente avançadas.
nextSigningCertificate	Cadeia de caracteres	Certificado de assinatura de token de contingência que é utilizado para assinar tokens quando o certificado de assinatura principal expira. Formatado como cadeias codificadas com base 64 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 inscrição automática, 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.
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`.
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 base 64 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 atualiza as definições de federação do domínio quando está 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.

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto internalDomainFederation atualizado no corpo da resposta.

Exemplos

Solicitação

PATCH https://graph.microsoft.com/beta/domains/contoso.com/federationConfiguration/6601d14b-d113-8f64-fda2-9b5ddda18ecc
Content-Type: application/json

{
  "displayName": "Contoso name change",  
  "federatedIdpMfaBehavior": "acceptIfMfaDoneByFederatedIdp"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new InternalDomainFederation
{
	DisplayName = "Contoso name change",
	FederatedIdpMfaBehavior = FederatedIdpMfaBehavior.AcceptIfMfaDoneByFederatedIdp,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Domains["{domain-id}"].FederationConfiguration["{internalDomainFederation-id}"].PatchAsync(requestBody);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



mgc-beta domains federation-configuration patch --domain-id {domain-id} --internal-domain-federation-id {internalDomainFederation-id} --body '{\
  "displayName": "Contoso name change",  \
  "federatedIdpMfaBehavior": "acceptIfMfaDoneByFederatedIdp"\
}\
'

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewInternalDomainFederation()
displayName := "Contoso name change"
requestBody.SetDisplayName(&displayName) 
federatedIdpMfaBehavior := graphmodels.ACCEPTIFMFADONEBYFEDERATEDIDP_FEDERATEDIDPMFABEHAVIOR 
requestBody.SetFederatedIdpMfaBehavior(&federatedIdpMfaBehavior) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
federationConfiguration, err := graphClient.Domains().ByDomainId("domain-id").FederationConfiguration().ByInternalDomainFederationId("internalDomainFederation-id").Patch(context.Background(), requestBody, nil)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

InternalDomainFederation internalDomainFederation = new InternalDomainFederation();
internalDomainFederation.setDisplayName("Contoso name change");
internalDomainFederation.setFederatedIdpMfaBehavior(FederatedIdpMfaBehavior.AcceptIfMfaDoneByFederatedIdp);
InternalDomainFederation result = graphClient.domains().byDomainId("{domain-id}").federationConfiguration().byInternalDomainFederationId("{internalDomainFederation-id}").patch(internalDomainFederation);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const internalDomainFederation = {
  displayName: 'Contoso name change',  
  federatedIdpMfaBehavior: 'acceptIfMfaDoneByFederatedIdp'
};

await client.api('/domains/contoso.com/federationConfiguration/6601d14b-d113-8f64-fda2-9b5ddda18ecc')
	.version('beta')
	.update(internalDomainFederation);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\InternalDomainFederation;
use Microsoft\Graph\Beta\Generated\Models\FederatedIdpMfaBehavior;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new InternalDomainFederation();
$requestBody->setDisplayName('Contoso name change');
$requestBody->setFederatedIdpMfaBehavior(new FederatedIdpMfaBehavior('acceptIfMfaDoneByFederatedIdp'));

$result = $graphServiceClient->domains()->byDomainId('domain-id')->federationConfiguration()->byInternalDomainFederationId('internalDomainFederation-id')->patch($requestBody)->wait();

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	displayName = "Contoso name change"
	federatedIdpMfaBehavior = "acceptIfMfaDoneByFederatedIdp"
}

Update-MgBetaDomainFederationConfiguration -DomainId $domainId -InternalDomainFederationId $internalDomainFederationId -BodyParameter $params

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.internal_domain_federation import InternalDomainFederation
from msgraph_beta.generated.models.federated_idp_mfa_behavior import FederatedIdpMfaBehavior
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = InternalDomainFederation(
	display_name = "Contoso name change",
	federated_idp_mfa_behavior = FederatedIdpMfaBehavior.AcceptIfMfaDoneByFederatedIdp,
)

result = await graph_client.domains.by_domain_id('domain-id').federation_configuration.by_internal_domain_federation_id('internalDomainFederation-id').patch(request_body)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.internalDomainFederation",
  "id": "6601d14b-d113-8f64-fda2-9b5ddda18ecc",
   "displayName": "Contoso name change",
   "issuerUri": "http://contoso.com/adfs/services/trust",
   "metadataExchangeUri": "https://sts.contoso.com/adfs/services/trust/mex",
   "signingCertificate": "MIIE3jCCAsagAwIBAgIQQcyDaZz3MI",
   "passiveSignInUri": "https://sts.contoso.com/adfs/ls",
   "preferredAuthenticationProtocol": "wsFed",
   "activeSignInUri": "https://sts.contoso.com/adfs/services/trust/2005/usernamemixed",
   "signOutUri": "https://sts.contoso.com/adfs/ls",
   "promptLoginBehavior": "nativeSupport",
   "isSignedAuthenticationRequestRequired": true,
   "nextSigningCertificate": "MIIE3jCCAsagAwIBAgIQQcyDaZz3MI",
   "signingCertificateUpdateStatus": {
        "certificateUpdateResult": "Success",
        "lastRunDateTime": "2021-08-25T07:44:46.2616778Z"
    },
   "federatedIdpMfaBehavior": "acceptIfMfaDoneByFederatedIdp",
   "passwordResetUri": "https://sts.contoso.com/adfs/passwordReset"
}

Partilhar via

Atualizar internalDomainFederation

Permissões

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

federatedIdpMfaBehavior values (valores federatedIdpMfaBehavior)

Resposta

Exemplos

Solicitação

Resposta

Comentários

Recursos adicionais