Atualizar identityProvider (preterido)

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.

Cuidado

Essa API do provedor de identidade está preterida e deixará de retornar dados após março de 2023. Use a nova API de provedor de identidade.

Atualize as propriedades de um objeto identityProvider .

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

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

Solicitação HTTP

PATCH /identityProviders/{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 da solicitação, forneça a um objeto JSON uma ou mais propriedades que precisam ser atualizadas para um objeto identityProvider ou openIdConnectProvider (somente para o Azure AD B2C).

objeto identityProvider

Propriedade Tipo Descrição
clientId Cadeia de caracteres O ID do cliente para o aplicativo. Esta é a ID do cliente obtida ao registrar o aplicativo com o provedor de identidade.
clientSecret Cadeia de caracteres O segredo do cliente para o aplicativo. Este é o segredo do cliente obtido ao registrar o aplicativo com o provedor de identidade.
nome Cadeia de caracteres O nome de exibição exclusivo do provedor de identidade.
tipo Cadeia de caracteres A identidade do provedor de identidade.
    Para cenário B2B:
  • GoogleFacebook
    Para cenários B2C:Microsoft
  • , Google
  • ,
  • Amazon
  • , LinkedIn
  • , Facebook
  • , GitHub
  • , Twitter
  • , Weibo,
  • QQ
  • , WeChat
  • , OpenIDConnect

objeto openIdConnectProvider

Propriedade Tipo Descrição
clientId Cadeia de caracteres O ID do cliente para o aplicativo. Esta é a ID do cliente obtida ao registrar o aplicativo com o provedor de identidade.
clientSecret Cadeia de caracteres O segredo do cliente para o aplicativo. Este é o segredo do cliente obtido ao registrar o aplicativo com o provedor de identidade.
nome Cadeia de caracteres O nome de exibição exclusivo do provedor de identidade.
tipo Cadeia de caracteres A identidade do provedor de identidade. O valor deve ser OpenIdConnect.
claimsMapping claimsMapping Depois que o provedor OIDC envia um token de ID de volta ao Microsoft Entra ID, o Microsoft Entra ID precisa ser capaz de mapear as declarações do token recebido para as declarações que o Microsoft Entra ID reconhece e usa. Esse tipo complexo captura esse mapeamento.
domainHint Cadeia de caracteres A dica de domínio pode ser usada para pular diretamente para a página de entrada do provedor de identidade especificado, em vez de fazer com que o usuário faça uma seleção entre a lista de provedores de identidade disponíveis.
metadataUrl Cadeia de caracteres A URL do documento de metadados do provedor de identidade OpenID Connect.
responseMode Cadeia de caracteres Define o método que deve ser usado para enviar os dados de volta do provedor de identidade personalizada para o Azure AD B2C. Os seguintes modos de resposta podem ser usados:
  • form_post : Este modo de resposta é recomendado para melhor segurança. A resposta é transmitida através do método HTTP POST, com o código ou token sendo codificado no corpo usando o formato application/x-www-form-urlencoded.
  • query : O código ou token é retornado como um parâmetro de consulta.
responseType Cadeia de caracteres Descreve que tipo de informação é enviada de volta na chamada inicial para o authorization_endpoint do provedor de identidade personalizada. Os seguintes tipos de resposta podem ser usados:
  • code: de acordo com o fluxo do código de autorização, um código será retornado para o Azure AD B2C. Azure AD B2C continua a chamar o token_endpoint para trocar o código pelo token.
  • id_token: um token de ID é retornado ao Azure AD B2C do provedor de identidade personalizada.
  • token: Um token de acesso é retornado ao Azure AD B2C do provedor de identidade personalizada. (Este valor não é suportado pelo Azure AD B2C no momento)
scope Cadeia de caracteres O escopo define as informações e permissões que você deseja coletar de seu provedor de identidade personalizada.

Resposta

Se tiver êxito, este método retornará um código de resposta 204 No Content. Caso não consiga, um 4xx erro será retornado com detalhes específicos.

Exemplos

Exemplo 1: Atualizar um identityProvider específico

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/beta/identityProviders/Amazon-OAuth
Content-type: application/json

{
  "clientSecret": "1111111111111"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Exemplo 2: Atualizar um openIDConnectProvider específico (somente para o Azure AD B2C)

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/beta/identityProviders/OIDC-V1-MyTest-085a8a0c-58cb-4b6d-8e07-1328ea404e1a
Content-type: application/json

{
  "responseType": "id_token"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content