Como autenticar como um usuário final

Este tópico explica como acessar as APIs do Google Cloud em nome de um usuário final. Para informações gerais sobre a autenticação em APIs do Google Cloud, consulte Visão geral da autenticação.

Fluxo de autenticação

Quando um aplicativo precisa acessar as APIs do Google Cloud em nome de um usuário final, ele inicia um fluxo de consentimento do OAuth. Depois que o usuário concluir o fluxo, seu aplicativo receberá as credenciais do usuário. Com essas credenciais, seu aplicativo pode chamar as APIs do Google Cloud em nome do usuário.

Este processo é um protocolo chamado OAuth 2.0.

Fluxo do OAuth 2.0
Seu app
Consentimento do usuário
Dados do usuário

Para saber mais sobre o OAuth 2.0, consulte OAuth 2.0.

Como especificar escopos do OAuth

Ao autenticar como um usuário final, você precisa especificar explicitamente os escopos do OAuth. Eles limitam as ações que o aplicativo pode executar em nome do usuário final. Por exemplo, essas ações talvez incluam a leitura de arquivos do Cloud Storage ou o gerenciamento de projetos do Google Cloud.

Consulte a página da API específica para mais informações sobre quais escopos do OAuth estão disponíveis. Por exemplo, se você planeja usar o método disks.get() para a API Compute Engine, será necessário definir um desses escopos do OAuth. Defina o escopo mínimo necessário com base no seu caso de uso.

Como conceder e limitar o acesso a recursos do projeto

Se você estiver usando credenciais de usuário final para acessar recursos dentro do seu projeto, precisará conceder ao usuário acesso a eles. Faça isso no Google Cloud definindo um papel no gerenciamento de identidade e acesso (IAM).

Delimite o acesso do usuário a alguns recursos, especialmente quando ele tem permissão para acessar recursos em um projeto seu. Defina os papéis de acordo com o privilégio mínimo que o usuário precisa.

Cada serviço tem um conjunto de papéis do IAM, mas é possível criar papéis personalizados. Para mais informações, consulte Como entender os papéis e Como criar e gerenciar papéis personalizados.

Exemplo de autenticação do usuário final

Conclua as seções a seguir para receber credenciais para um usuário final. As etapas a seguir usam a API BigQuery, mas é possível replicar esse processo com qualquer API do Google Cloud que tenha uma biblioteca de cliente.

Como configurar o projeto

  1. Faça login na sua conta do Google.

    Se você ainda não tiver uma, inscreva-se.

  2. No Console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar a página do seletor de projetos

  3. Verifique se o faturamento está ativado para seu projeto na nuvem. Saiba como confirmar se o faturamento está ativado para o projeto.

  4. Ative a API BigQuery.

    Ative a API

  5. Instale as bibliotecas de cliente do BigQuery.
  6. Se estiver usando Python ou Node.js, você deverá instalar uma biblioteca de autenticação adicional.

    Python

    Instale a integração oauthlib para o Google Auth.

    pip install --upgrade google-auth-oauthlib

Como criar as credenciais de cliente

Crie suas credenciais de cliente no Console do Google Cloud.

  1. Acesse a página Tela de consentimento OAuth no Console do Cloud.

  2. Na página Credenciais, selecione o botão Criar credenciais e selecione o ID do cliente do OAuth.

  3. Selecione Outro e clique no botão Criar. Selecione o botão OK quando a caixa de diálogo de sucesso for exibida.

  4. Para fazer o download das credenciais, clique no botão Fazer o download do JSON referente ao ID do cliente.

    Botão Fazer o download do JSON

  5. Salve o arquivo de credenciais em client_secrets.json. Esse arquivo precisa ser distribuído com seu aplicativo.

Como autenticar e chamar a API

  1. Use as credenciais do cliente para executar o fluxo do OAuth 2.0.

    Python

    from google_auth_oauthlib import flow
    
    # TODO: Uncomment the line below to set the `launch_browser` variable.
    # launch_browser = True
    #
    # The `launch_browser` boolean variable indicates if a local server is used
    # as the callback URL in the auth flow. A value of `True` is recommended,
    # but a local server does not work if accessing the application remotely,
    # such as over SSH or from a remote Jupyter notebook.
    
    appflow = flow.InstalledAppFlow.from_client_secrets_file(
        "client_secrets.json", scopes=["https://www.googleapis.com/auth/bigquery"]
    )
    
    if launch_browser:
        appflow.run_local_server()
    else:
        appflow.run_console()
    
    credentials = appflow.credentials

  2. Use as credenciais autenticadas para se conectar à API BigQuery.

    Python

    from google.cloud import bigquery
    
    # TODO: Uncomment the line below to set the `project` variable.
    # project = 'user-project-id'
    #
    # The `project` variable defines the project to be billed for query
    # processing. The user must have the bigquery.jobs.create permission on
    # this project to run a query. See:
    # https://cloud.google.com/bigquery/docs/access-control#permissions
    
    client = bigquery.Client(project=project, credentials=credentials)
    
    query_string = """SELECT name, SUM(number) as total
    FROM `bigquery-public-data.usa_names.usa_1910_current`
    WHERE name = 'William'
    GROUP BY name;
    """
    query_job = client.query(query_string)
    
    # Print the results.
    for row in query_job.result():  # Wait for the job to complete.
        print("{}: {}".format(row["name"], row["total"]))

Quando você executar o código de amostra, ele iniciará um navegador solicitando acesso ao projeto associado às chaves secretas do cliente. As credenciais resultantes poderão ser usadas para acessar os recursos do BigQuery do usuário, porque a amostra solicitou o escopo do BigQuery.

Em um caso de uso diferente, conceda papéis do IAM para determinar o que o usuário pode acessar.

A seguir