openIdConnectProvider resource type (preterido)

Artigo
11/16/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.

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.

Representa fornecedores de identidade do OpenID Connect num inquilino do Azure Active Directory B2C.

Configurar um fornecedor do OpenID Connect num inquilino B2C permite que os utilizadores se inscrevam e iniciem sessão com o respetivo fornecedor de identidade personalizado numa aplicação.

Herda de identityProvider.

Métodos

Nenhum.

Para obter a lista de operações de API para gerir o fornecedor do Open ID Connect, veja identityProvider.

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. Herdado de identityProvider. Esta é uma propriedade obrigatória.
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 em responseType. Quando responseType é `code`, é necessário um segredo para a troca de código de autenticação. Quando responseType é o segredo não é `id_token` necessário porque não existe nenhuma troca de código, o `id_token` é devolvido diretamente a partir da resposta de autorização. Isso é somente para gravar. Uma operação de leitura devolve "****". Herdado de identityProvider.
id	Cadeia de caracteres	O ID do provedor de identidade. É uma propriedade necessária e só é lida após a criação.
nome	Cadeia de caracteres	O nome de exibição exclusivo do provedor de identidade. É uma propriedade necessária e só é lida após a criação.
type	Cadeia de caracteres	A identidade do provedor de identidade. Deve ser `OpenIDConnect`. É uma propriedade necessária e só é lida após a criação.
claimsMapping	claimsMapping	Depois de o fornecedor OIDC enviar um token de ID de volta para Microsoft Entra ID, Microsoft Entra ID tem de conseguir mapear as afirmações do token recebido para as afirmações que Microsoft Entra ID reconhece e utiliza. Este tipo complexo captura esse mapeamento. É uma propriedade obrigatória.
domainHint	Cadeia de caracteres	A sugestão de domínio pode ser utilizada para avançar diretamente para a página de início de sessão do fornecedor de identidade especificado, em vez de fazer com que o utilizador faça uma seleção entre a lista de fornecedores de identidade disponíveis.
metadataUrl	Cadeia de caracteres	O URL do documento de metadados do fornecedor de identidade do OpenID Connect. Todos os fornecedores de identidade do OpenID Connect descrevem um documento de metadados que contém a maioria das informações necessárias para efetuar o início de sessão. Isto inclui informações como os URLs a utilizar e a localização das chaves de assinatura públicas do serviço. O documento de metadados do OpenID Connect está sempre localizado num ponto final que termina numa configuração bem conhecida/openid-configuration. Para o fornecedor de identidade do OpenID Connect que pretende adicionar, tem de fornecer o URL de metadados. É uma propriedade necessária e só é lida após a criação.
responseMode	openIdConnectResponseMode	O modo de resposta define o método que deve ser utilizado para enviar os dados de volta do fornecedor de identidade personalizado para Azure AD B2C. Os seguintes modos de resposta podem ser utilizados: `form_post`, `query`. `query` modo de resposta significa que o código ou token é devolvido como um parâmetro de consulta. `form_post` o modo de resposta é recomendado para obter a melhor segurança. A resposta é transmitida através do método HTTP POST, com o código ou token a ser codificado no corpo com o formato application/x-www-form-urlencoded. É uma propriedade obrigatória.
responseType	openIdConnectResponseTypes	O tipo de resposta descreve que tipo de informações são enviadas de volta na chamada inicial para o authorization_endpoint do fornecedor de identidade personalizado. Podem ser utilizados os seguintes tipos de resposta: `code` , `id_token` , `token`. É uma propriedade obrigatória.
scope	Cadeia de caracteres	O âmbito define as informações e as permissões que pretende recolher do seu fornecedor de identidade personalizado. Os pedidos do OpenID Connect têm de conter o valor de âmbito openid para receber o token de ID do fornecedor de identidade. Sem o token de ID, os utilizadores não conseguem iniciar sessão no Azure AD B2C com o fornecedor de identidade personalizado. Outros âmbitos podem ser anexados separados por espaço. Para obter mais informações sobre as limitações de âmbito, veja RFC6749 Secção 3.3. É uma propriedade obrigatória.

valores openIdConnectResponseTypes

Member	Descrição
código	De acordo com o fluxo de código de autorização, é devolvido um código ao Azure AD B2C. Azure AD B2C, chama o token_endpoint para trocar o código do token.
id_token	É devolvido um token de ID ao Azure AD B2C a partir do fornecedor de identidade personalizado.
token	É devolvido um token de acesso ao Azure AD B2C a partir do fornecedor de identidade personalizado. Atualmente, não é suportado pelo Azure AD B2C.

Relações

Nenhum

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "id": "String",
  "name": "String",
  "type": "String",
  "clientId": "String",
  "clientSecret": "String",
  "claimsMapping": {
      "@odata.type": "#microsoft.graph.claimsMapping",
      "userId": "String",
      "givenName": "String",
      "surname": "String",
      "email": "String",
      "displayName": "String"
  },
  "domainHint": "String",
  "metadataUrl": "String",
  "responseMode": "String",
  "responseType": "String",
  "scope": "String"
}

Compartilhar via