Como usar o OAuth 2.0 para acessar as APIs do Google

As APIs do Google usam o protocolo OAuth 2.0 para autenticação e autorização. O Google oferece suporte a cenários comuns do OAuth 2.0, como os de servidores da Web, no lado do cliente, em dispositivos instalados e em aplicativos com entrada limitada.

Para começar, consiga as credenciais do cliente OAuth 2.0 em Google API Console. Em seguida, o aplicativo cliente solicita um token de acesso do servidor de autorização do Google, extrai um token da resposta e o envia para a API Google que você quer acessar. Para uma demonstração interativa do uso do OAuth 2.0 com o Google (incluindo a opção de usar suas próprias credenciais do cliente), teste o OAuth 2.0 Playground.

Nesta página, você encontrará uma visão geral dos cenários de autorização do OAuth 2.0 compatíveis com o Google, além de links para um conteúdo mais detalhado. Para detalhes sobre como usar o OAuth 2.0 para autenticação, consulte OpenID Connect.

Etapas básicas

Todos os aplicativos seguem um padrão básico ao acessar uma API do Google usando o OAuth 2.0. Em um alto nível, você segue cinco etapas:

1. Consiga as credenciais do OAuth 2.0 com o Google API Console.

Acesse Google API Console para receber credenciais do OAuth 2.0, como ID e chave secreta do cliente, conhecidas pelo Google e pelo seu aplicativo. O conjunto de valores varia de acordo com o tipo de aplicativo que você está criando. Por exemplo, um aplicativo JavaScript não exige um secret, mas um aplicativo de servidor da Web precisa.

2. Receber um token de acesso do servidor de autorização do Google.

Antes de acessar os dados particulares usando uma API do Google, seu aplicativo precisa conseguir um token de acesso que conceda acesso a essa API. Um único token de acesso pode conceder diferentes graus de acesso a várias APIs. Um parâmetro de variável chamado scope controla o conjunto de recursos e operações permitidos por um token de acesso. Durante a solicitação de token de acesso, o aplicativo envia um ou mais valores no parâmetro scope.

Há várias maneiras de fazer essa solicitação e elas variam de acordo com o tipo de aplicativo que você está criando. Por exemplo, um aplicativo JavaScript pode solicitar um token de acesso usando um redirecionamento de navegador para o Google, enquanto um aplicativo instalado em um dispositivo que não tem um navegador usa solicitações de serviços da Web.

Algumas solicitações exigem uma etapa de autenticação em que o usuário faz login com a Conta do Google. Depois de fazer login, o usuário é perguntado se quer conceder uma ou mais permissões solicitadas pelo aplicativo. Esse processo é chamado de consentimento do usuário.

Se o usuário conceder pelo menos uma permissão, o servidor de autorização do Google enviará ao aplicativo um token de acesso (ou um código de autorização que pode ser usado pelo aplicativo para receber um token de acesso) e uma lista de escopos de acesso concedidos por esse token. Se o usuário não conceder a permissão, o servidor retornará um erro.

Geralmente, é uma prática recomendada solicitar escopos de forma incremental, no momento em que o acesso é necessário, e não antecipado. Por exemplo, um app que queira salvar um evento em uma agenda não deve solicitar acesso ao Google Agenda até que o usuário pressione o botão "Adicionar à agenda". Consulte Autorização incremental.

3. Examinar os escopos de acesso concedidos pelo usuário.

Compare os escopos incluídos na resposta do token de acesso com os escopos necessários para acessar os recursos e a funcionalidade do aplicativo que dependem do acesso a uma API do Google relacionada. Desative todos os recursos do app para que não funcionem sem acesso à API relacionada.

