管理设置 - OpenID Connect 身份验证

公司使用不同的 OpenID Connect 提供商 (OP) 来与 OpenID Connect 协调（例如 Okta 或 OneLogin）。以下设置说明和 Looker 界面中使用的术语可能与 OP 使用的术语不直接匹配。

通过“管理”菜单的身份验证部分中的 OpenID Connect 页面，您可以配置 Looker，以使用 OpenID Connect 协议对用户进行身份验证。本页面介绍了该流程，并提供了将 OpenID Connect 群组关联到 Looker 角色和权限的说明。

要求

仅当满足以下条件时，Looker 才会在管理菜单的身份验证部分中显示 OpenID Connect 页面：

  • 您拥有管理员角色。
  • 您的 Looker（原始版本）实例已启用 OpenID Connect。请与您的客户主管联系，以启用 OpenID Connect。
  • 您的 Looker (Google Cloud Core) 实例使用 Google OAuth 作为主要身份验证方法。

如果满足这些条件，但您没有看到 OpenID Connect 页面，请提交支持请求，以便在您的实例上启用 OpenID Connect。

规划时的注意事项

  • 考虑使用为指定用户提供备用登录选项，以便 Looker 管理员无需 OpenID Connect 即可访问 Looker。
  • 如果您使用 OpenID Connect 登录 Looker，请勿停用 OpenID Connect 身份验证，除非您已设置备用账号登录。否则，可能会导致您无法登录该应用。
  • Looker 可以使用来自当前电子邮件和密码设置、LDAP、SAML 或 Google 身份验证的电子邮件地址，将现有账号迁移到 OpenID Connect。您可以在设置过程中配置此功能。
  • Looker 仅支持使用 OpenID Connect 的授权代码流程进行 OpenID Connect 身份验证。不支持其他代码流程。
  • OpenID Connect 规范包含一个可选的发现机制。Looker 不支持此机制，因此您必须在 OpenID Connect Auth 设置部分中提供明确的网址，如配置 OpenID Connect Auth 设置中所述。
  • 以下是为 [使用专用连接的 Looker (Google Cloud Core) 实例]启用 OpenID Connect 的其他前提条件：
    • 必须配置 Cloud Router 路由器，以便将 VPC 网络路由正确传播到 Looker (Google Cloud Core)实例（例如，设置自定义通告路由）。
    • 必须设置互联网网络端点组 (NEG)，以便 Looker (Google Cloud Core) 专用连接实例将流量路由到外部身份提供方。

设置 OpenID Connect

如需设置 Looker 与 OpenID Connect 之间的连接，请执行以下任务：

  1. 向 OpenID Connect 提供方 (OP) 提供 Looker 网址。
  2. 从 OP 获取所需信息。
  3. 在 Looker 实例中配置 OpenID Connect 身份验证。

在 OP 上设置 Looker

您的 OpenID Connect 提供商 (OP) 需要 Looker 实例的网址。您的 OP 可能会将其称为重定向 URI 或登录重定向 URI 等。在 OP 的网站上，向 OP 提供您通常在浏览器中访问 Looker 实例的网址，后跟 /openidconnect。例如 https://instance_name.looker.com/openidconnect。

正在从您的 OP 获取信息

如需为 OpenID Connect 身份验证配置 Looker，您需要从 OP 获取以下信息：

  • 客户端标识符和客户端密钥。当您配置重定向 URI 时，OP 通常会在其网站上提供这些信息。
  • 在 OpenID Connect 身份验证过程中，Looker 将连接到三个不同的端点：身份验证端点、ID 令牌端点和用户信息端点。您需要知道 OP 为每个端点使用的网址。
  • 每个 OP 都会以称为“范围”的集合形式提供用户信息。您需要知道 OP 使用的范围的名称。OpenID Connect 需要 openid 范围，但您的 OP 可能会包含其他范围，例如 email、profile 和 groups。
  • 在 OpenID Connect 中，存储用户数据的属性称为声明。您需要知道 OP 会将哪些声明传递给 Looker，以便在 Looker 实例上提供所需的用户信息。Looker 需要包含电子邮件和名称信息的声明，但如果您有任何其他用户属性（例如时区或部门），Looker 还需要确定哪些声明包含该信息。声明可以包含在用户信息端点或 ID 令牌端点的响应中。Looker 可以将任一端点返回的声明映射到 Looker 用户属性。

