Autenticar-se no BigQuery

Neste documento, descrevemos como autenticar-se no BigQuery de modo programático. A forma como você se autentica no BigQuery depende da interface usada para acessar a API e do ambiente onde seu código está sendo executado.

Para um breve exemplo de autenticação no BigQuery, consulte Introdução à autenticação.

Para mais informações sobre a autenticação do Google Cloud, consulte a visão geral da autenticação.

Acesso à API

O BigQuery dá suporte ao acesso programático. Você pode acessar a API das seguintes maneiras:

Bibliotecas de clientes
CLI do Google Cloud
REST

Bibliotecas de cliente

As bibliotecas de cliente do BigQuery dão suporte de linguagem de alto nível para a autenticação programática no BigQuery. Para autenticar as chamadas feitas às APIs do Google Cloud, as bibliotecas de cliente dão suporte ao Application Default Credentials (ADC). As bibliotecas procuram credenciais em um conjunto de locais definidos e as usam para autenticar as solicitações feitas à API. Com o ADC, é possível disponibilizar credenciais ao aplicativo em uma variedade de ambientes, como de desenvolvimento ou produção local, sem precisar modificar o código do aplicativo.

CLI do Google Cloud

Ao usar a gcloud CLI para acessar o BigQuery, faça login na gcloud CLI com uma Conta do Google, que fornece as credenciais usadas pelos comandos da gcloud CLI.

Se as políticas de segurança da sua organização impedirem que as contas de usuário tenham as permissões necessárias, use a identidade temporária de conta de serviço.

Para mais informações, consulte Autenticar-se para usar a gcloud CLI. Para mais informações sobre como usar a gcloud CLI com o BigQuery, consulte Instalar a gcloud CLI.

REST

É possível autenticar-se na API BigQuery usando as credenciais da gcloud CLI ou o Application Default Credentials. Para mais informações sobre a autenticação para solicitações REST, consulte Autenticar-se usando REST. Para informações sobre os tipos de credenciais, consulte Credenciais da gcloud CLI e credenciais do ADC.

Configurar a autenticação para o BigQuery

A configuração da autenticação depende do ambiente em que o código está sendo executado.

As opções a seguir para configuração da autenticação são as mais usadas. Para mais opções e informações sobre autenticação, consulte Autenticação no Google.

Para um ambiente de desenvolvimento local

É possível configurar credenciais para um ambiente de desenvolvimento local das seguintes maneiras:

Credenciais de usuário para bibliotecas de cliente ou ferramentas de terceiros
Credenciais do usuário para solicitações REST da linha de comando
Identidade temporária de conta de serviço

Bibliotecas de cliente ou ferramentas de terceiros

Configure o Application Default Credentials (ADC) no ambiente local:

Instale a Google Cloud CLI e inicialize-a executando o seguinte comando:
```
gcloud init
```

Crie as credenciais de autenticação para sua Conta do Google:
```
gcloud auth application-default login
```
Uma tela de login será exibida. Após o login, suas credenciais são armazenadas no arquivo de credenciais local usado pelo ADC.

Para mais informações sobre como trabalhar com o ADC em um ambiente local, consulte Ambiente de desenvolvimento local.

Solicitações REST usando a linha de comando

Ao fazer uma solicitação REST usando a linha de comando, use as credenciais da CLI gcloud incluindo gcloud auth print-access-token como parte do comando que envia a solicitação.

No exemplo a seguir, listamos as contas de serviço do projeto especificado. É possível usar o mesmo padrão em qualquer solicitação REST.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

PROJECT_ID pelo ID do projeto no Google Cloud.

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Execute o seguinte comando:

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts"

PowerShell (Windows)

Execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts" | Select-Object -Expand Content

Para mais informações sobre como autenticar usando REST e gRPC, consulte Autenticar para usar REST. Para mais informações sobre a diferença entre as credenciais do ADC local e as credenciais da gcloud CLI, consulte Credenciais da gcloud CLI e credenciais do ADC.

Identidade temporária de conta de serviço

Na maioria dos casos, é possível usar as credenciais de usuário para se autenticar em um ambiente de desenvolvimento local. Se isso não for viável ou você precisar testar as permissões atribuídas a uma conta de serviço, use a identidade temporária de conta de serviço. Você precisa ter a permissão iam.serviceAccounts.getAccessToken, que é incluída no papel do IAM de Criador de tokens da conta de serviço (roles/iam.serviceAccountTokenCreator).

Configure a gcloud CLI para usar a identidade temporária de conta de serviço com o comando gcloud config set:

