Criar um cliente e credenciais OAuth para uma instância do Looker (Google Cloud Core)

Esta página de documentação explica como configurar o cliente OAuth e associar manualmente as credenciais OAuth à instância durante a criação dela.

Quando criar credenciais do OAuth

Na maioria dos casos, o Looker (Google Cloud Core) cria e atribui automaticamente credenciais OAuth gerenciadas pelo Looker por padrão. Você precisa criar um cliente OAuth e associar manualmente as credenciais OAuth personalizadas apenas em cenários específicos, dependendo do tipo de conexão de rede e da configuração de autenticação da sua instância:

  • Conexões particulares ou híbridas com o OAuth do Google: a configuração manual do OAuth é obrigatória sempre que o OAuth do Google é usado (como autenticação principal ou secundária) com conexões particulares ou híbridas.
  • Conexões públicas com o OAuth do Google: se você criar a instância no console doGoogle Cloud , a configuração manual do OAuth não será necessária porque o Looker (Google Cloud Core) atribui automaticamente credenciais gerenciadas pelo Looker por padrão, embora seja possível configurar credenciais personalizadas. Se você criar a instância com a Google Cloud CLI, será necessário fornecer credenciais OAuth.
  • Somente federação de identidade de colaboradores: a configuração manual do OAuth não é necessária em nenhum tipo de conexão de rede ao usar a federação de identidade de colaboradores sem o OAuth secundário do Google.
  • Domínios personalizados: se você configurar um domínio personalizado para uma instância que usa conexões públicas seguras e o OAuth do Google, as credenciais personalizadas do OAuth serão necessárias e configuradas como parte do processo de criação do domínio personalizado.

A tabela a seguir resume quando a configuração manual de credenciais do OAuth é necessária:

Autenticação principal Autenticação secundária Tipo de conexão de rede Configuração manual do OAuth
OAuth do Google Nenhum Conexões seguras públicas Não é necessário se você usar o console do Google Cloud , porque o Looker (Google Cloud Core) atribui automaticamente credenciais gerenciadas pelo Looker. Obrigatório se você usar a CLI gcloud.
Conexões particulares ou conexões híbridas Obrigatório. Siga as instruções nesta página.
Federação de identidade de colaboradores Nenhum Conexões públicas Não é obrigatório.
Federação de identidade de colaboradores OAuth do Google Conexões seguras públicas Opcional se você usar o console do Google Cloud . Por padrão, o Looker (Google Cloud Core) usa credenciais gerenciadas pelo Looker, mas é possível fornecer credenciais personalizadas. Obrigatório se você usar a CLI gcloud.

Funções exigidas

Para usar o console do Google Cloud para criar e editar credenciais do OAuth, você precisa das seguintes permissões. Para ocultar a lista de permissões, feche a seção Permissões necessárias.

Permissões necessárias

  • clientauthconfig.*
    • clientauthconfig.brands.create
    • clientauthconfig.brands.delete
    • clientauthconfig.brands.get
    • clientauthconfig.brands.list
    • clientauthconfig.brands.update
    • clientauthconfig.clients.create
    • clientauthconfig.clients.createSecret
    • clientauthconfig.clients.delete
    • clientauthconfig.clients.get
    • clientauthconfig.clients.getWithSecret
    • clientauthconfig.clients.list
    • clientauthconfig.clients.listWithSecrets
    • clientauthconfig.clients.undelete
    • clientauthconfig.clients.update
  • oauthconfig.*
    • oauthconfig.clientpolicy.get
    • oauthconfig.testusers.get
    • oauthconfig.testusers.update
    • oauthconfig.verification.get
    • oauthconfig.verification.submit
    • oauthconfig.verification.update

Também é possível receber as permissões necessárias com papéis personalizados ou outros papéis predefinidos. Para mais informações sobre como conceder papéis, consulte a página Gerenciar o acesso a projetos, pastas e organizações na documentação do Identity and Access Management (IAM).

Antes de criar uma instância do Looker (Google Cloud Core)

Antes de criar uma instância do Looker (Google Cloud Core), conclua as etapas descritas nestas seções:

Gerar o ID e a chave secreta do cliente OAuth

Primeiro, crie um cliente OAuth e gere o ID do cliente e a chave secreta do cliente para esse cliente. Você precisa desses valores durante a criação da instância ao configurar credenciais personalizadas do OAuth, como para conexões particulares ou híbridas com o OAuth do Google, ou quando a autenticação do Google está ativada usando a CLI gcloud.

É possível configurar o cliente OAuth em qualquer projeto do Google Cloud que você quiser. Não precisa ser o mesmo projeto da instância do Looker (Google Cloud Core). No entanto, a API Looker (Google Cloud Core) precisa estar ativada nesse projeto.

Para criar o cliente e as credenciais dele, siga estas etapas:

  1. Navegue até o projeto em que você quer criar o cliente OAuth.
  2. Acesse APIs e serviços > Credenciais.
  3. Na página Credenciais, clique em Criar credenciais.
  4. No menu suspenso, selecione ID do cliente OAuth.
  5. No menu suspenso Tipo de aplicativo, selecione Aplicativo da Web.
  6. No campo Nome, insira um nome para o cliente OAuth.
  7. No momento, não é necessário adicionar URIs nas seções Origens JavaScript autorizadas ou URIs de redirecionamento autorizados.
  8. Clique em Criar.

Depois de clicar em Criar, uma janela Cliente OAuth criado vai aparecer. Essa janela mostra o ID e a chave secreta do cliente criados para o cliente OAuth. Se você configurar credenciais OAuth personalizadas, insira esses valores ao criar sua instância do Looker (Google Cloud Core) para conexões públicas seguras, Private Service Connect ou acesso a serviços particulares.