O escopo incluído na solicitação pode não corresponder ao escopo na resposta, mesmo que o usuário tenha concedido todos os escopos solicitados. Consulte a documentação de cada API do Google para ver os escopos necessários para o acesso. Uma API pode mapear diversos valores de string de escopo para um único escopo de acesso, retornando a mesma string de escopo para todos os valores permitidos na solicitação. Exemplo: a API Google People pode retornar um escopo de https://www.googleapis.com/auth/contacts quando um app solicitar que um usuário autorize um escopo de https://www.google.com/m8/feeds/. O método da API Google People people.updateContact exige um escopo concedido de https://www.googleapis.com/auth/contacts.

4. Envie o token de acesso a uma API.

Depois que recebe um token de acesso, o aplicativo o envia para uma API do Google em um cabeçalho de solicitação de autorização HTTP. É possível enviar tokens como parâmetros de string de consulta de URI, mas isso não é recomendado porque os parâmetros de URI podem acabar em arquivos de registro que não são completamente seguros. Além disso, é uma prática recomendada REST para evitar criar nomes desnecessários de parâmetros de URI.

Os tokens de acesso são válidos apenas para o conjunto de operações e recursos descritos no scope da solicitação do token. Por exemplo, um token de acesso emitido para a API Google Calendar não concede acesso à API Google Contacts. No entanto, é possível enviar esse token de acesso à API Google Calendar várias vezes para operações semelhantes.

5. Atualize o token de acesso, se necessário.

Os tokens de acesso têm duração limitada. Se o aplicativo precisar de acesso a uma API do Google além do ciclo de vida de um único token de acesso, ele poderá receber um token de atualização. Um token de atualização permite que o aplicativo receba novos tokens de acesso.

Cenários

Aplicativos do servidor da Web

O endpoint do Google OAuth 2.0 oferece suporte a aplicativos de servidor da Web que usam linguagens e frameworks como PHP, Java, Python, Ruby e ASP.NET.

A sequência de autorização começa quando seu aplicativo redireciona um navegador para um URL do Google. O URL inclui parâmetros de consulta que indicam o tipo de acesso que está sendo solicitado. O Google cuida da autenticação, seleção de sessão e consentimento do usuário. O resultado é um código de autorização, que o aplicativo pode trocar por um token de acesso e um token de atualização.

O app precisa armazenar o token de atualização para uso futuro e usar o token de acesso para acessar uma API do Google. Quando o token de acesso expirar, o aplicativo usará o token de atualização para receber um novo.

Seu aplicativo envia uma solicitação de token ao servidor de autorização do Google, recebe um código de autorização, troca o código por um token e o usa para chamar um endpoint da API do Google.

Para detalhes, consulte Usar o OAuth 2.0 para aplicativos de servidor da Web.

Apps instalados

O endpoint do Google OAuth 2.0 é compatível com aplicativos instalados em dispositivos como computadores, smartphones e tablets. Ao criar um ID do cliente pelo Google API Console, especifique que esse é um aplicativo instalado e selecione Android, Chrome, iOS, Plataforma Universal do Windows (UWP) ou app para computador como o tipo de aplicativo.

O processo resulta em um ID do cliente e, em alguns casos, uma chave secreta do cliente, que você incorpora no código-fonte do aplicativo. Nesse contexto, é claro que a chave secreta do cliente não é tratada como chave secreta.

A sequência de autorização começa quando seu aplicativo redireciona um navegador para um URL do Google. O URL inclui parâmetros de consulta que indicam o tipo de acesso que está sendo solicitado. O Google cuida da autenticação, seleção de sessão e consentimento do usuário. O resultado é um código de autorização, que o aplicativo pode trocar por um token de acesso e um token de atualização.

O app precisa armazenar o token de atualização para uso futuro e usar o token de acesso para acessar uma API do Google. Quando o token de acesso expirar, o aplicativo usará o token de atualização para receber um novo.

Seu aplicativo envia uma solicitação de token ao servidor de autorização do Google, recebe um código de autorização, troca o código por um token e o usa para chamar um endpoint da API do Google.

Para detalhes, consulte Usar o OAuth 2.0 em aplicativos instalados.

