Esta página foi traduzida pela API Cloud Translation.

Vinculação de Conta do Google com OAuth

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:
1. 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.
2. 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. — **Figura 1.** Login do usuário: login na conta do Google e telas de consentimento.

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.

创建项目

如需创建项目以使用帐号关联，请按以下步骤操作：

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 .

配置 OAuth 权限请求页面

Google 帐号关联流程包括一个同意屏幕，用于告知用户请求访问其数据的应用、用户要求的数据类型以及适用的条款。您需要先配置 OAuth 权限请求页面，然后才能生成 Google API 客户端 ID。

打开 Google API 控制台的 OAuth 同意屏幕页面。
如果出现提示，请选择您刚刚创建的项目。
在“OAuth 同意屏幕”页面上，填写表单，然后点击“保存”按钮。

应用名称：请求用户同意的应用的名称。该名称应准确反映您的应用，并与用户在别处看到的应用名称保持一致。应用名称将显示在帐号关联同意屏幕上。

应用徽标：同意屏幕上的图片，有助于用户识别您的应用。徽标会显示在帐号关联同意屏幕和帐号设置中

支持电子邮件地址：供用户就其同意情况与您联系。

Google API 的范围：范围允许您的应用访问用户的私有 Google 数据。对于 Google 帐号关联用例，默认范围（电子邮件、个人资料、OpenID）就足够了，您无需添加任何敏感范围。最佳做法一般是在需要访问时逐步请求作用域，而不是预先请求。了解详情。

已获授权的网域：为保护您和您的用户，Google 仅允许使用 OAuth 进行身份验证的应用使用已获授权的网域。您应用的链接必须托管在已获授权的网域上。了解详情。

应用首页链接：您的应用的首页。必须托管在已获授权的网域上。

应用隐私权政策链接：在 Google 帐号关联同意屏幕上显示。必须托管在已获授权的网域上。

应用服务条款链接（可选）：必须托管在已获授权的网域上。

图 1. 一款虚构应用 Tunery 的 Google 帐号关联同意屏幕
查看“验证状态”。如果您的申请需要验证，请点击“提交验证”按钮，提交您的申请。如需了解详情，请参阅 OAuth 验证要求。

Implementar o servidor OAuth

Um OAuth implementação de servidor 2.0 do fluxo de código de autorização consiste em dois pontos finais, que o seu serviço disponibiliza por HTTPS. O primeiro endpoint é o endpoint de autorização, que é responsável por localizar ou obter o consentimento dos usuários para acesso aos dados. O endpoint de autorização apresenta uma IU de login para seus usuários que ainda não estão conectados e registra o consentimento para o acesso solicitado. O segundo ponto de extremidade é o ponto de extremidade de troca de tokens, que é usado para obter cadeias de caracteres criptografadas, chamadas de tokens, que autorizam um usuário a acessar seu serviço.

Quando um aplicativo do Google precisa chamar uma das APIs do seu serviço, o Google usa esses pontos de extremidade juntos para obter permissão dos usuários para chamar essas APIs em seu nome.

Uma sessão de fluxo de código de autorização OAuth 2.0 iniciada pelo Google tem o seguinte fluxo:

O Google abre seu endpoint de autorização no navegador do usuário. Se o fluxo começou em um dispositivo apenas de voz para uma ação, o Google transfere a execução para um telefone.
O usuário faz login, se ainda não tiver feito, e concede ao Google permissão para acessar seus dados com sua API, caso ainda não tenha concedido permissão.
Seu serviço cria um código de autorização e devolve-lo ao Google. Para fazer isso, redirecione o navegador do usuário de volta ao Google com o código de autorização anexado à solicitação.
Google envia o código de autorização para o seu endpoint troca simbólica, que verifica a autenticidade do código e retorna um token e uma atualização de token de acesso. 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 longa duração que o Google pode armazenar e usar para adquirir novos tokens de acesso quando expirarem.
Depois que o usuário conclui o fluxo de vinculação da conta, cada solicitação subsequente enviada do Google contém um token de acesso.

Lidar com solicitações de autorização