Se quiser, clique em Fazer o download do JSON para baixar as informações de credencial em um arquivo JSON. Para fechar a janela, clique em OK.

Em seguida, configure a tela de permissão. A tela de permissão é mostrada a um usuário da instância do Looker (Google Cloud Core) no primeiro login e em qualquer momento em que a autorização expirar ou for revogada pelo usuário.

Siga as instruções na página de documentação Configurar a tela de permissão OAuth e escolher escopos. Ao configurar a tela, defina as seguintes configurações conforme descrito:

  • Na seção Branding, em Domínios autorizados, o domínio precisa corresponder ao domínio da instância do Looker (Google Cloud Core) que usa as credenciais do OAuth. Se você for criar um domínio personalizado para sua instância do Looker (Google Cloud Core) e souber o domínio que será atribuído a ela, insira-o agora. Caso contrário, deixe esse campo em branco. Ele será preenchido automaticamente quando você adicionar o URI de redirecionamento autorizado após a criação da instância do Looker (Google Cloud Core).

  • Na seção Público-alvo, em Tipo de usuário, selecione uma das seguintes opções:

Durante a criação da instância do Looker (Google Cloud Core)

Algumas instâncias exigem credenciais OAuth personalizadas, como instâncias com conexões privadas ou híbridas e o OAuth do Google, ou instâncias criadas com a CLI gcloud enquanto a autenticação do Google está ativada. Para essas instâncias, insira o ID do cliente OAuth e a chave secreta do cliente durante a configuração. Para encontrar esses valores, selecione o cliente OAuth no console do Google Cloud .

Dependendo do tipo de conexão e do método de criação, insira as credenciais da seguinte maneira:

Depois de criar uma instância do Looker (Google Cloud Core)

Siga as instruções abaixo para concluir a configuração. Quando você adiciona um URI de redirecionamento autorizado, ele é adicionado à tela de permissão OAuth como um domínio autorizado.

Adicionar o URI de redirecionamento autorizado ao cliente OAuth

Se você ainda não tiver feito isso, siga estas etapas para inserir o URL da instância do Looker (Google Cloud Core) recém-criada no cliente OAuth.

  1. Depois de criar uma instância do Looker (Google Cloud Core), encontre e copie o URL dela. Encontre o URL na página Instâncias.

  2. No console do Google Cloud , acesse APIs e serviços > Credenciais.

  3. No cabeçalho IDs do cliente OAuth 2.0, clique no nome do cliente que você criou.

  4. Na seção URIs de redirecionamento autorizados, clique em Adicionar URI.

  5. Cole o URL da instância do Looker (Google Cloud Core) no campo URIs. Adicione /oauth2callback ao final do URL. Por exemplo: https://uuid.looker.app/oauth2callback.

    Se você for configurar a autorização do OAuth para o BigQuery, também poderá adicionar um segundo URI de redirecionamento que aponte para o URL da instância do Looker (Google Cloud Core) seguido por /external_oauth/redirect adicionado ao final do URL. Por exemplo: https://uuid.looker.app/external_oauth/redirect.

  6. Clique em Salvar.

A atualização pode levar de cinco minutos a algumas horas para entrar em vigor.

Gerenciar usuários

Depois que o cliente OAuth for configurado e a instância do Looker (Google Cloud Core) for criada, você poderá fazer login na instância usando o OAuth. Em seguida, escolha o método de autenticação para sua instância.

Se você estiver usando o OAuth como seu método de autenticação principal, siga as etapas descritas na página de documentação Usar o OAuth do Google para autenticação de usuários do Looker (Google Cloud Core) para concluir a configuração do OAuth para autenticação de usuários.

Depois de configurar o método de autenticação, você pode adicionar ou remover usuários pelo provedor de identidade e gerenciá-los no Looker.

Ver o tipo de credenciais do OAuth da sua instância

As credenciais do OAuth não são listadas diretamente na página de configuração da instância do console do Google Cloud . Clique em Editar na página de configuração da instância para acessar a seção Credenciais do aplicativo OAuth.

Se as credenciais do OAuth estiverem definidas como Gerenciadas pelo Looker, o Looker (Google Cloud Core) vai atribuir credenciais do OAuth gerenciadas pelo Looker à sua instância durante a criação dela, e o ID do cliente e a chave secreta do cliente não serão mostrados.

Se as credenciais do OAuth estiverem definidas como Manuais, as credenciais manuais do OAuth foram adicionadas à instância durante ou após a criação dela. O ID do cliente e a chave secreta do cliente não são mostrados. Em vez disso, a seção exibe marcadores de posição ****.

Editar o cliente OAuth de uma instância do Looker (Google Cloud Core)

Se quiser, adicione, edite ou mude as credenciais do OAuth da sua instância do Looker (Google Cloud Core) seguindo estas etapas:

  1. Configure o novo cliente ou as novas credenciais.
  2. No console do Google Cloud , na página Instâncias, clique no nome de uma instância para abrir a página DETALHES.
  3. Na página DETALHES, clique em Editar.
  4. Na página Editar instância do Looker (Google Cloud Core), navegue até a seção Credenciais do aplicativo OAuth e selecione Manual, se ainda não estiver selecionada.
  5. Insira os novos valores nos campos ID do cliente OAuth e Chave secreta do cliente OAuth.
  6. Clique em Salvar.

Se as credenciais do aplicativo OAuth estiverem definidas como Gerenciadas pelo Looker, não será possível adicionar ou editar credenciais. Mude para a configuração Manual para editar ou adicionar credenciais.

A seguir