Aplicativos do lado do cliente (JavaScript)

O endpoint do Google OAuth 2.0 é compatível com aplicativos JavaScript executados em um navegador.

A sequência de autorização começa quando seu aplicativo redireciona um navegador para um URL do Google. O URL inclui parâmetros de consulta que indicam o tipo de acesso que está sendo solicitado. O Google cuida da autenticação, seleção de sessão e consentimento do usuário.

O resultado é um token de acesso, que o cliente deve validar antes de incluí-lo em uma solicitação da API do Google. Quando o token expira, o aplicativo repete o processo.

Seu aplicativo JS envia uma solicitação de token para o servidor de autorização do Google,
                  recebe um token, valida o token e o usa para chamar um endpoint da API
                  do Google.

Para mais detalhes, consulte Usar o OAuth 2.0 para aplicativos do lado do cliente.

Aplicativos em dispositivos de entrada limitada

O endpoint do OAuth 2.0 do Google oferece suporte a aplicativos executados em dispositivos de entrada limitada, como consoles de jogos, câmeras de vídeo e impressoras.

A sequência de autorização começa com o aplicativo fazendo uma solicitação de serviço da Web para um URL do Google para um código de autorização. A resposta contém vários parâmetros, incluindo um URL e um código que o aplicativo mostra ao usuário.

O usuário recebe o URL e o código do dispositivo e muda para um dispositivo ou computador separado com recursos de entrada mais avançados. O usuário inicia um navegador, navega para o URL especificado, faz login e insere o código.

Enquanto isso, o aplicativo pesquisa um URL do Google em um intervalo especificado. Depois que o usuário aprova o acesso, a resposta do servidor do Google contém um token de acesso e um token de atualização. O app precisa armazenar o token de atualização para uso futuro e usar o token de acesso para acessar uma API do Google. Quando o token de acesso expirar, o aplicativo usará o token de atualização para receber um novo.

O usuário faz login em um dispositivo diferente que tem um navegador

Para mais detalhes, consulte Usar o OAuth 2.0 para dispositivos.

Contas de serviço

As APIs do Google, como a API Prediction e o Google Cloud Storage, podem agir em nome do seu aplicativo sem acessar as informações do usuário. Nessas situações, seu aplicativo precisa provar a própria identidade para a API, mas o consentimento do usuário não é necessário. Da mesma forma, em cenários corporativos, seu aplicativo pode solicitar acesso delegado a alguns recursos.

Para esses tipos de interações de servidor para servidor, você precisa de uma conta de serviço, que pertence ao seu aplicativo e não a um usuário final individual. O aplicativo chama APIs do Google em nome da conta de serviço e o consentimento do usuário não é necessário. Em situações que não sejam de conta de serviço, seu aplicativo chama as APIs do Google em nome dos usuários finais. Pode ser necessário ter o consentimento do usuário.

As credenciais de uma conta de serviço recebidas de Google API Consoleincluem um endereço de e-mail gerado exclusivo, um ID do cliente e pelo menos um par de chaves públicas/privadas. Use o ID do cliente e uma chave privada para criar um JWT assinado e criar uma solicitação de token de acesso no formato apropriado. Seu aplicativo envia a solicitação do token para o servidor de autorização do Google OAuth 2.0, que retorna um token de acesso. O aplicativo usa o token para acessar uma API do Google. Quando o token expira, o aplicativo repete o processo.

O aplicativo do servidor usa um JWT para solicitar um token do servidor de autorização do Google e, em seguida, usa o token para chamar um endpoint da API do Google. Nenhum usuário final está envolvido.

Para mais detalhes, consulte a documentação da conta de serviço.

Tamanho do token

O tamanho dos tokens pode variar até os seguintes limites:

  • Códigos de autorização: 256 bytes
  • Tokens de acesso: 2.048 bytes
  • Tokens de atualização: 512 bytes

