As APIs do Google usam o protocolo OAuth 2.0 para autenticação e autorização. O Google permite o uso do OAuth 2.0 para diversas finalidades, como em apps de servidores da Web, do lado do cliente, instalados e de dispositivos de entrada limitada.
Para começar, obtenha credenciais do cliente OAuth 2.0 no 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 envia o token para a API do 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 de cliente), teste o OAuth 2.0 Playground.
Esta página oferece uma visão geral dos cenários de autorização do OAuth 2.0 compatíveis com o Google e links para 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 geral, você segue cinco etapas:
1. Receba as credenciais do OAuth 2.0 do Google API Console.
Acesse Google API Console para receber credenciais do OAuth 2.0, como um ID e uma chave secreta do cliente conhecidos 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 sim.
Crie um cliente OAuth adequado para a plataforma em que o app será executado, por exemplo:
- code Para apps da Web JavaScript ou do lado do servidor, use o tipo de cliente "web". Não use esse tipo de cliente para nenhum outro aplicativo, como apps nativos ou para dispositivos móveis.
- Para apps Android, use o tipo de cliente "Android".
-
Para apps iOS e macOS, use
o tipo de cliente "iOS".
- Para apps da Plataforma Universal do Windows, use o tipo de cliente "Plataforma Universal do Windows".
- tv Para dispositivos de entrada limitada, como TVs ou dispositivos incorporados, use o tipo de cliente "TVs e dispositivos de entrada limitada".
- host Para interações de servidor para servidor, use contas de serviço.
2. Obtenha um token de acesso do servidor de autorização do Google.
Antes de acessar dados particulares usando uma API do Google, seu aplicativo precisa receber 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 variável chamado scope controla o conjunto de recursos e operações permitidas por um token de acesso. Durante a solicitação de token de acesso,
seu 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 do navegador para o Google, enquanto um aplicativo instalado em um dispositivo sem navegador usa solicitações de serviço 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 que o aplicativo está solicitando. 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 o aplicativo pode usar 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 vai retornar um erro.
Geralmente, é uma prática recomendada solicitar escopos de forma incremental, no momento em que o acesso é necessário, em vez de fazer isso antecipadamente. Por exemplo, um app que quer oferecer suporte ao salvamento de 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. Examine os escopos de acesso concedidos pelo usuário.
Compare os escopos incluídos na resposta do token de acesso com os necessários para acessar recursos e funcionalidades do seu aplicativo dependentes do acesso a uma API do Google relacionada. Desative todos os recursos do app que não funcionam sem acesso à API relacionada.
O escopo incluído na solicitação pode não corresponder ao escopo incluído na resposta, mesmo que o usuário tenha concedido todos os escopos solicitados. Consulte a documentação de cada API do Google para saber os escopos necessários para o acesso. Uma API pode mapear vários 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 solicita que um usuário autorize
um escopo de https://www.google.com/m8/feeds/. O método da API Google People
people.updateContact
requer um escopo concedido de https://www.googleapis.com/auth/contacts.
4. Envie o token de acesso para uma API.
Depois que um aplicativo recebe um token de acesso, ele envia o token 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 não recomendamos isso porque os parâmetros de URI podem acabar em arquivos de registro que não são totalmente seguros. Além disso, é uma boa prática de REST evitar a criação de nomes de parâmetros de URI desnecessários.
Os tokens de acesso são válidos apenas para o conjunto de operações e recursos descritos no
scope da solicitação de token. Por exemplo, se um token de acesso for emitido para a
API Google Agenda, ele não vai conceder acesso à API Google Contatos. No entanto, é possível enviar esse token de acesso para a API Google Agenda várias vezes em 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 seu aplicativo receba novos tokens de acesso.
Cenários
Aplicativos do servidor da Web
O endpoint do Google OAuth 2.0 aceita aplicativos de servidor da Web que usam linguagens e frameworks como PHP, Java, Go, Python, Ruby e ASP.NET.
A sequência de autorização começa quando o aplicativo redireciona um navegador para um URL do Google. O URL inclui parâmetros de consulta que indicam o tipo de acesso solicitado. O Google gerencia a autenticação do usuário, a seleção de sessão e o 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 aplicativo 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 expira, o aplicativo usa o token de atualização para conseguir um novo.
Para mais detalhes, consulte Usar o OAuth 2.0 para aplicativos de servidor da Web.
Aplicativos 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 usando a Google API Console, especifique que este é um aplicativo instalado e selecione Android, app 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 ao código-fonte do seu aplicativo. Nesse contexto, a chave secreta do cliente obviamente não é tratada como um segredo.
A sequência de autorização começa quando o aplicativo redireciona um navegador para um URL do Google. O URL inclui parâmetros de consulta que indicam o tipo de acesso solicitado. O Google gerencia a autenticação do usuário, a seleção de sessão e o 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 aplicativo 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 expira, o aplicativo usa o token de atualização para conseguir um novo.
Para mais detalhes, consulte Como usar o OAuth 2.0 para 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 o aplicativo redireciona um navegador para um URL do Google. O URL inclui parâmetros de consulta que indicam o tipo de acesso solicitado. O Google gerencia a autenticação do usuário, a seleção de sessão e o consentimento do usuário.
O resultado é um token de acesso, que o cliente precisa validar antes de incluir em uma solicitação da API do Google. Quando o token expira, o aplicativo repete o processo.
Para mais detalhes, consulte Usar o OAuth 2.0 para aplicativos do lado do cliente.
Aplicativos em dispositivos de entrada limitada
O endpoint do Google OAuth 2.0 é compatível com 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 quando o aplicativo faz 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 outro dispositivo ou computador com recursos de entrada mais avançados. O usuário abre um navegador, navega até 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 aplicativo 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 expira, o aplicativo usa o token de atualização para conseguir um novo.
Para mais detalhes, consulte Como 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 informações do usuário. Nessas situações, seu aplicativo precisa provar a própria identidade para a API, mas não é necessário o consentimento do usuário. Da mesma forma, em cenários empresariais, seu aplicativo pode solicitar acesso delegado a alguns recursos.
Para esses tipos de interações entre servidores, você precisa de uma conta de serviço, que pertence ao aplicativo e não a um usuário final. Seu aplicativo chama as APIs do Google em nome da conta de serviço, e o consentimento do usuário não é necessário. Em cenários sem conta de serviço, seu aplicativo chama as APIs do Google em nome dos usuários finais, e às vezes é necessário o consentimento do usuário.
As credenciais de uma conta de serviço, que você recebe do Google API Console, incluem um endereço de e-mail gerado que é exclusivo, um ID do cliente e pelo menos um par de chaves públicas/privadas. Você usa o ID do cliente e uma chave privada para criar um JWT assinado e construir uma solicitação de token de acesso no formato adequado. Em seguida, o aplicativo envia a solicitação de 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.
Para mais detalhes, consulte a documentação de contas de serviço.
Tamanho do token
Os tokens podem variar de tamanho, até os seguintes limites:
Os tokens de acesso retornados pela API Security Token Service do Google Cloud têm uma estrutura semelhante aos tokens de acesso OAuth 2.0 da API do Google, mas limites de tamanho diferentes. Para mais detalhes, consulte a documentação da API.
O Google se reserva o direito de mudar o tamanho do token dentro desses limites, e seu aplicativo precisa oferecer suporte a tamanhos de token variáveis.
Atualizar a validade do token
Você precisa escrever seu código para prever a possibilidade de um token de atualização concedido não funcionar mais. Um token de atualização pode parar de funcionar por um destes motivos:
Um projeto do Google Cloud Platform com uma tela de consentimento do OAuth configurada para um tipo de usuário externo e um status de publicação "Em teste" recebe um token de atualização que expira em sete dias, a menos que os únicos escopos do OAuth solicitados sejam um subconjunto de nome, endereço de e-mail e perfil do usuário (pelos escopos
userinfo.email, userinfo.profile, openid ou seus equivalentes do OpenID Connect).
Atualmente, há um limite de 100 tokens de atualização por Conta do Google e ID do cliente OAuth 2.0. Se o limite for atingido, a criação de um novo token de atualização invalidará automaticamente o mais antigo sem aviso prévio. Esse limite não se aplica a contas de serviço.
Há também um limite maior no número total de tokens de atualização que uma conta de usuário ou de serviço pode ter em todos os clientes. A maioria dos usuários normais não excede esse limite, mas uma conta de desenvolvedor usada para testar uma implementação pode exceder.
Se você 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, crie outros usuários com privilégios administrativos e use-os para autorizar alguns dos clientes.
Como lidar com políticas de controle de sessão para organizações do Google Cloud Platform (GCP)
Os administradores de organizações do GCP podem exigir a reautenticação frequente dos 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, quando a duração da sessão expirar, as chamadas de API vão gerar um erro semelhante ao que aconteceria se o token de atualização fosse revogado. A chamada vai falhar com um tipo de erro invalid_grant. O campo error_subtype pode ser usado para distinguir entre um token revogado e uma falha devido a uma política de controle de sessão (por exemplo, "error_subtype": "invalid_rapt"). Como as durações de sessão podem ser muito limitadas (entre 1 e 24 horas), esse cenário precisa ser processado de maneira adequada reiniciando uma sessão de autenticação.
Da mesma forma, não use nem incentive o uso de credenciais de usuário para implantação de servidor para servidor. Se as credenciais do usuário forem implantadas em um servidor para tarefas ou operações de longa duração e um cliente aplicar políticas de controle de sessão a esses usuários, o aplicativo do servidor vai falhar, já que não haverá como reautenticar o usuário 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 para administradores.
Bibliotecas de cliente
As bibliotecas de cliente a seguir se integram a frameworks conhecidos, o que simplifica a implementação do OAuth 2.0. Mais recursos serão adicionados às bibliotecas com o tempo.
- Biblioteca de cliente das APIs do Google para Java
- Biblioteca de cliente da API do Google para Python
- Biblioteca de cliente da API do Google para Go
- Biblioteca de cliente da API do Google para .NET
- Biblioteca de cliente da API do Google para Ruby
- Biblioteca de cliente de APIs do Google para PHP
- Biblioteca de cliente da API do Google para JavaScript
- GTMAppAuth: biblioteca de cliente OAuth para Mac e iOS