Atualizar samlOrWsFedExternalDomainFederation

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 de versão.

Atualize as propriedades de um objeto samlOrWsFedExternalDomainFederation .

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão	Permissões (da com menos para a com mais privilégios)
Delegada (conta corporativa ou de estudante)	IdentityProvider.ReadWrite.All
Delegada (conta pessoal da Microsoft)	Sem suporte.
Aplicativo	IdentityProvider.ReadWrite.All

A conta corporativa ou de estudante precisa pertencer a uma das seguintes funções do Azure Active Directory (Azure AD):

• Administrador Global
• Administrador do Provedor de Identidade Externo

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.
Content-Type	application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça um objeto JSON com uma ou mais propriedades que precisam ser atualizadas para um objeto samlOrWsFedExternalDomainFederation no Azure AD locatário.

A tabela a seguir mostra as propriedades que você pode atualizar para um objeto samlOrWsFedExternalDomainFederation .

Propriedade	Tipo	Descrição
displayName	String	O nome de exibição do provedor de identidade baseado em SAML/WS-Fed. Herdado de identityProviderBase.
issuerUri	String	URI do emissor do servidor de federação. Herdado de samlOrWsFedProvider.
metadataExchangeUri	String	URI do ponto de extremidade de troca de metadados usado para autenticação de aplicativos cliente avançados. Herdado de samlOrWsFedProvider.
passiveSignInUri	String	URI para o qual os clientes baseados na Web são direcionados ao entrar Azure AD serviços. Herdado de samlOrWsFedProvider.
preferredAuthenticationProtocol	String	Protocolo de autenticação preferencial. Os valores com suporte incluem saml ou wsfed. Herdado de samlOrWsFedProvider.
signingCertificate	String	Certificado atual usado para assinar tokens passados para o plataforma de identidade da Microsoft. O certificado é formatado como uma cadeia de caracteres codificada em 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 substituição for necessária fora da atualização de registro automático 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 depois que o certificado do serviço de federação tiver sido atualizado. Azure AD atualiza certificados por meio de um processo de registro automático no qual ele 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 Azure AD monitorará os metadados diariamente e atualizará as configurações de federação para o domínio quando um novo certificado estiver disponível.

Resposta

Se tiver êxito, este método 200 OK retornará um código de resposta e um objeto samlOrWsFedExternalDomainFederation atualizado no corpo da resposta.

Exemplos

Solicitação

HTTP

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

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var samlOrWsFedExternalDomainFederation = new SamlOrWsFedExternalDomainFederation
{
    DisplayName = "Contoso name change",
    IssuerUri = "http://contoso-test.com/adfs/services/trust",
    MetadataExchangeUri = null,
    SigningCertificate = "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
    PassiveSignInUri = "https://contoso-test.com/adfs/ls/",
    PreferredAuthenticationProtocol = AuthenticationProtocol.WsFed
};

await graphClient.Directory.FederationConfigurations["{samlOrWsFedExternalDomainFederation-id}"]
    .Request()
    .UpdateAsync(samlOrWsFedExternalDomainFederation);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão 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.

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const samlOrWsFedExternalDomainFederation = {
  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'
};

await client.api('/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/d5a56845-6845-d5a5-4568-a5d54568a5d5')
    .version('beta')
    .update(samlOrWsFedExternalDomainFederation);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão 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.

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/d5a56845-6845-d5a5-4568-a5d54568a5d5"]]];
[urlRequest setHTTPMethod:@"PATCH"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphSamlOrWsFedExternalDomainFederation *samlOrWsFedExternalDomainFederation = [[MSGraphSamlOrWsFedExternalDomainFederation alloc] init];
[samlOrWsFedExternalDomainFederation setDisplayName:@"Contoso name change"];
[samlOrWsFedExternalDomainFederation setIssuerUri:@"http://contoso-test.com/adfs/services/trust"];
[samlOrWsFedExternalDomainFederation setMetadataExchangeUri: null];
[samlOrWsFedExternalDomainFederation setSigningCertificate:@"M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ"];
[samlOrWsFedExternalDomainFederation setPassiveSignInUri:@"https://contoso-test.com/adfs/ls/"];
[samlOrWsFedExternalDomainFederation setPreferredAuthenticationProtocol: [MSGraphAuthenticationProtocol wsFed]];

NSError *error;
NSData *samlOrWsFedExternalDomainFederationData = [samlOrWsFedExternalDomainFederation getSerializedDataWithError:&error];
[urlRequest setHTTPBody:samlOrWsFedExternalDomainFederationData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão 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.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

SamlOrWsFedExternalDomainFederation samlOrWsFedExternalDomainFederation = new SamlOrWsFedExternalDomainFederation();
samlOrWsFedExternalDomainFederation.displayName = "Contoso name change";
samlOrWsFedExternalDomainFederation.issuerUri = "http://contoso-test.com/adfs/services/trust";
samlOrWsFedExternalDomainFederation.metadataExchangeUri = null;
samlOrWsFedExternalDomainFederation.signingCertificate = "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ";
samlOrWsFedExternalDomainFederation.passiveSignInUri = "https://contoso-test.com/adfs/ls/";
samlOrWsFedExternalDomainFederation.preferredAuthenticationProtocol = AuthenticationProtocol.WS_FED;

graphClient.directory().federationConfigurations().graph.samlOrWsFedExternalDomainFederation("d5a56845-6845-d5a5-4568-a5d54568a5d5")
    .buildRequest()
    .patch(samlOrWsFedExternalDomainFederation);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão 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.

Resposta

Este é um exemplo de 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"
      }
  ]
}