Os tokens de acesso retornados pela API Service Token Service do Google Cloud são estruturados de forma semelhante aos tokens de acesso do OAuth 2.0 da API do Google Cloud, mas têm diferentes limites de tamanho. Para mais detalhes, consulte a documentação da API.

O Google se reserva o direito de alterar o tamanho do token dentro desses limites, e seu aplicativo precisa ser compatível com os tamanhos de tokens variáveis.

Atualizar a validade do token

Escreva seu código para antecipar a possibilidade de que um token de atualização concedido não funcione mais. Um token de atualização pode parar de funcionar por um destes motivos:

  • O usuário revogou o acesso do app.
  • O token de atualização não é usado há seis meses.
  • O usuário mudou as senhas e o token de atualização contém os escopos do Gmail.
  • A conta de usuário excedeu o número máximo de tokens de atualização concedidos (ativos).
  • O usuário pertence a uma organização do Google Cloud Platform com políticas de controle de sessão em vigor.

Um projeto do Google Cloud Platform com uma tela de permissão OAuth configurada para um tipo de usuário externo e um status de publicação "Teste" recebe um token de atualização expirando em sete dias, a menos que os únicos escopos OAuth solicitados sejam um subconjunto de nome, endereço de e-mail e perfil de usuário (pelos escopos userinfo.email, userinfo.profile, openid ou os equivalentes do OpenID Connect).

No momento, há um limite de 100 tokens de atualização por Conta do Google por ID do cliente OAuth 2.0. Se o limite for atingido, a criação de um novo token de atualização invalidará automaticamente o token de atualização mais antigo sem aviso prévio. Esse limite não se aplica a contas de serviço.

Há também um limite maior para o número total de tokens de atualização que uma conta de usuário ou de conta de serviço pode ter em todos os clientes. A maioria dos usuários normais não excederá esse limite, mas a conta de um desenvolvedor usada para testar uma implementação poderá.

Se precisar autorizar vários programas, máquinas ou dispositivos, uma solução alternativa é limitar o número de clientes autorizados por Conta do Google a 15 ou 20. Se você for um administrador do Google Workspace, poderá criar outros usuários com privilégios de administrador e usá-los para autorizar alguns dos clientes.

Lidar com políticas de controle de sessão para organizações do Google Cloud Platform (GCP)

Os administradores das organizações do GCP podem exigir a reautenticação frequente de usuários enquanto acessam recursos do GCP, usando o recurso de controle de sessão do Google Cloud. Essa política afeta o acesso ao Console do Google Cloud, ao SDK do Google Cloud (também conhecido como CLI gcloud) e a qualquer aplicativo OAuth de terceiros que exija o escopo do Cloud Platform. Se um usuário tiver uma política de controle de sessão em vigor no final da duração da sessão, suas chamadas de API terão um erro semelhante ao que ocorreria se o token de atualização fosse revogado. A chamada falhará com um tipo de erro invalid_token. O tipo de suberro pode ser usado para distinguir entre um token de revogação e uma falha devido a uma política de controle de sessão. Como as durações da sessão podem ser muito limitadas (entre 1 hora e 24 horas), será necessário lidar com esse cenário reiniciando uma sessão de autenticação.

Da mesma forma, não é permitido usar nem incentivar o uso de credenciais de usuário para a implantação de servidor para servidor. Se as credenciais do usuário forem implantadas em um servidor para operações ou jobs de longa duração e um cliente aplicar políticas de controle de sessão a esses usuários, o aplicativo do servidor falhará porque não será possível autenticar o usuário novamente quando a duração da sessão expirar.

Para mais informações sobre como ajudar seus clientes a implantar esse recurso, consulte este artigo de ajuda com foco no administrador.

Bibliotecas de cliente

As seguintes bibliotecas de cliente se integram a frameworks conhecidos, o que simplifica a implementação do OAuth 2.0. Mais recursos serão adicionados às bibliotecas ao longo do tempo.