As contas são vinculadas usando fluxos implícitos e de código de autorização padrão do setor 2.0. Seu serviço precisa ser compatível com endpoints de autorização e troca de tokens compatíveis com o OAuth 2.0.
No fluxo implícito, o Google abre o endpoint de autorização no navegador do usuário. Após o login, você retorna um token de acesso de longa duração ao Google. Agora, esse token de acesso está incluído em todas as solicitações enviadas do Google.
No fluxo de código de autorização, você precisa de dois endpoints:
o endpoint de autorização, que apresenta a IU de login aos seus usuários que ainda não fizeram login; O endpoint de autorização também cria um código de autorização de curta duração para registrar usuários e consentir com o acesso solicitado.
O endpoint de troca de token, responsável por dois tipos de trocas:
- Troca um código de autorização por um token de atualização de longa duração e um token de acesso de curta duração. Essa troca acontece quando o usuário passa pelo fluxo de vinculação da conta.
- Troca um token de atualização de longa duração por um token de acesso de curta duração. Essa troca acontece quando o Google precisa de um novo token de acesso porque ele expirou.
Escolher um fluxo do OAuth 2.0
Embora o fluxo implícito seja mais simples de implementar, o Google recomenda que os tokens de acesso emitidos pelo fluxo implícito nunca expirem. Isso ocorre porque o usuário é forçado a vincular a conta novamente depois que um token expira com o fluxo implícito. Se você precisar da expiração do token por motivos de segurança, é altamente recomendável usar o fluxo de código de autorização.
Diretrizes de design
Esta seção descreve os requisitos de projeto e as recomendações para a tela do usuário hospedada para fluxos de vinculação do OAuth. Depois de ser chamado pelo app do Google, sua plataforma exibe um login na página do Google e na tela de consentimento de vinculação da conta ao usuário. O usuário é redirecionado de volta ao app do Google depois de autorizar a vinculação das contas.
![Esta figura mostra as etapas para um usuário vincular a Conta do Google
ao seu sistema de autenticação. A primeira captura de tela mostra
a vinculação iniciada pelo usuário na sua plataforma. A segunda imagem mostra
o login do usuário no Google, e a terceira mostra o consentimento e a
confirmação para vincular a Conta do Google dele ao seu app. A
captura de tela final mostra uma conta de usuário vinculada com sucesso no
Google app.](https://developers-dot-devsite-v2-prod.appspot.com/static/identity/images/oauth-linking-flow.png?authuser=19&hl=pt-br)
Requisitos
- Você precisa comunicar que a conta do usuário será vinculada ao Google, não a um produto específico do Google, como o Google Home ou o Google Assistente.
Recomendações
Portanto, recomendamos que você faça o seguinte:
Exibir a Política de Privacidade do Google. Inclua um link para a Política de Privacidade do Google na tela de consentimento.
Dados a serem compartilhados. Use uma linguagem clara e concisa para dizer ao usuário quais dados o Google exige e por quê.
Call-to-action clara. Insira uma call-to-action clara na tela de consentimento, como "Aceitar e vincular". Isso ocorre porque os usuários precisam entender quais dados eles precisam compartilhar com o Google para vincular as contas.
Opção de cancelamento. Ofereça aos usuários a opção de voltar ou cancelar.
Limpar o processo de login. Verifique se os usuários têm um método claro para fazer login na Conta do Google, como campos de nome de usuário e senha ou Fazer login com o Google.
Capacidade de desvincular. Ofereça um mecanismo para os usuários desvincularem, como um URL para as configurações da conta na plataforma. Se preferir, inclua um link para a Conta do Google em que os usuários possam gerenciar a conta vinculada.
É possível mudar a conta de usuário. Sugerir um método para os usuários trocarem de conta. Isso é útil principalmente quando os usuários costumam ter várias contas.
- Se um usuário precisar fechar a tela de consentimento para alternar entre contas, envie um erro recuperável ao Google para que o usuário possa fazer login na conta desejada com vinculação do OAuth e o fluxo implícito.
Inclua seu logotipo. Exiba o logotipo da sua empresa na tela de consentimento. Use suas diretrizes de estilo para inserir o logotipo. Se você também quiser exibir o logotipo do Google, consulte Logotipos e marcas registradas.
![Esta figura mostra exemplos de telas de login e consentimento do usuário com
chamadas para os requisitos e recomendações individuais que
serão seguidas quando você criar uma tela de login e consentimento do usuário.](https://developers-dot-devsite-v2-prod.appspot.com/static/identity/images/oauth-linking-consent.png?authuser=19&hl=pt-br)
Criar o projeto
Para criar seu projeto e usar a vinculação de contas, faça o seguinte:
- Go to the Google API Console.
- Clique em Criar projeto .
- Digite um nome ou aceite a sugestão gerada.
- Confirme ou edite os campos restantes.
- Clique em Create .
Para visualizar o seu ID do projeto:
- Go to the Google API Console.
- Encontre seu projeto na tabela na página de destino. O ID do projeto aparece na coluna ID .
Configurar a tela de permissão OAuth
O processo de vinculação de Contas do Google inclui uma tela de consentimento que informa aos usuários o aplicativo que está solicitando acesso aos dados deles, o tipo de dado solicitado e os termos aplicáveis. Você precisa configurar a tela de permissão OAuth antes de gerar um ID do cliente da API do Google.
- Abra a página Tela de permissão OAuth do Console de APIs do Google.
- Se solicitado, selecione o projeto que você acabou de criar.
Na página "Tela de permissão OAuth", preencha o formulário e clique no botão "Salvar".
Nome do aplicativo: o nome do aplicativo que está solicitando o consentimento. O nome precisa refletir com precisão o aplicativo e ser consistente com o nome do aplicativo que os usuários veem em outros lugares. O nome do aplicativo vai ser mostrado na tela de permissão da vinculação de contas.
Logotipo do aplicativo:uma imagem na tela de permissão que ajuda os usuários a reconhecer seu app. O logotipo é exibido na tela de permissão para vinculação de contas e nas configurações da conta.
E-mail de suporte:para os usuários entrarem em contato com você para esclarecer dúvidas sobre o consentimento.
Escopos para APIs do Google:os escopos permitem que seu aplicativo acesse os dados particulares do usuário do Google. Para o caso de uso de vinculação de Conta do Google, o escopo padrão (e-mail, perfil, OpenID) é suficiente. Não é necessário adicionar escopos confidenciais. Geralmente, é uma prática recomendada solicitar escopos de forma incremental no momento em que o acesso é necessário, em vez de antecipadamente. Saiba mais.
Domínios autorizados:para proteger você e seus usuários, o Google permite que apenas aplicativos com autenticação OAuth usem os domínios autorizados. Os links dos seus aplicativos precisam estar hospedados em domínios autorizados. Saiba mais.
Link da página inicial do aplicativo: página inicial do seu aplicativo. Precisa estar hospedado em um domínio autorizado.
Link da Política de Privacidade do aplicativo:aparece na tela de permissão para vinculação de Contas do Google. Precisa estar hospedado em um domínio autorizado.
Link dos Termos de Serviço do aplicativo (opcional): precisa ser hospedado em um domínio autorizado.
Figura 1. Tela de consentimento de vinculação de Conta do Google para um aplicativo fictício, o Tunery
Marque o "Status da verificação" se o seu aplicativo precisar de verificação e clique no botão "Enviar para verificação" para enviá-lo para verificação. Consulte os requisitos de verificação do OAuth para ver mais detalhes.
Implementar o servidor OAuth
Uma implementação do servidor OAuth 2.0 do fluxo do código de autorização consiste em: dois endpoints, que seu serviço disponibiliza por HTTPS. O primeiro endpoint é o endpoint de autorização, responsável por encontrar ou conseguir o consentimento dos usuários para acesso aos dados. O endpoint de autorização apresenta uma interface de login para os usuários que ainda não estão conectados e registra o consentimento para o acesso solicitado. O segundo endpoint é a troca de tokens, é usado para obter strings criptografadas, chamadas de tokens, que autorizam um usuário a para acessar seu serviço.
Quando um aplicativo do Google precisa chamar uma das APIs do seu serviço, o Google usa esses endpoints juntos para conseguir a permissão dos usuários para chamar essas APIs em nome deles.
Uma sessão do fluxo do código de autorização do OAuth 2.0 iniciada pelo Google tem seguinte fluxo:
- O Google abre seu endpoint de autorização no navegador do usuário. Se o fluxo iniciada em um dispositivo somente de voz para uma ação, o Google transfere a execução em um smartphone.
- Caso ainda não tenha feito login, o usuário faz login e concede ao Google permissão para acessar os dados com a API, caso ainda não tenham concedido permissão.
- Seu serviço cria um código de autorização e o retorna ao Google. Afazeres Por isso, redirecione o navegador do usuário de volta para o Google com o código de autorização anexada à solicitação.
- O Google envia o código de autorização para seu endpoint de troca de token, verifica a autenticidade do código e retorna um token de acesso e um token de atualização. O token de acesso é um token de curta duração que seu serviço aceita como credenciais para acessar APIs. O token de atualização é um token de atualização token que o Google pode armazenar e usar para adquirir novos tokens de acesso e depois ela expira.
- Depois que o usuário tiver concluído o fluxo de vinculação à conta, todas as solicitação enviada pelo Google contém um token de acesso.
Processar solicitações de autorização
Quando você precisa vincular a conta usando o código de autorização do OAuth 2.0. fluxo, o Google envia o usuário para seu endpoint de autorização com uma solicitação que inclui os seguintes parâmetros:
Parâmetros de endpoint de autorização | |
---|---|
client_id |
O Client-ID que você atribuiu ao Google. |
redirect_uri |
O URL para o qual você envia a resposta para essa solicitação. |
state |
Um valor de contabilidade que é retornado ao Google inalterado na URI de redirecionamento. |
scope |
Opcional:um conjunto delimitado por espaços de strings de escopo que especifica o dados para os quais o Google está solicitando autorização. |
response_type |
O tipo de valor a ser retornado na resposta. Para a solicitação OAuth 2.0,
fluxo do código de autorização, o tipo de resposta será sempre code .
|
user_locale |
A configuração de idioma da Conta do Google no RFC5646 usado para localizar seu conteúdo no idioma de preferência do usuário. |
Por exemplo, se o endpoint de autorização estiver disponível em
https://myservice.example.com/auth
, uma solicitação terá esta aparência:
GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&scope=REQUESTED_SCOPES&response_type=code&user_locale=LOCALE
Para que o endpoint de autorização processe solicitações de login, faça o seguinte: etapas:
- Verifique se o
client_id
corresponde ao ID do cliente atribuído ao Google e se oredirect_uri
corresponde ao URL de redirecionamento fornecido pelo Google para seu serviço. Essas verificações são importantes para impedir a concessão o acesso a apps clientes não intencionais ou configurados incorretamente. Se você oferece suporte a vários Fluxos do OAuth 2.0. Confirme também se oresponse_type
écode
. - Verifique se o usuário está conectado ao seu serviço. Se o usuário não estiver conectado, para concluir o fluxo de login ou inscrição do serviço.
- Gere um código de autorização para o Google usar no acesso à API. O código de autorização pode ser qualquer valor de string, mas deve ser representar o usuário, o cliente a que o token se destina e a expiração do código tempo de resposta e não deve ser adivinhado. Você normalmente emite uma autorização que expiram após aproximadamente 10 minutos.
- Confirme se o URL especificado pelo parâmetro
redirect_uri
tem o seguinte formato:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
- Redirecione o navegador do usuário para o URL especificado pelo
parâmetro
redirect_uri
. Inclua o código de autorização que você e o valor do estado original e inalterado ao redirecionar anexando os parâmetroscode
estate
. Confira a seguir exemplo do URL resultante:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING
Processar solicitações de troca de token
O endpoint de troca de token do seu serviço é responsável por dois tipos de token trocas:
- Trocar códigos de autorização por tokens de acesso e de atualização
- Trocar tokens de atualização por tokens de acesso
As solicitações de troca de token incluem os seguintes parâmetros:
Parâmetros de endpoint de troca de token | |
---|---|
client_id |
Uma string que identifica a origem da solicitação como o Google. Essa string precisa ser registrado em seu sistema como identificador exclusivo do Google. |
client_secret |
Uma string secreta que você registrou no Google para seu serviço. |
grant_type |
O tipo de token que está sendo trocado. É
authorization_code ou refresh_token . |
code |
Quando grant_type=authorization_code , esse parâmetro é o
O código que o Google recebeu do seu login ou da troca de tokens
endpoint do Google Cloud. |
redirect_uri |
Quando grant_type=authorization_code , esse parâmetro é o
URL usado na solicitação de autorização inicial. |
refresh_token |
Quando grant_type=refresh_token , esse parâmetro é o
token de atualização que o Google recebeu de seu endpoint de troca de token. |
Trocar códigos de autorização por tokens de acesso e de atualização
Depois que o usuário fizer login e o endpoint de autorização retornar um endereço de e-mail código de autorização ao Google, ele envia uma solicitação à troca de token para trocar o código de autorização por um token de acesso e uma atualização com base no token correto anterior.
Para essas solicitações, o valor de grant_type
é authorization_code
, e a
o valor de code
é o valor do código de autorização concedido anteriormente
para o Google. Veja a seguir um exemplo de solicitação para trocar um
código de autorização para um token de acesso e um token de atualização:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI
Para trocar códigos de autorização por um token de acesso e um token de atualização, seu
endpoint de troca de token responde a solicitações POST
executando o seguinte
etapas:
- Verifique se
client_id
identifica a origem da solicitação como origem e se oclient_secret
corresponde ao valor esperado. - Verifique se o código de autorização é válido e não expirou, e se o ID do cliente especificado na solicitação corresponde ao ID do cliente associado à código de autorização.
- Confirme se o URL especificado pelo parâmetro
redirect_uri
é idêntico ao valor usado na solicitação de autorização inicial. - Se não for possível verificar todos os critérios acima, retorne uma solicitação HTTP
Erro 400 Solicitação inválida com
{"error": "invalid_grant"}
como o corpo. - Caso contrário, use o ID do usuário do código de autorização para gerar uma atualização e um token de acesso. Esses tokens podem ser de qualquer valor de string, devem representar exclusivamente o usuário e o cliente a que o token se destina, e elas não pode ser adivinhado. Para tokens de acesso, registre também o tempo de expiração o token, que normalmente é uma hora após a emissão do token. Os tokens de atualização não expiram.
- Retorne o seguinte objeto JSON no corpo da resposta HTTPS:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "refresh_token": "REFRESH_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
O Google armazena os tokens de acesso e de atualização do usuário e dos registros a expiração do token de acesso. Quando o token de acesso expira, o Google usa o token de atualização para receber um novo token de acesso do endpoint de troca de tokens.
Trocar tokens de atualização por tokens de acesso
Quando um token de acesso expira, o Google envia uma solicitação à troca de tokens endpoint para trocar um token de atualização por um novo token de acesso.
Para essas solicitações, o valor de grant_type
é refresh_token
, e o valor
de refresh_token
é o valor do token de atualização concedido anteriormente para
Google. Este é um exemplo de solicitação para trocar um token de atualização
para um token de acesso:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN
Para trocar um token de atualização por um de acesso, o endpoint de troca de token
responde a solicitações POST
executando as seguintes etapas:
- Verifique se
client_id
identifica a origem da solicitação como Google. se oclient_secret
corresponde ao valor esperado. - Verifique se o token de atualização é válido e se o ID do cliente especificado em a solicitação corresponde ao ID do cliente associado ao token de atualização.
- Se não for possível verificar todos os critérios acima, retorne um erro HTTP 400
Erro de solicitação inválido com
{"error": "invalid_grant"}
como o corpo. - Caso contrário, use o ID de usuário do token de atualização para gerar um acesso com base no token correto anterior. Esses tokens podem ser de qualquer valor de string, mas devem ser representam o usuário e o cliente a que o token se destina, e eles não devem ser pode ser adivinhado. Para tokens de acesso, registre também o tempo de expiração do token. geralmente uma hora após a emissão do token.
- Retorne o seguinte objeto JSON no corpo da solicitação
resposta:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
Processar solicitações userinfo
O endpoint userinfo é um recurso protegido pelo OAuth 2.0 que retorna declarações sobre o usuário vinculado. A implementação e hospedagem do endpoint userinfo é opcional, exceto nos seguintes casos de uso:
- Login da conta vinculada com o Google One Tap.
- Assinatura sem atrito no AndroidTV.
Depois que o token de acesso for recuperado do endpoint do token, o Google enviará uma solicitação ao endpoint de informações do usuário para recuperar informações básicas de perfil sobre o usuário vinculado.
cabeçalhos de solicitação do endpoint userinfo | |
---|---|
Authorization header |
O token de acesso do tipo Bearer. |
Por exemplo, se seu ponto de extremidade de informações do usuário estiver disponível em
https://myservice.example.com/userinfo
, uma solicitação terá esta aparência:
GET /userinfo HTTP/1.1 Host: myservice.example.com Authorization: Bearer ACCESS_TOKEN
Para que o endpoint userinfo processe solicitações, siga estas etapas:
- Extrair o token de acesso do cabeçalho "Autorização" e retornar as informações do usuário associado ao token de acesso.
- Se o token de acesso for inválido, retorne o erro "HTTP 401 Unused" ao usar o cabeçalho de resposta
WWW-Authenticate
. Veja abaixo um exemplo de resposta de erro userinfo:HTTP/1.1 401 Unauthorized WWW-Authenticate: error="invalid_token", error_description="The Access Token expired"
Se uma resposta de erro "401 Não autorizado" ou outra resposta de erro for retornada durante o processo de vinculação, o erro não poderá ser recuperado, o token recuperado será descartado e o usuário terá que iniciar o processo de vinculação novamente. Se o token de acesso for válido, retorne uma resposta HTTP 200 com o seguinte objeto JSON no corpo do HTTPS resposta:
{ "sub": "USER_UUID", "email": "EMAIL_ADDRESS", "given_name": "FIRST_NAME", "family_name": "LAST_NAME", "name": "FULL_NAME", "picture": "PROFILE_PICTURE", }
Se o seu endpoint de informações do usuário retornar uma resposta HTTP 200 bem-sucedida, o token e as reivindicações recuperados serão registrados na Conta do Google do usuário.resposta do endpoint userinfo sub
Um ID exclusivo que identifica o usuário no seu sistema. email
Endereço de e-mail do usuário. given_name
Opcional:nome do usuário. family_name
Opcional:sobrenome do usuário. name
Opcional:o nome completo do usuário. picture
Opcional:foto do perfil do usuário.
Como validar a implementação
Você pode validar a sua implementação, utilizando o Parque OAuth 2.0 ferramenta.
Na ferramenta, execute as seguintes etapas:
- Clique em Configuração para abrir a janela de configuração do OAuth 2.0.
- No campo de fluxo OAuth, selecione do lado do cliente.
- No campo OAuth Endpoints, selecione Personalizado.
- Especifique seu ponto de extremidade OAuth 2.0 e o ID do cliente que você atribuiu ao Google nos campos correspondentes.
- Na secção Passo 1, não selecione quaisquer âmbitos do Google. Em vez disso, deixe este campo em branco ou digite um escopo válido para o seu servidor (ou uma string arbitrária se você não usar escopos OAuth). Quando estiver pronto, clique em Autorizar APIs.
- Nas secções Passo 2 e Passo 3, ir por meio do fluxo OAuth 2.0 e verificar que cada passo funciona como pretendido.
Você pode validar sua implementação usando a Conta do Google Linking Demonstração ferramenta.
Na ferramenta, execute as seguintes etapas:
- Clique no sinal-in com o botão Google.
- Escolha a conta que deseja vincular.
- Digite o ID do serviço.
- Opcionalmente, insira um ou mais escopos para os quais você solicitará acesso.
- Clique em Iniciar demonstração.
- Quando solicitado, confirme se você pode consentir e negar a solicitação de vinculação.
- Confirme que você foi redirecionado para sua plataforma.