为 Looker (Google Cloud Core) 实例创建 OAuth 客户端和凭据

本页面介绍了如何设置 OAuth 客户端,以及如何在创建实例期间手动将 OAuth 凭证与实例相关联。

何时创建 OAuth 凭证

在大多数情况下,Looker (Google Cloud Core) 默认会自动创建并分配 Looker 管理的 OAuth 凭据。只有在特定场景下,您才需要创建 OAuth 客户端并手动关联自定义 OAuth 凭据,具体取决于实例的网络连接类型和身份验证配置:

  • 使用 Google OAuth 的专用或混合连接:只要将 Google OAuth(作为主要或次要身份验证)与专用或混合连接搭配使用,就必须手动设置 OAuth。
  • 使用 Google OAuth 的公共连接:如果您在Google Cloud 控制台中创建实例,则无需手动设置 OAuth,因为 Looker (Google Cloud Core) 默认会自动分配 Looker 管理的凭证,不过您也可以选择配置自定义凭证。如果您使用 Google Cloud CLI 创建实例,则必须提供 OAuth 凭据。
  • 仅限员工身份联合:在不使用辅助 Google OAuth 的情况下,使用员工身份联合时,无需在任何网络连接类型中手动设置 OAuth。
  • 自定义网域:如果您为使用公共安全连接和 Google OAuth 的实例配置自定义网域,则需要自定义 OAuth 凭证,并且这些凭证会在自定义网域创建过程中进行配置。

下表总结了何时需要手动设置 OAuth 凭证:

主要身份验证 次要身份验证 网络连接类型 手动 OAuth 设置
Google OAuth 无 公共安全连接 如果您使用 Google Cloud 控制台,则不需要,因为 Looker (Google Cloud Core) 会自动分配 Looker 管理的凭据。如果您使用 gcloud CLI,则必须提供此参数。
专用连接或混合连接 必需。按照本页面上的说明操作。
员工身份联合 无 公共网络连接 非必需。
员工身份联合 Google OAuth 公共安全连接 如果您使用 Google Cloud 控制台,则此步骤可选。默认情况下,Looker (Google Cloud Core) 使用 Looker 管理的凭据,但您可以提供自定义凭据。如果您使用 gcloud CLI,则此参数是必需的。

所需的角色

如需使用 Google Cloud 控制台创建和修改 OAuth 凭据,您需要拥有以下权限。(如需隐藏权限列表,请收起所需权限部分。)

所需权限

  • 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

您也可以通过自定义角色或其他预定义角色来获取所需的权限。如需详细了解如何授予角色,请参阅 Identity and Access Management (IAM) 文档中的管理对项目、文件夹和组织的访问权限页面。

创建 Looker (Google Cloud Core) 实例之前

在创建 Looker (Google Cloud core) 实例之前,请完成以下各部分中所述的步骤:

生成 OAuth 客户端 ID 和客户端密钥

首先,创建一个 OAuth 客户端,并为该客户端生成客户端 ID 和客户端密钥。在实例创建期间,如果您配置自定义 OAuth 凭证(例如,使用 Google OAuth 的专用或混合连接),或者使用 gcloud CLI 启用 Google 身份验证,则需要这些值。

您可以在任何 Google Cloud 项目中设置 OAuth 客户端。该项目无需与 Looker (Google Cloud Core) 实例位于同一项目中。不过,必须在此项目中启用 Looker (Google Cloud Core) API。

如需创建客户端及其凭证,请按以下步骤操作:

  1. 前往您要在其中创建 OAuth 客户端的项目。
  2. 前往 API 和服务 > 凭证。
  3. 在凭证页面中,点击创建凭证。
  4. 从下拉菜单中选择 OAuth 客户端 ID。
  5. 在应用类型下拉菜单中,选择 Web 应用。
  6. 在名称字段中,为 OAuth 客户端输入名称。
  7. 此时,您无需在已获授权的 JavaScript 来源或已获授权的重定向 URI 部分中添加 URI。
  8. 点击创建。

点击创建后,系统会显示已创建 OAuth 客户端窗口。此窗口会显示为您的 OAuth 客户端创建的客户端 ID 和客户端密钥。如果您配置自定义 OAuth 凭据,请在为公共安全连接、Private Service Connect 或专用服务访问通道创建 Looker (Google Cloud Core) 实例时输入这些值。

(可选)点击下载 JSON,以 JSON 文件格式下载凭证信息。点击确定,关闭此窗口。

接下来,您可能需要配置权限请求页面。在 Looker (Google Cloud Core) 实例的用户首次登录时,以及在用户的授权过期或被用户撤消时,系统会向用户显示权限请求页面。

