Partilhar via

Atualizar samlOrWsFedExternalDomainFederation

  • 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.

Atualize as propriedades de um objeto samlOrWsFedExternalDomainFederation .

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
Delegada (conta corporativa ou de estudante) IdentityProvider.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application IdentityProvider.ReadWrite.All Indisponível.

Importante

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. O Administrador do Fornecedor de Identidade Externo é a função com menos privilégios suportada para esta operação.

Solicitação HTTP

PATCH directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/{samlOrWsFedExternalDomainFederation ID}

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 um objeto JSON com uma ou mais propriedades que precisam de ser atualizadas para um objeto samlOrWsFedExternalDomainFederation no Microsoft Entra inquilino.

A tabela seguinte mostra as propriedades que pode atualizar para um objeto samlOrWsFedExternalDomainFederation .

Propriedade Tipo Descrição
displayName Cadeia de caracteres O nome a apresentar do fornecedor de identidade baseado em SAML/WS-Fed. Herdado de identityProviderBase.
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.
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.
preferredAuthenticationProtocol Cadeia de caracteres Protocolo de autenticação preferencial. Os valores suportados incluem saml ou wsfed. Herdado de samlOrWsFedProvider.
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.

Resposta

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

Exemplos

Solicitação

PATCH https://graph.microsoft.com/beta/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/d5a56845-6845-d5a5-4568-a5d54568a5d5
Content-Type: application/json

{
  "displayName": "Contoso name change",
  "issuerUri": "http://contoso-test.com/adfs/services/trust",
  "metadataExchangeUri": null,
  "signingCertificate": "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
  "passiveSignInUri": "https://contoso-test.com/adfs/ls/",
  "preferredAuthenticationProtocol": "wsFed"
}

Resposta

O exemplo a seguir mostra a resposta.

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

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

{
 "id": "d5a56845-6845-d5a5-4568-a5d54568a5d5",
  "displayName": "Contoso name change",
  "issuerUri": "http://contoso-test.com/adfs/services/trust",
  "metadataExchangeUri": null,
  "signingCertificate": "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
  "passiveSignInUri": "https://contoso-test.com/adfs/ls/",
  "preferredAuthenticationProtocol": "wsFed",
  "domains": [
      {
          "id": "contoso.com"
      }
  ]
}