gcloud config set auth/impersonate_service_account SERVICE_ACCT_EMAIL

Em algumas linguagens, é possível usar a identidade temporária de conta de serviço para criar um arquivo do ADC local a ser usado pelas bibliotecas de cliente. Essa abordagem só tem suporte nas bibliotecas de cliente Go, Java, Node.js e Python. Não há suporte a ela em outras linguagens. Para configurar um arquivo do ADC local com identidade temporária de conta de serviço, use a flag --impersonate-service-account com o comando gcloud auth application-default login:

gcloud auth application-default login --impersonate-service-account=SERVICE_ACCT_EMAIL

Para mais informações sobre a identidade temporária de conta de serviço, consulte Usar a identidade temporária de conta de serviço.

No Google Cloud

Para autenticar uma carga de trabalho em execução no Google Cloud, use as credenciais da conta de serviço anexada ao recurso de computação em que seu código está sendo executado. Por exemplo, é possível anexar uma conta de serviço a uma instância de máquina virtual (VM) do Compute Engine, a um serviço do Cloud Run ou a um job do Dataflow. Essa abordagem é o método de autenticação preferencial para códigos em execução em um recurso de computação do Google Cloud.

Para a maioria dos serviços, você precisa anexar a conta de serviço ao criar o recurso que executará o código. Não será possível adicionar ou substituir a conta de serviço mais tarde. O Compute Engine é uma exceção. Ele permite anexar uma conta de serviço a uma instância de VM a qualquer momento.

Use a CLI gcloud para criar uma conta de serviço e anexá-la ao recurso:

Instale a Google Cloud CLI e inicialize-a executando o seguinte comando:
```
gcloud init
```
Configure a autenticação:
1. Crie a conta de serviço:
```
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
```
  Substitua SERVICE_ACCOUNT_NAME por um nome para a conta de serviço.
2. Para conceder acesso ao projeto e aos recursos, conceda um papel à conta de serviço:
```
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE
```
  Substitua:
  - SERVICE_ACCOUNT_NAME: o nome da conta de serviço.
  - PROJECT_ID: o ID do projeto em que você criou a conta de serviço
  - ROLE: o papel a ser concedido
  Observação: a flag --role afeta quais recursos sua conta de serviço pode acessar no projeto. É possível revogar esses papéis ou conceder outros papéis posteriormente. Em ambientes de produção, não conceda os papéis de proprietário, editor ou visualizador. Em vez disso, conceda um papel predefinido ou um papel personalizado que atenda às suas necessidades.
3. Para conceder outro papel à conta de serviço, execute o comando que você fez na etapa anterior.
4. Conceda à sua Conta do Google um papel que permita que você use os papéis da conta de serviço e anexe a conta de serviço a outros recursos:
```
gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com --member="user:USER_EMAIL" --role=roles/iam.serviceAccountUser
```
  Substitua:
  - SERVICE_ACCOUNT_NAME: o nome da conta de serviço.
  - PROJECT_ID: o ID do projeto em que você criou a conta de serviço
  - USER_EMAIL: o endereço de e-mail da sua Conta do Google
Crie o recurso que executará o código e anexe a conta de serviço a ele. Por exemplo, se você usar o Compute Engine:
Crie uma instância do Compute Engine. Configure a instância da seguinte maneira:
- Substitua INSTANCE_NAME pelo nome de instância de sua preferência.
- Defina a sinalização --zone com a zona onde será criada a instância.
- Defina a sinalização --service-account como o endereço de e-mail da conta de serviço que você criou.
```
gcloud compute instances create INSTANCE_NAME --zone=ZONE --service-account=SERVICE_ACCOUNT_EMAIL
```

Para mais informações sobre a autenticação nas APIs do Google, consulte Autenticação no Google.

No local ou em outro provedor de nuvem

O método preferencial para configurar a autenticação de fora do Google Cloud é usar a federação de identidade da carga de trabalho. Para mais informações, consulte No local ou em outro provedor de nuvem na documentação de autenticação.

Controle de acesso do BigQuery

Depois da autenticação no BigQuery, você precisa de autorização para acessar os recursos do Google Cloud. O Bigtable usa o Identity and Access Management (IAM) para a autorização.

Para mais informações sobre os papéis do BigQuery, consulte Introdução ao IAM no BigQuery. Para mais informações sobre o IAM e a autorização, consulte Visão geral do IAM.

A seguir

Começar a usar a autenticação
Autenticar apps instalados com contas de usuário
Autenticar com JSON Web Tokens.
Saiba mais sobre os métodos de autenticação do Google Cloud.
Veja uma lista de casos de uso de autenticação.