许多 OP 会以发现文档的形式提供有关配置 OpenID Connect 的信息，以便您收集为 OpenID Connect 配置 Looker 所需的部分或全部信息。如果您无法访问发现文档，则需要从 OP 或内部身份验证团队获取必要的信息。

以下部分摘自发现文档示例：

{
  "issuer": "https://accounts.google.com",
  "authorization_endpoint": "https://accounts.google.com/o/oauth2/v2/auth",
  "token_endpoint": "https://www.googleapis.com/oauth2/v4/token",
  "userinfo_endpoint": "https://www.googleapis.com/oauth2/v3/userinfo",
  "revocation_endpoint": "https://accounts.google.com/o/oauth2/revoke",
  "jwks_uri": "https://www.googleapis.com/oauth2/v3/certs",
  "response_types_supported": [
    "code",
    "token",
    "id_token",
    "code token"
    "code id_token",
    "token id_token",
    "code token id_token",
    "none"
  ],
  "subject_types_supported": [
    "public"
  ],
  "id_token_signing_alg_values_supported": [
    "RS256"
  ],
  "scopes_supported": [
    "openid",
    "email",
    "profile"
  ],
  "token_endpoint_auth_methods_supported": [
    "client_secret_post",
    "client_secret_basic"
  ],
  "claims_supported": [
    "aud",
    "email",
    "email_verified",
    "exp",
    "family_name",
    "given_name",
    "iat",
    "iss",
    "locale",
    "name",
    "picture",
    "sub"
  ],

配置 OpenID Connect 身份验证设置

如需为 Looker 实例配置 OpenID Connect 身份验证，请从管理面板的身份验证部分中选择 OpenID Connect。在 OpenID Connect 身份验证页面上，选择配置 OpenID Connect。

使用从 OP 的发现文档、OP 或内部身份验证团队获取的配置信息，在以下字段中输入连接设置：

标识符：Looker 实例独有的客户端标识符。该账号应当由您的 OP 提供。

密钥：Looker 实例独有的客户端密钥。该账号应当由您的 OP 提供。

颁发者：用于标识 OP 的安全网址。

受众群体：向 OP 指示客户端身份的标识符。这通常与标识符值相同，但也可能是其他值。

授权网址：身份验证序列开始的 OP 的网址。在发现文档中通常称为 authorization_endpoint。

令牌网址：Looker 获得授权后，用于检索 OAuth 令牌的网址。在发现文档中通常称为 token_endpoint。

用户信息网址：Looker 将在其中检索详细用户信息的网址。在发现文档中通常称为 userinfo_endpoint。

范围：OP 用于向 Looker 提供用户信息的逗号分隔列表。您必须添加 openid 范围以及包含 Looker 所需信息（包括电子邮件地址、用户名和在 Looker 实例上配置的所有用户属性）的所有范围。

配置用户属性设置

在本部分中，您会将 OP 的声明映射到 Looker 用户属性。

在用户属性设置部分中，输入 OP 声明的名称，其中包含每个字段的对应信息。这会告知 Looker 如何在登录时将这些声明映射到 Looker 用户信息。Looker 对声明的构建方式没有特定要求，但请务必确保此处输入的声明信息与 OP 中定义的声明方式一致。

标准声明

Looker 需要用户名和电子邮件信息来进行用户身份验证。在此部分中输入 OP 的相应声明信息：

邮箱声明：OP 用于用户邮箱的声明，例如 email。

名字声明：OP 用于用户名字的声明，例如 given_name。

姓氏声明：OP 用于用户姓氏的声明，例如 family_name。

请注意，某些 OP 会使用单个声明来表示姓名，而不是将名字和姓氏分开。如果您的 OP 属于这种情况，请在名字声明和姓氏声明字段中输入存储姓名的声明。对于每位用户，Looker 会将第一个空格之前的内容作为名字，将之后的所有内容作为姓氏。

属性配对

（可选）您可以使用 OpenID Connect 声明中的数据，在用户登录时自动填充 Looker 用户属性中的值。例如，如果您已配置 OpenID Connect 来建立与数据库的用户专用连接，则可以将 OpenID Connect 声明与 Looker 用户属性配对，以便在 Looker 中建立用户专用的数据库连接。

如需将声明与相应的 Looker 用户属性配对，或管理现有配对，请按以下步骤操作：

  1. 在用户属性设置部分，点击管理配对按钮，打开管理配对侧边栏。
  2. 在声明字段中，输入要配对的声明（由 OP 标识）。声明名称在列表中只能输入一次。如果您想将一个 OpenID Connect 声明与多个 Looker 属性相关联，可以在 Looker 用户属性字段中输入多个属性。
  3. 在 Looker 用户属性字段中，系统会显示实例的 Looker 用户属性下拉列表。选择要与 OpenID Connect 声明配对的 Looker 用户属性的名称。您可以选择多个 Looker 用户属性。必须至少选择一个 Looker 用户属性。
  4. 选中必填复选框，即可阻止该声明字段中缺少值的任何用户账号尝试登录。
  5. 点击添加配对按钮，向列表中添加另一个配对行。重复上述步骤，添加更多声明和属性对。
  6. 每个配对行右侧都有一个 移除配对图标。点击此图标可从实例中移除属性配对。
  7. 点击 关闭图标，退出管理配对侧边栏。
  8. 测试 OpenID Connect 配置。
  9. 验证您的 OpenID Connect 配置，然后在 OpenID Connect 身份验证页面底部，选中我已验证 OpenID Connect 配置复选框。
  10. 点击启用 OpenID Connect 或更新 OpenID Connect 设置按钮，保存声明和属性配对。

管理配对侧边栏还包含以下工具：

  • 过滤列表过滤条件菜单和搜索栏。使用这些工具可搜索已添加到实例中的配对。
  • Display 分页下拉菜单。使用此菜单可在每个页面上显示 10、25、50 或 100 个配对。

嵌套式版权主张

某些 OP 可以具有“嵌套”声明。例如：

"zoneinfo": "America/Los Angeles",
"phone_number": "555-1235",
"address": {
  "street_address": "1234 Main Street",
  "locality": "Anyton",
  "region": "IL",
  "postal_code": "60609",
  "country": "US"
},

在前面的示例中，locality 声明嵌套在 address 声明中。对于嵌套声明，请指定父声明和嵌套声明，并用斜杠 ( /) 字符分隔。如需为示例中的 locality 声明配置 Looker，请输入 address/locality。

群组和角色

您可以选择让 Looker 创建镜像外部管理的 OpenID Connect 群组的群组。群组可用于设置内容访问权限控制，以及根据用户的镜像 OpenID Connect 群组为用户分配用户属性。当您更改 OpenID Connect 群组成员资格时，这些更改会自动传播到 Looker 的群组配置中。

通过镜像 OpenID Connect 群组，您可以使用外部定义的 OpenID Connect 目录来管理 Looker 群组和用户。这样，您就可以在一个位置管理多个软件即服务 (SaaS) 工具（例如 Looker）的群组成员资格。

如果您开启镜像 OpenID Connect 群组，Looker 将为引入系统的每个 OpenID Connect 群组创建一个 Looker 群组。您可以在 Looker 的管理部分的群组页面上查看这些 Looker 群组。

默认群组和角色

默认情况下，镜像 OpenID Connect 群组开关处于关闭状态。在这种情况下，您可以为新的 OpenID Connect 用户设置默认群组。在新用户群组和新用户角色字段中，输入您希望新 Looker 用户在首次登录 Looker 时分配到的任何 Looker 群组或角色的名称：

这些群组和角色会在新用户首次登录时应用。这些群组和角色不会应用于现有用户，而且如果在首次登录后被移除，也将不会重新应用。

启用镜像 OpenID Connect 群组

如果您使用的是 Looker (Google Cloud Core) 实例，我们建议您仅为主身份验证方法启用群组镜像，而不要为备用 OAuth 身份验证启用群组镜像。如果您同时为主身份验证方法和辅助身份验证方法启用了群组镜像，则会发生以下行为：

  • 如果用户合并了身份，则无论用户实际使用哪种身份验证方法登录，群组镜像都会与主要身份验证方法匹配。
  • 如果用户没有合并的身份，群组镜像将与用于登录的身份验证方法相匹配。

启用镜像群组的步骤

如需在 Looker 中镜像 OpenID Connect 群组，请开启镜像 OpenID Connect 群组开关。Looker 会显示以下设置：

群组声明：输入 OP 用于存储群组名称的声明。然后，在首选群组名称/角色/OpenID Connect 群组名称字段中输入群组信息，以配置要镜像到 Looker 中的特定 OpenID Connect 群组。这是将 OpenID Connect 群组映射到 Looker 群组的必要步骤。

管理群组按钮：点击此按钮可打开管理群组侧边栏，您可以在其中添加、移除或修改自定义群组，或在 Looker 中修改分配给该群组的角色。管理群组侧边栏会显示以下字段：

  • 首选群组名称字段。在此字段中为镜像群组输入自定义名称。此名称将显示在 Looker 的管理部分的群组页面上。

  • OpenID Connect 群组名称字段。在此字段中输入 OpenID Connect 群组。OpenID Connect 群组中包含的 OpenID Connect 用户将被添加到 Looker 中的镜像群组。

  • 角色字段。在此字段中，选择要分配给群组中每个用户的一个或多个 Looker 角色。

  • 移除映射图标。点击此图标可从 Looker 实例中移除镜像群组。如果您删除某个群组，该群组将不再镜像到 Looker 中，其成员也将不再拥有通过该群组分配给他们的 Looker 角色。

管理群组侧边栏还包含以下工具：

  • 过滤列表过滤条件菜单和搜索栏。使用这些工具搜索已添加到实例中的群组。

  • 添加映射按钮。点击此按钮可向实例添加自定义组。

  • Display 分页下拉菜单。使用此菜单可选择每页显示的群组数量。

修改镜像组

如果您修改之前在此界面中配置的镜像群组，该群组的配置会发生变化，但群组本身会保持不变。例如，您可以更改某个群组的 Looker 群组名称，这会更改该群组在 Looker 的群组页面中的显示方式，但不会更改分配的角色和群组成员。更改 OpenID Connect 群组名称会保留群组名称和角色，但群组成员将根据具有新 OpenID Connect 群组名称的外部 OpenID Connect 群组的成员进行重新分配。

对镜像群组所做的任何修改都会在群组用户下次登录 Looker 时应用。

高级角色管理

如果您已启用镜像 OpenID Connect 群组开关，Looker 会显示这些设置。本部分中的选项决定了 Looker 管理员在配置从 OpenID Connect 镜像的 Looker 群组和用户时拥有多大的灵活性。

例如，如果您希望 Looker 群组和用户配置与 OpenID Connect 配置严格匹配，请开启这些选项。启用前三个选项后，Looker 管理员无法修改镜像群组的成员资格，只能通过 OpenID Connect 镜像群组向用户分配角色。

如果您希望更灵活地在 Looker 中进一步自定义群组，请关闭这些选项。您的 Looker 群组仍会镜像您的 OpenID Connect 配置，但您可以在 Looker 中执行其他群组和用户管理操作，例如将 OpenID Connect 用户添加到 Looker 专用群组，或直接向 OpenID Connect 用户分配 Looker 角色。

对于新的 Looker 实例或之前未配置过镜像群组的实例，这些选项默认处于关闭状态。

对于已配置镜像群组的现有 Looker 实例，这些选项默认处于开启状态。

高级角色管理部分包含以下选项：

禁止 OpenID Connect 个人用户获得直接角色：启用此选项后，Looker 管理员将无法直接向 OpenID Connect 用户分配 Looker 角色。OpenID Connect 用户将只能通过其群组成员资格获得角色。如果允许 OpenID Connect 用户加入内置（非镜像）Looker 群组，他们仍然可以从镜像 OpenID Connect 群组和内置 Looker 群组继承角色。对于先前直接分配了角色的任何 OpenID Connect 用户，这些角色将在用户下次登录时被移除。

如果此选项处于关闭状态，Looker 管理员可以直接向 OpenID Connect 用户分配 Looker 角色，就像这些用户是直接在 Looker 中配置的一样。

禁止直接加入非 OpenID Connect 群组：启用此选项后，Looker 管理员将无法直接将 OpenID Connect 用户添加到内置 Looker 群组。如果允许镜像 OpenID Connect 群组成为内置 Looker 群组的成员，则 OpenID Connect 用户可能会保留任何父级 Looker 群组的成员资格。之前分配到内置 Looker 群组的所有 OpenID Connect 用户都将在下次登录时从这些群组中移除。

如果此选项处于关闭状态，Looker 管理员可以直接将 OpenID Connect 用户添加到内置 Looker 群组。

禁止从非 OpenID Connect 群组继承角色：启用此选项后，镜像 OpenID Connect 群组的成员将无法从内置 Looker 群组继承角色。之前从父级 Looker 群组继承角色的所有 OpenID Connect 用户在下次登录时都将失去这些角色。

如果此选项处于关闭状态，则镜像 OpenID Connect 群组或作为内置 Looker 群组成员添加的 OpenID Connect 用户将继承分配给父级 Looker 群组的角色。

身份验证需要角色：如果此选项处于开启状态，则 OpenID Connect 用户必须分配有角色。任何未分配角色的 OpenID Connect 用户都将无法登录 Looker。

如果此选项处于关闭状态，OpenID Connect 用户即使未分配角色，也可以向 Looker 进行身份验证。未分配角色的用户将无法在 Looker 中查看任何数据或执行任何操作，但可以登录 Looker。

正在停用镜像 OpenID Connect 群组

如果您想停止在 Looker 中镜像 OpenID Connect 群组，请关闭镜像 OpenID Connect 群组开关。关闭开关会导致以下行为：

  • 任何没有用户的镜像 OpenID Connect 群组都会立即被删除。
  • 任何确实包含用户的镜像 OpenID Connect 群组都会被标记为孤立群组。如果该群组中没有任何用户在 31 天内登录，则该群组将被删除。无法再向孤立的 OpenID Connect 群组添加用户或从中移除用户。

配置迁移选项

如本部分所述，Looker 建议您启用备用登录，并为现有用户提供合并策略。

指定用户的备用登录方式

启用 OpenID Connect 身份验证后，系统会一直为普通用户停用 Looker 邮箱和密码登录。指定用户的备用登录方式选项允许管理员和具有 login_special_email 权限的指定用户使用 /login/email 以基于备用邮箱的方式登录。

备用登录是设置 OpenID Connect 期间的一个后备选项。如果日后出现 OpenID Connect 配置问题，或者您需要支持某些在您的 OpenID Connect 目录中没有账号的用户，此选项会非常有用。

指定将 OpenID Connect 用户合并到 Looker 账号的方法

在合并用户时使用字段中，指定将首次登录的 OpenID Connect 账号合并到现有用户账号时要使用的方法。您可以合并来自以下系统的用户：

  • Looker 邮箱/密码（不适用于 Looker (Google Cloud Core)）
  • Google
  • LDAP（不适用于 Looker (Google Cloud Core)）
  • SAML

如果您有多个身份验证系统，则可以在此字段中指定多个系统进行合并。Looker 将按照指定的顺序从列出的系统中查找用户。例如，假设您使用 Looker 电子邮件地址/密码创建了一些用户，然后启用了 LDAP，现在您想使用 OpenID Connect。在前面的示例中，Looker 会先按邮箱和密码合并，然后再按 LDAP 合并。

当用户首次通过 OpenID Connect 登录时，此选项会查找具有匹配邮箱的账号，以便将该用户连接到其现有账号。如果该用户没有现有账号，系统会为其创建新的用户账号。

如需解决重复账号问题，请从管理界面中删除未使用的重复邮箱账号。如需向用户授予电子邮件访问权限，同时保留其相同的 OpenID Connect 账号，管理员应使用 Looker API 直接在现有 OpenID Connect 账号中创建电子邮件凭据，而不是通过管理界面创建单独的新用户账号。

使用 Looker (Google Cloud Core) 时合并用户

如果您使用的是 Looker (Google Cloud Core) 和 OpenID Connect，则合并方式如上一部分所述。不过，只有在满足以下两个条件之一时，才能执行此操作：

  • 条件 1：用户通过 OpenID Connect 协议使用其 Google Identity 向 Looker (Google Cloud Core) 进行身份验证。

  • 条件 2：在选择合并选项之前，您已完成以下两个步骤：

    1. 使用 Cloud Identity 在 Google Cloud 中联合用户身份。
    2. 使用联合用户将 OAuth 身份验证设置为备用身份验证方法。

如果设置不满足这两个条件之一，则合并用户时使用选项将不可用。

合并时，Looker 会搜索具有完全相同邮箱的用户记录。

测试用户身份验证

指定此配置时，点击测试按钮以测试 OpenID Connect 配置。

测试会将您重定向到端点，并打开一个新的浏览器标签页。该标签页会显示：

  • Looker 是否能够与各个端点通信并进行验证
  • 身份验证端点响应的跟踪记录
  • Looker 从用户信息端点获取的用户信息
  • 收到的 ID 令牌的解码版本和原始版本

您可以使用此测试来验证从各个端点收到的信息是否正确，并排查任何错误。

提示：

  • 您可以随时运行此测试，即使 OpenID Connect 仅部分配置。在配置期间运行测试有助于了解需要配置哪些参数。
  • 该测试会使用在 OpenID Connect 身份验证页面上输入的设置，即使这些设置尚未保存也是如此。测试不会影响或更改该页面上的任何设置。

保存并应用设置

输入完信息且所有测试均通过后，选择我已确认上述配置，希望启用全局应用，然后点击更新设置进行保存。

用户登录行为

当用户尝试使用 OpenID Connect (OIDC) 登录 Looker 实例时，Looker 会打开登录页面。用户必须点击身份验证按钮，才能通过 OIDC 启动身份验证。

与 SAML 身份验证不同，OpenID Connect 身份验证不支持绕过登录页面功能。Looker 管理界面中没有可让 OIDC 用户绕过登录页面的选项，这意味着用户必须手动点击进行身份验证才能开始 OIDC 身份验证流程。

问题排查

如需排查身份验证问题，请查看系统活动中的用户活动信息中心。此信息中心包含多个图块，用于显示最近的登录失败情况，包括所用的身份验证方法、返回的出错提示以及尝试登录的时间。

排查 Looker (Google Cloud Core) 实例上的 OIDC 问题

如果您在 Looker (Google Cloud Core) 实例上配置或测试 OIDC 身份验证时遇到连接或超时问题（例如 504 Upstream Request Timeout 错误、HttpClient:ConnectTimeoutError execution expired 错误、缺少受控出站流量网络路由或误导性重定向 URI 不匹配错误），请参阅排查 Looker (Google Cloud Core) 网络问题。