Quando você precisa vincular contas usando o fluxo do código de autorização OAuth 2.0, o Google envia o usuário ao 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 ID do cliente que você atribuiu ao Google.
`redirect_uri`	O URL para o qual você envia a resposta a esta solicitação.
`state`	Um valor contábil que é passado de volta ao Google inalterado no URI de redirecionamento.
`scope`	Opcional: Um conjunto delimitada por espaços de cordas de escopo que especificam os dados do Google está solicitando autorização para.
`response_type`	O tipo de valor a ser retornado na resposta. Para o código de autorização OAuth fluxo 2.0, o tipo de resposta é sempre `code` .
`user_locale`	A configuração de idioma Conta do Google em RFC5646 formato, usado para localizar o seu conteúdo no idioma de preferência do usuário.

Por exemplo, se o seu endpoint de autorização está disponível no https://myservice.example.com/auth , um pedido pode parecer o seguinte:

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 seu endpoint de autorização processe solicitações de login, execute as seguintes etapas:

Verifique se o client_id corresponde ao ID do cliente que você atribuiu ao Google, e que o redirect_uri corresponde ao URL de redirecionamento fornecido pelo Google para o seu serviço. Essas verificações são importantes para evitar a concessão de acesso a aplicativos cliente não intencionais ou configurados incorretamente. Se você suportar múltiplos OAuth fluxos de 2,0, também confirmam que o response_type é code .
Verifique se o usuário está conectado ao seu serviço. Se o usuário não estiver conectado, conclua o fluxo de login ou inscrição do seu serviço.
Gere um código de autorização para o Google usar para acessar sua API. O código de autorização pode ser qualquer valor de string, mas deve representar exclusivamente o usuário, o cliente ao qual o token se destina e o tempo de expiração do código, e não pode ser adivinhado. Normalmente, você emite códigos de autorização que expiram após aproximadamente 10 minutos.

Confirme se o URL especificado pelo redirect_uri parâmetro tem a seguinte forma:

  https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
  https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID

Redirecionar o navegador do usuário para o URL especificado pelo redirect_uri parâmetro. Incluir o código de autorização que você acabou de gerar e original, valor estado não modificado quando você redirecionar anexando os code e state parâmetros. O que se segue é um exemplo do URL resultante:
```
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING
```

Lidar com solicitações de troca de tokens

O ponto de extremidade de troca de tokens do seu serviço é responsável por dois tipos de trocas de tokens:

Trocar códigos de autorização para tokens de acesso e tokens de atualização
Tokens de atualização do Exchange para 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 Google. Esta string deve ser registrada 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. É tanto `authorization_code` ou `refresh_token` .
`code`	Quando `grant_type=authorization_code` , este parâmetro é o código do Google recebeu a partir do seu início de sessão ou token de endpoint de câmbio.
`redirect_uri`	Quando `grant_type=authorization_code` , este parâmetro é o URL usado no pedido de autorização inicial.
`refresh_token`	Quando `grant_type=refresh_token` , este parâmetro é o token de atualização Google recebeu do seu endpoint troca simbólica.

Trocar códigos de autorização para tokens de acesso e tokens de atualização

Depois que o usuário faz login e seu endpoint de autorização retorna um código de autorização de curta duração ao Google, o Google envia uma solicitação ao endpoint de troca de token para trocar o código de autorização por um token de acesso e um token de atualização.

Para estes pedidos, o valor de grant_type é authorization_code , eo valor de code é o valor do código de autorização anteriormente concedida ao Google. A seguir está um exemplo de uma solicitação para trocar um código de autorização por 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 os códigos de autorização para um token de acesso e um token de atualização, seu token responde endpoint Exchange para POST solicitações executando os seguintes passos:

