tipo de recurso openIdConnectIdentityProvider

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

Representa provedores de identidade do OpenID Connect em um locatário B2C do Azure Active Directory (Azure AD).

Configurar um provedor do OpenID Connect em um locatário do Azure AD B2C permite que os usuários se inscrevam e entrem em qualquer aplicativo usando seu provedor de identidade personalizado.

Herdado de identityProviderBase.

Métodos

Método Tipo de retorno Descrição
List Coleção identityProviderBase Recupere todos os provedores de identidade configurados em um locatário, incluindo o tipo de objeto openIdConnectIdentityProvider . Não há como recuperar apenas os provedores de identidade OpenID Connect em um locatário.
Create openIdConnectIdentityProvider Crie um novo objeto openIdConnectIdentityProvider .
Get openIdConnectIdentityProvider Recupere propriedades de um objeto openIdConnectIdentityProvider .
Atualizar Nenhum(a) Atualize um objeto openIdConnectIdentityProvider .
Delete Nenhum Exclua um objeto openIdConnectIdentityProvider .
Listar os tipos de provedor disponíveis Coleção de cadeias de caracteres Recuperar todos os tipos de provedores de identidade disponíveis no locatário.

Propriedades

Propriedade Tipo Descrição
clientId Cadeia de caracteres O identificador do cliente para o aplicativo obtido ao registrar o aplicativo com o provedor de identidade. Obrigatório.
clientSecret Cadeia de caracteres O segredo do cliente para o aplicativo obtido ao registrar o aplicativo no provedor de identidade. O clientSecret tem uma dependência do responseType.
  • Quando responseType é code, um segredo é necessário para a troca de código de auth.
  • Quando responseType é id_token o segredo não é necessário porque não há troca de código. O id_token é retornado diretamente da resposta de autorização.
Isso é somente gravação. Uma operação de leitura retorna ****.
id Cadeia de caracteres O identificador do provedor de identidade. Necessário. Herdado de identityProviderBase. Somente leitura.
displayName Cadeia de caracteres O nome de exibição exclusivo do provedor de identidade.
claimsMapping claimsMapping Depois que o provedor OIDC envia um token de ID de volta ao Microsoft Entra ID, Microsoft Entra ID precisa ser capaz de mapear as declarações do token recebido para as declarações que Microsoft Entra ID reconhece e usa. Esse tipo complexo captura esse mapeamento. Obrigatório.
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.
metadadosUrl Cadeia de caracteres A URL do documento de metadados do provedor de identidade OpenID Connect. Cada provedor de identidade do OpenID Connect descreve um documento de metadados que contém a maioria das informações necessárias para executar a entrada. Isso inclui informações como as URLs a serem usadas e o local das chaves de assinatura pública do serviço. O documento de metadados do OpenID Connect está sempre localizado em um ponto de extremidade que termina em .well-known/openid-configuration. Forneça a URL de metadados para o provedor de identidade OpenID Connect que você adiciona. Somente leitura. Obrigatório.
responseMode openIdConnectResponseMode O modo de resposta define o método usado para enviar dados do provedor de identidade personalizado para Azure AD B2C. Valores possíveis: form_post, query. Obrigatório.
responseType openIdConnectResponseTypes O tipo de resposta descreve o tipo de informações enviadas de volta na chamada inicial para o authorization_endpoint do provedor de identidade personalizado. Valores possíveis: code , , tokenid_token . Obrigatório.
scope Cadeia de caracteres O escopo define as informações e permissões que você está procurando coletar do seu provedor de identidade personalizado. As solicitações openID Connect devem conter o valor de escopo openid para receber o token ID do provedor de identidade. Sem o token de ID, os usuários não podem entrar no Azure AD B2C usando o provedor de identidade personalizado. Outros escopos podem ser acrescentados, separados por um espaço. Para obter mais detalhes sobre as limitações de escopo, consulte RFC6749 Seção 3.3. Obrigatório.

valores openIdConnectResponseMode

Member Descrição
form_post Esse modo de resposta é recomendado para melhor segurança. A resposta é transmitida por meio do método HTTP POST, com o código ou token sendo codificado no corpo usando o formato application/x-www-form-urlencoded.
consulta O código ou token é retornado como um parâmetro de consulta.
unknownFutureValue Um valor sentinela para indicar valores futuros.

valores openIdConnectResponseTypes

Member Descrição
código De acordo com o fluxo de código de autorização, um código é retornado para Azure AD B2C. Azure AD B2C passa a chamar o token_endpoint para trocar o código pelo token.
id_token Um token de ID é retornado para Azure AD B2C do provedor de identidade personalizado.
token Um token de acesso é retornado para Azure AD B2C do provedor de identidade personalizado. (Esse valor não é suportado por Azure AD B2C no momento)

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
  "@odata.type": "#microsoft.graph.openIdConnectIdentityProvider",
  "id": "String (identifier)",
  "displayName": "String",
  "clientId": "String",
  "clientSecret": "String",
  "scope": "String",
  "metadataUrl": "String",
  "domainHint": "String",
  "responseType": "String",
  "responseMode": "String",
  "claimsMapping": {
    "@odata.type": "microsoft.graph.claimsMapping"
  }
}