Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
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 provedores de identidade OpenID Connect em um locatário B2C do Azure Active Directory.
A configuração de um provedor OpenID Connect em um locatário B2C permite que os usuários se inscrevam e entrem usando seu provedor de identidade personalizado em um aplicativo.
Herda de identityProvider.
Métodos
Nenhum.
Para obter a lista de operações de API para gerenciar o provedor Open ID Connect, consulte 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, um segredo é necessário para a troca de código de autenticação. Quando responseType é id_token o segredo não é necessário porque não há troca de código, ele id_token é retornado diretamente da resposta de autorização. Isso é somente para gravar. Uma operação de leitura retorna "****". Herdado de identityProvider. |
| id | Cadeia de caracteres | O ID do provedor de identidade. É uma propriedade obrigatória e é lida somente após a criação. |
| nome | Cadeia de caracteres | O nome de exibição exclusivo do provedor de identidade. É uma propriedade obrigatória e é lida somente após a criação. |
| type | Cadeia de caracteres | A identidade do provedor de identidade. Deve ser OpenIDConnect. É uma propriedade obrigatória e é lida somente após a criação. |
| 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. É uma propriedade obrigatória. |
| domainHint | Cadeia de caracteres | A dica de domínio pode ser usada para pular diretamente para a página de login 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. 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úblicas do serviço. O documento de metadados do OpenID Connect está sempre localizado em um ponto de extremidade que termina em uma configuração bem conhecida/openid. Para o provedor de identidade OpenID Connect que você deseja adicionar, você precisa fornecer a URL de metadados. É uma propriedade obrigatória e é lida somente após a criação. |
| responseMode | openIdConnectResponseMode | O modo de resposta 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, query.
query modo de resposta significa que o código ou token é retornado como um parâmetro de consulta.
form_post O modo de resposta é recomendado para garantir a 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. É uma propriedade obrigatória. |
| responseType | openIdConnectResponseTypes | O tipo de resposta 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 , id_token , token. É uma propriedade obrigatória. |
| scope | Cadeia de caracteres | O escopo define as informações e permissões que você deseja coletar do seu provedor de identidade personalizada. As solicitações do OpenID Connect devem conter o valor do escopo openid para receber o token de ID do provedor de identidade. Sem o token de ID, os usuários não conseguem entrar no Azure AD B2C usando o provedor de identidade personalizado. Outros escopos podem ser acrescentados, separados por espaço. Para obter mais informações sobre as limitações do escopo, consulte RFC6749 Seção 3.3. É uma propriedade obrigatória. |
valores openIdConnectResponseTypes
| Member | Descrição |
|---|---|
| código | De acordo com o fluxo do código de autorização, um código é 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. Atualmente não há suporte no Azure AD B2C. |
Relações
Nenhum
Representação JSON
A representação JSON a seguir 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"
}