按照配置 OAuth 权限请求页面并选择范围文档页面上的说明操作。在配置屏幕时,请按照说明完成以下设置:

  • 在品牌部分的已获授权的网域下,网域必须与使用 OAuth 凭证的 Looker (Google Cloud Core) 实例的网域一致。如果您要为 Looker (Google Cloud Core) 实例创建自定义网域,并且知道要为其分配的网域,则可以立即输入。否则,您可以将此字段留空;在创建 Looker (Google Cloud Core) 实例后,当您添加已获授权的重定向 URI 时,系统会自动填充此字段。

  • 在受众部分的用户类型下,选择以下选项之一:

在创建 Looker (Google Cloud Core) 实例期间

某些实例需要自定义 OAuth 凭证,例如具有专用连接或混合连接以及 Google OAuth 的实例,或者您在启用 Google 身份验证的情况下使用 gcloud CLI 创建的实例。对于这些实例,请在设置期间输入 OAuth 客户端 ID 和客户端密钥。如需查找这些值,请在 Google Cloud 控制台中选择您的 OAuth 客户端。

根据您的连接类型和创建方法,按如下方式输入凭据:

创建 Looker (Google Cloud Core) 实例后

请按照以下说明完成配置。当您添加已获授权的重定向 URI 时,该 URI 将作为已获授权的网域添加到您的 OAuth 权限请求页面。

将已获授权的重定向 URI 添加到 OAuth 客户端

如果您尚未执行此操作,请按照以下步骤将新创建的 Looker (Google Cloud Core) 实例的网址输入到 OAuth 客户端中。

  1. 创建 Looker (Google Cloud Core) 实例后,找到并复制该实例的网址。您可以在实例页面上找到该网址。

  2. 在 Google Cloud 控制台中,前往 API 和服务 > 凭证。

  3. 在 OAuth 2.0 客户端 ID 标题下,点击您创建的客户端的名称。

  4. 在已获授权的重定向 URI 部分中,点击添加 URI。

  5. 将 Looker (Google Cloud Core) 实例的网址粘贴到 URI 字段中。在网址末尾添加 /oauth2callback。例如:https://uuid.looker.app/oauth2callback。

    如果您要设置 BigQuery 的 OAuth 授权,还可以添加第二个重定向 URI,该 URI 指向 Looker (Google Cloud Core)实例的网址,并在网址末尾添加 /external_oauth/redirect。例如:https://uuid.looker.app/external_oauth/redirect。

  6. 点击保存。

更新可能需要 5 分钟到几小时才会生效。

管理用户

配置 OAuth 客户端并创建 Looker (Google Cloud Core) 实例后,您可以使用 OAuth 登录该实例。然后,您可以为实例选择身份验证方法。

如果使用 OAuth 作为主要身份验证方法,请按照使用 Google OAuth 进行 Looker (Google Cloud Core) 用户身份验证文档页面中所述的步骤完成用户身份验证的 OAuth 设置。

设置好身份验证方法后,您可以通过身份提供方添加或移除用户,并在 Looker 中管理这些用户。

查看实例的 OAuth 凭证类型

OAuth 凭据不会直接列在 Google Cloud 控制台的实例配置页面上。点击实例配置页面上的修改,查看 OAuth 应用凭据部分。

如果 OAuth 凭证设置为 Looker 托管,Looker (Google Cloud Core) 会在实例创建期间为您的实例分配 Looker 托管的 OAuth 凭证,并且不会显示客户端 ID 和客户端密钥。

如果 OAuth 凭证设置为手动,则表示在实例创建期间或之后,手动 OAuth 凭证已添加到您的实例中。系统不会显示客户端 ID 和客户端密钥,而是会显示 **** 占位符。

修改 Looker (Google Cloud Core) 实例的 OAuth 客户端

您可以按照以下步骤为 Looker (Google Cloud Core) 实例添加、修改或更改 OAuth 凭据:

  1. 设置新客户端或凭证。
  2. 在 Google Cloud 控制台的实例页面中,点击实例名称以打开详细信息页面。
  3. 在详情页面中,点击修改。
  4. 在修改 Looker (Google Cloud Core) 实例页面上,前往 OAuth 应用凭证部分,然后选择手动(如果尚未选择)。
  5. 在 OAuth 客户端 ID 和 OAuth 客户端密钥字段中输入新值。
  6. 点击保存。

如果您的 OAuth 应用凭证设置为由 Looker 管理,则您无法添加或修改凭证。切换到手动设置,即可修改或添加凭据。

后续步骤