Verifique se os client_id identifica a origem do pedido como uma origem autorizada, e que o client_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 ao código de autorização.
Confirme se o URL especificado pelo redirect_uri parâmetro é idêntico ao valor utilizado no pedido de autorização inicial.
Se você não pode verificar todos os critérios acima, retornar um pedido inválido de erro HTTP 400 com {"error": "invalid_grant"} como o corpo.
Caso contrário, use o ID do usuário do código de autorização para gerar um token de atualização e um token de acesso. Esses tokens podem ser qualquer valor de string, mas devem representar exclusivamente o usuário e o cliente ao qual o token se destina e não devem ser adivinhados. Para tokens de acesso, registre também o tempo de expiração do token, que normalmente é uma hora após a emissão do token. Os tokens de atualização não expiram.

Retornaria 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 o token de acesso e o token de atualização para o usuário e registra a expiração do token de acesso. Quando o token de acesso expira, o Google usa o token de atualização para obter um novo token de acesso de seu ponto de extremidade de troca de tokens.

Tokens de atualização do Exchange para tokens de acesso

Quando um token de acesso expira, o Google envia uma solicitação ao seu endpoint de troca de token para trocar um token de atualização por um novo token de acesso.

Para estes pedidos, o valor de grant_type é refresh_token , eo valor de refresh_token é o valor do token de atualização anteriormente concedida ao Google. A seguir está um exemplo de uma solicitação para trocar um token de atualização por 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 uma atualização de token para um token de acesso, o token responde endpoint Exchange para POST solicitações executando os seguintes passos:

Verifique se os client_id identifica a origem do pedido, como Google, e que o client_secret corresponde ao valor esperado.
Verifique se o token de atualização é válido e se o ID do cliente especificado na solicitação corresponde ao ID do cliente associado ao token de atualização.
Se você não pode verificar todos os critérios acima, retornar um pedido inválido de erro HTTP 400 com {"error": "invalid_grant"} como o corpo.
Caso contrário, use o ID do usuário do token de atualização para gerar um token de acesso. Esses tokens podem ser qualquer valor de string, mas devem representar exclusivamente o usuário e o cliente ao qual o token se destina e não devem ser adivinhados. Para tokens de acesso, registre também o tempo de expiração do token, normalmente uma hora depois de emitir o token.

Retorne o seguinte objeto JSON no corpo da resposta HTTPS:

{
"token_type": "Bearer",
"access_token": " ACCESS_TOKEN ",
"expires_in": SECONDS_TO_EXPIRATION
}

处理用户信息请求

该用户信息终端是一个OAuth 2.0保护的资源，对链接的用户返回的权利要求。实现和托管 userinfo 端点是可选的，以下用例除外：

链接帐户登录与谷歌一个水龙头。
无摩擦订阅的AndroidTV。

从您的令牌端点成功检索访问令牌后，Google 会向您的 userinfo 端点发送请求，以检索有关链接用户的基本个人资料信息。

userinfo 端点请求标头
`Authorization header`	Bearer 类型的访问令牌。

例如，如果你的用户信息终端可在https://myservice.example.com/userinfo ，请求看起来像下面这样：

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

要让您的 userinfo 端点处理请求，请执行以下步骤：

从 Authorization 标头中提取访问令牌并返回与访问令牌关联的用户的信息。
如果访问令牌无效，返回HTTP 401错误未经授权使用的WWW-Authenticate响应头。下面是一个userinfo的错误响应的一个示例：
```
HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="The Access Token expired"
```
如果一个401未经授权，或任何其它不成功错误响应在关联过程返回时，误差将是不可恢复的，所检索的令牌将被丢弃，并且用户将必须再次启动链接过程。

如果访问令牌是有效的，回国与以下JSON对象在HTTPS响应的身体HTTP 200回应：

{
"sub": "USER_UUID",
"email": "EMAIL_ADDRESS",
"given_name": "FIRST_NAME",
"family_name": "LAST_NAME",
"name": "FULL_NAME",
"picture": "PROFILE_PICTURE",
}

如果你的用户信息端点返回一个HTTP 200成功响应，检索到的令牌和索赔登记针对用户的谷歌帐户。

用户信息端点响应
`sub`	标识系统中用户的唯一 ID。
`email`	用户的电子邮件地址。
`given_name`	可选：用户的名字。
`family_name`	可选：用户的姓氏。
`name`	可选：用户的全名。
`picture`	可选：用户的档案图片。

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.