Tipo de recurso openIdConnectProvider (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 de 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 o OpenID Conexão de identidade em um locatário Azure Active Directory B2C.
Configurar um provedor de Conexão OpenID em um locatário B2C permite que os usuários se inscrevam e se inscrevam usando seu provedor de identidade personalizado em um aplicativo.
Herda de identityProvider.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| List | conjunto identityProvider | Recupere todos os provedores de identidade configurados em um locatário. |
| Criar | openIdConnectProvider | Crie um novo provedor de Conexão de identidade OpenID. |
| Get | openIdConnectProvider | Recupere propriedades de um provedor de Conexão OpenID. |
| Atualizar | Nenhum(a) | Atualize um provedor de Conexão openid. |
| Delete | Nenhum | Exclua um provedor Conexão de identidade OpenID. |
| Listar os tipos de provedor disponíveis | Coleção de cadeias de caracteres | Recupere todos os tipos de provedor de identidade disponíveis. |
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. Essa é uma propriedade necessá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 de responseType. Quando responseType é code , um segredo é necessário para a troca de código de auth. Quando responseType é o segredo não é necessário porque não há troca de código, o é retornado id_token diretamente da resposta de id_token autorização. Isso é somente gravação. Uma operação de leitura retorna "****". Herdado de identityProvider. |
| id | Cadeia de caracteres | O ID do provedor de identidade. É uma propriedade necessá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 necessária e é lida somente após a criação. |
| tipo | Cadeia de caracteres | A identidade do provedor de identidade. Deve ser OpenIDConnect . É uma propriedade necessária e é lida somente após a criação. |
| claimsMapping | claimsMapping | Depois que o provedor OIDC envia um token de ID de volta para o Azure AD, o Azure AD precisa ser capaz de mapear as declarações do token recebido para as declarações que o Azure AD reconhece e usa. Esse tipo complexo captura esse mapeamento. É uma propriedade necessária. |
| 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 Conexão OpenID. Cada provedor Conexão de identidade OpenID descreve um documento de metadados que contém a maioria das informações necessárias para executar a login. Isso inclui informações como as URLs a ser usadas e o local das chaves de assinatura públicas do serviço. O documento Conexão de metadados do OpenID está sempre localizado em um ponto de extremidade que termina em .well-known/openid-configuration . Para o provedor de Conexão openid que você está procurando adicionar, você precisará fornecer a URL de metadados. É uma propriedade necessá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 personalizado 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 a 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. É uma propriedade necessária. |
| responseType | openIdConnectResponseTypes | tipo de resposta descreve que tipo de informação é enviada de volta na chamada inicial para o authorization_endpoint do provedor de identidade personalizado. Os seguintes tipos de resposta podem ser usados: code , id_token , token . É uma propriedade necessária. |
| escopo | String | O escopo define as informações e permissões que você está procurando coletar do provedor de identidade personalizado. As solicitações Conexão OpenID devem conter o valor de escopo openid para receber o token de 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 anexados separados pelo espaço. Para obter mais detalhes sobre as limitações de escopo, consulte RFC6749 Seção 3.3. É uma propriedade necessária. |
Valores openIdConnectResponseTypes
| Member | Descrição |
|---|---|
| código | Conforme o fluxo de código de autorização, um código será retornado para o Azure AD B2C. O 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 personalizado. |
| token | Um token de acesso é retornado ao Azure AD B2C do provedor de identidade personalizado. Atualmente, não há suporte para o Azure AD B2C. |
Representação JSON
Veja a seguir uma representação JSON do 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"
}
Comentários
Enviar e exibir comentários de