As credenciais são usadas para receber um token de acesso dos servidores de autorização do Google. Assim, seu app pode chamar as APIs do Google Workspace. Este guia descreve como escolher e configurar as credenciais necessárias para o app.
Para definições de termos encontrados nesta página, consulte a Visão geral de autenticação e autorização.
Escolha a credencial de acesso certa para você
As credenciais necessárias dependem do tipo de dados, da plataforma e da metodologia de acesso do app. Há três tipos de credenciais disponíveis:
| Caso de uso | Método de autenticação | Sobre este método de autenticação |
|---|---|---|
| Acessar dados disponíveis publicamente de forma anônima no app. | Chaves de API | Verifique se a API que você quer usar é compatível com chaves de API antes de usar esse método de autenticação. |
| Acessar dados do usuário, como endereço de e-mail ou idade. | ID do cliente OAuth | Requer que seu app solicite e receba o consentimento do usuário. |
| Acesse dados que pertencem ao seu aplicativo ou recursos em nome dos usuários do Google Workspace ou do Cloud Identity por meio da delegação em todo o domínio. | Conta de serviço | Quando um app é autenticado como uma conta de serviço, ele tem acesso a todos os recursos que a conta de serviço tem permissão para acessar. |
Credenciais da chave de API
Uma chave de API é uma string longa que contém letras maiúsculas e minúsculas, números, sublinhados e hifens, como AIzaSyDaGmWKa4JsXZ-HjGw7ISLn_3namBGewQe.
Esse método de autenticação é usado para acessar dados disponíveis
publicamente de forma anônima, como os arquivos do Google Workspace compartilhados usando a configuração de compartilhamento "Qualquer pessoa na Internet
com este link". Para mais detalhes, consulte Como usar chaves de API.
Para criar uma chave de API, siga estas etapas:
- No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > Chave de API.
- Sua nova chave de API será exibida.
- Clique em Copiar para copiar sua chave de API e usá-la no código do app. A chave de API também pode ser encontrada na seção "Chaves de API" das credenciais do seu projeto.
- Clique em Restringir chave para atualizar as configurações avançadas e limitar o uso da sua chave de API. Para mais detalhes, consulte Como aplicar restrições à chave de API.
Credenciais do ID do cliente OAuth
Para autenticar os usuários finais e acessar os dados do usuário no seu app, você precisa criar um ou mais IDs do cliente OAuth 2.0. Um ID do cliente é usado para identificar um único app nos servidores OAuth do Google. Caso seu app seja executado em várias plataformas, você precisará criar um ID do cliente separado para cada uma delas.Escolha o tipo de aplicativo para ver instruções específicas sobre como criar um ID do cliente OAuth:
Aplicativo da Web
- No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > Aplicativo da Web.
- No campo Nome, digite um nome para a credencial. Ele só aparece no console do Google Cloud.
- Adicione URIs autorizados relacionados ao seu app:
- Apps do lado do cliente (JavaScript): em Origens JavaScript autorizadas, clique em Adicionar URI. Em seguida, insira um URI a ser usado para solicitações do navegador. Isso identifica os domínios a partir dos quais seu aplicativo pode enviar solicitações de API para o servidor OAuth 2.0.
- Apps do lado do servidor (Java, Python e outros): em URIs de redirecionamento autorizados, clique em Adicionar URI. Em seguida, insira um URI de endpoint para o qual o servidor OAuth 2.0 possa enviar respostas.
- Clique em Criar. A tela cliente OAuth criado é exibida, mostrando seu novo ID e chave secreta do cliente.
Anote o ID do cliente. As chaves secretas do cliente não são usadas para aplicativos da Web.
- Clique em OK. A credencial recém-criada aparece em IDs do cliente OAuth 2.0.
Android
- No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > Android.
- No campo "Nome", digite um nome para a credencial. Ele só aparece no console do Google Cloud.
- No campo "Package name", insira o nome do pacote do arquivo
AndroidManifest.xml. - No campo "Impressão digital do certificado SHA-1", digite a impressão digital do certificado SHA-1 gerada.
- Clique em Criar. A tela "Cliente OAuth criado" vai aparecer, mostrando seu novo ID do cliente.
- Clique em OK. A credencial recém-criada será exibida em "IDs do cliente OAuth 2.0".
iOS
- No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > iOS.
- No campo "Nome", digite um nome para a credencial. Ele só aparece no console do Google Cloud.
- No campo "ID do pacote", insira o identificador do pacote conforme listado no arquivo
Info.plistdo app. - Opcional: se o seu aplicativo aparecer na Apple App Store, digite o ID da App Store.
- Opcional: no campo "ID da equipe", insira a string exclusiva de 10 caracteres gerada pela Apple e atribuída à sua equipe.
- Clique em Criar. A tela cliente OAuth criado é exibida, mostrando seu novo ID e chave secreta do cliente.
- Clique em OK. A credencial recém-criada será exibida em "IDs do cliente OAuth 2.0".
App do Chrome
- No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > Aplicativo do Google Chrome.
- No campo "Nome", digite um nome para a credencial. Ele só aparece no console do Google Cloud.
- No campo "ID do aplicativo", insira a string do ID exclusiva de 32 caracteres do seu app. Você encontra esse valor de ID no URL da Chrome Web Store do seu app e no Painel do desenvolvedor da Chrome Web Store.
- Clique em Criar. A tela cliente OAuth criado é exibida, mostrando seu novo ID e chave secreta do cliente.
- Clique em OK. A credencial recém-criada será exibida em "IDs do cliente OAuth 2.0".
App para computador
- No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > App para computador.
- No campo Nome, digite um nome para a credencial. Ele só aparece no console do Google Cloud.
- Clique em Criar. A tela cliente OAuth criado é exibida, mostrando seu novo ID e chave secreta do cliente.
- Clique em OK. A credencial recém-criada aparece em IDs do cliente OAuth 2.0.
TVs e dispositivos de entrada limitada
- No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > TVs e dispositivos de entrada limitada.
- No campo "Nome", digite um nome para a credencial. Ele só aparece no console do Google Cloud.
- Clique em Criar. A tela cliente OAuth criado é exibida, mostrando seu novo ID e chave secreta do cliente.
- Clique em OK. A credencial recém-criada será exibida em "IDs do cliente OAuth 2.0".
Plataforma Universal do Windows (UWP)
- No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > Universal Windows Platform (UWP).
- No campo "Nome", digite um nome para a credencial. Ele só aparece no console do Google Cloud.
- No campo "ID da loja", insira o valor exclusivo de 12 caracteres do ID da Microsoft Store do seu app. Esse código pode ser encontrado no URL do seu app da Microsoft Store e na Central de parceiros.
- Clique em Criar. A tela cliente OAuth criado é exibida, mostrando seu novo ID e chave secreta do cliente.
- Clique em OK. A credencial recém-criada será exibida em "IDs do cliente OAuth 2.0".
Credenciais da conta de serviço
Uma conta de serviço é um tipo especial de conta usada por um aplicativo, e não por uma pessoa. É possível usar uma conta de serviço para acessar dados, executar ações pela conta robô ou acessar dados em nome dos usuários do Google Workspace ou do Cloud Identity. Para mais informações, consulte as Noções básicas sobre contas de serviço.Crie uma conta de serviço
Console do Google Cloud
- No console do Google Cloud, acesse Menu > IAM e administrador > Contas de serviço.
- Clique em Criar conta de serviço.
- Preencha os detalhes da conta de serviço e clique em Criar e continuar.
- Opcional: atribua papéis à sua conta de serviço para conceder acesso aos recursos do seu projeto do Google Cloud. Confira mais detalhes em Como conceder, alterar e revogar acesso a recursos.
- Clique em Continuar.
- Opcional: insira usuários ou grupos que podem gerenciar e realizar ações com essa conta de serviço. Para mais detalhes, consulte Como gerenciar a representação de uma conta de serviço.
- Clique em Concluído. Anote o endereço de e-mail da conta de serviço.
CLI da gcloud
- Crie a conta de serviço:
gcloud iam service-accounts createSERVICE_ACCOUNT_NAME\ --display-name="SERVICE_ACCOUNT_NAME" - Opcional: atribua papéis à sua conta de serviço para conceder acesso aos recursos do seu projeto do Google Cloud. Confira mais detalhes em Como conceder, alterar e revogar acesso a recursos.
Atribuir um papel a uma conta de serviço
Você precisa atribuir um papel predefinido ou personalizado a uma conta de serviço por uma conta de superadministrador.
No Google Admin Console, acesse Menu > Conta > Funções do administrador.
Aponte para a função que você quer atribuir e clique em Atribuir administrador.
Clique em Atribuir contas de serviço.
Digite o endereço de e-mail da conta de serviço.
Clique em Adicionar > Atribuir função.
Criar credenciais para uma conta de serviço
É preciso receber credenciais na forma de um par de chaves pública/privada. Essas credenciais são usadas pelo código para autorizar ações da conta de serviço no app.Para receber credenciais para sua conta de serviço:
- No console do Google Cloud, acesse Menu > IAM e administrador > Contas de serviço.
- Selecione sua conta de serviço.
- Clique em Chaves > Adicionar chave > Criar nova chave.
- Selecione JSON e clique em Criar.
Seu novo par de chaves pública/privada é gerado e transferido por download para sua máquina como um novo arquivo. Salve o arquivo JSON salvo como
credentials.jsonno diretório de trabalho. Esse arquivo é a única cópia desta chave. Para saber mais sobre como armazenar a chave com segurança, consulte Como gerenciar chaves de contas de serviço. - Clique em Fechar.
Opcional: configurar a delegação em todo o domínio para uma conta de serviço
Para chamar APIs em nome de usuários em uma organização do Google Workspace, sua conta de serviço precisa receber a delegação de autoridade em todo o domínio no Admin Console do Google Workspace por uma conta de superadministrador. Para mais informações, consulte Como delegar autoridade em todo o domínio a uma conta de serviço.Para configurar a delegação de autoridade em todo o domínio para uma conta de serviço:
- No console do Google Cloud, acesse Menu > IAM e administrador > Contas de serviço.
- Selecione sua conta de serviço.
- Clique em Mostrar configurações avançadas.
- Em "Delegação em todo o domínio", encontre o "ID do cliente" da sua conta de serviço. Clique em Copiar para copiar o valor do ID do cliente para a área de transferência.
Se você tiver acesso de superadministrador à conta do Google Workspace relevante, clique em Ver o Admin Console do Google Workspace, faça login usando uma conta de usuário de superadministrador e continue seguindo estas etapas.
Se você não tiver acesso de superadministrador à conta do Google Workspace relevante, entre em contato com um superadministrador dessa conta e envie o ID do cliente da conta de serviço e a lista de escopos do OAuth para que ele possa concluir as etapas a seguir no Admin Console.
- No Google Admin Console, acesse Menu > Segurança > Controle de dados e acesso > Controles de API.
- Clique em Gerenciar a delegação em todo o domínio.
- clique em Add new;
- No campo "ID do cliente", cole o ID que você copiou anteriormente.
- No campo "Escopos do OAuth", insira uma lista separada por vírgulas dos escopos exigidos pelo seu aplicativo. Esse é o mesmo conjunto de escopos que você definiu ao configurar a tela de permissão OAuth.
- Clique em Autorizar.
Próxima etapa
Tudo pronto para você desenvolver no Google Workspace. Consulte a lista de produtos para desenvolvedores do Google Workspace e como encontrar ajuda.