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

此文档页面介绍了如何在创建实例期间设置 OAuth 客户端并将 OAuth 凭据与实例手动关联。

何时创建 OAuth 凭据

以下类型的 Looker (Google Cloud Core) 实例要求您在创建实例期间创建 OAuth 凭证并将其与实例相关联，即使您想使用其他身份验证方法来对用户进行身份验证以登录实例也是如此：

此外，如果您想向使用公共安全连接的 Looker (Google Cloud Core) 实例添加自定义网域，则必须创建 OAuth 凭证，然后在设置自定义网域时手动将这些凭证与实例相关联。

仅使用公共安全连接的 Looker (Google Cloud Core) 实例不需要您创建 OAuth 凭据或将其与实例相关联。对于该类型的实例，Looker (Google Cloud Core) 会为该实例分配由 Looker 管理的 OAuth 客户端和密钥。

所需的角色

如需使用 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 和客户端密钥。在创建 Looker (Google Cloud Core) 实例期间，需要提供这些值。

您可以在任意 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 和客户端密钥。您在创建 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) 实例创建期间

创建 Looker (Google Cloud Core) 实例时，请在 OAuth 应用凭据部分中添加 OAuth 客户端 ID 和客户端密钥。如果没有 OAuth 凭据，您将无法创建实例。如需查找 OAuth 客户端 ID 和客户端密钥，请在 Google Cloud 控制台中前往 OAuth 客户端。

创建 Looker (Google Cloud Core) 实例后

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

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

如果您尚未执行此操作，请按照以下步骤将新创建的 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. 在 Edit Looker (Google Cloud Core) instance（修改 Looker [Google Cloud Core] 实例）页面上，前往 OAuth application credentials（OAuth 应用凭据）部分，然后选择 Manual（手动），如果尚未选择。
  5. 在 OAuth 客户端 ID 和 OAuth 客户端密钥字段中输入新值。
  6. 点击保存。

如果您的 OAuth 应用凭据设置为 Looker 管理，您将无法添加或修改凭据。请切换到手动凭据设置，以便修改或添加凭据。

后续步骤