openIdConnectIdentityProvider resource type (Tipo de recurso openIdConnectIdentityProvider)

Artigo
07/23/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.

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

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

Herdado de identityProviderBase.

Métodos

Nenhum.

Para obter a lista de operações de API para gerir fornecedores de identidade do OpenID Connect, veja o tipo de recurso identityProviderBase .

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 em responseType. Quando responseType é `code`, é necessário um segredo para a troca de código de autenticação. Quando responseType é `id_token` o segredo não é 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 gravação. Uma operação de leitura retorna `****`.
id	Cadeia de caracteres	O identificador do fornecedor 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 de o fornecedor OIDC enviar um token de ID de volta para o Microsoft Entra ID, o Microsoft Entra ID tem de conseguir mapear as afirmações do token recebido para as afirmações que o ID do Microsoft Entra reconhece e utiliza. Este tipo complexo captura esse mapeamento. Obrigatório.
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 em `.well-known/openid-configuration`. Indique o URL de metadados do fornecedor de identidade do OpenID Connect que adicionar. Somente leitura. Obrigatório.
responseMode	openIdConnectResponseMode	O modo de resposta define o método utilizado para enviar dados do fornecedor de identidade personalizado para o Azure AD B2C. Valores possíveis: `form_post`, `query`. Obrigatório.
responseType	openIdConnectResponseTypes	O tipo de resposta descreve o tipo de informações enviadas na chamada inicial para o authorization_endpoint do fornecedor de identidade personalizado. Valores possíveis: `code` , , `id_tokentoken`. Obrigatório.
scope	Cadeia de caracteres	O âmbito define as informações e 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 acrescentados, separados por um espaço. Para obter mais detalhes sobre as limitações de âmbito, veja RFC6749 Secção 3.3. Obrigatório.

valores openIdConnectResponseMode

Member	Descrição
form_post	Este modo de resposta é recomendado para uma 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.
consulta	O código ou token é devolvido como um parâmetro de consulta.
unknownFutureValue	Um valor sentinel para indicar valores futuros.

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. O Azure AD B2C continua a chamar 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. (Neste momento, este valor não é suportado pelo Azure AD B2C)

Representação JSON

A representação JSON seguinte 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"
  }
}

Compartilhar via