管理设置 - 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 页面,请提交支持请求,以便在您的实例上启用 OpenID Connect。

规划时的注意事项

  • 考虑使用指定用户的备用登录方式选项,以便 Looker 管理员无需使用 OpenID Connect 即可访问 Looker。
  • 除非您已设置备用账号登录方式,否则在通过 OpenID Connect 登录 Looker 时,请勿停用 OpenID Connect 身份验证。否则,您可能会被锁定在应用之外。
  • Looker 可以使用来自当前电子邮件地址和密码设置、LDAP、SAML 或 Google Auth 的电子邮件地址将现有账号迁移到 OpenID Connect。您可以在设置过程中配置此功能。
  • Looker 仅支持使用 OpenID Connect 的授权代码流程进行 OpenID Connect 身份验证。不支持其他代码流程。
  • OpenID Connect 规范包含一个可选的发现机制。Looker 不支持此机制,因此您必须在 OpenID Connect 身份验证设置部分中提供明确的网址,如配置 OpenID Connect 身份验证设置中所述。

设置 OpenID Connect

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

  1. 向 OpenID Connect 提供方 (OP) 提供 Looker 网址
  2. 从您的 OP 获取所需信息

在 OP 上设置 Looker

您的 OpenID Connect 提供方 (OP) 将需要 Looker 实例的网址。您的 OP 可能会将其称为重定向 URI登录重定向 URI,也可能会使用其他名称。在 OP 的网站上,向 OP 提供您通常在浏览器中访问 Looker 实例的网址,并在后面添加 /openidconnect。例如 https://instance_name.looker.com/openidconnect

从您的 OP 获取信息

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

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

许多 OP 都以发现文档的形式提供有关配置 OpenID Connect 的信息,让您可以收集配置 Looker 以使用 OpenID Connect 所需的部分或全部信息。如果您无法访问发现文档,则需要从 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 身份验证设置

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

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

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

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

受众群体:用于向您的 OP 指示客户身份的标识符。此值通常与您的标识符值相同,但也可以是不同的值。

Authorization 网址(授权网址):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

Last Name Claim:您的 OP 用于用户姓氏的声明,例如 family_name

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

属性配对

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

如需将声明与相应的 Looker 用户属性配对,请执行以下操作:

  1. 声明字段中输入 OP 标识的声明,然后在 Looker 用户属性字段中输入要与该声明配对的 Looker 用户属性。
  2. 如果您想阻止任何在该声明字段中缺少值的用户账号登录,请选中必需
  3. 点击 +,然后重复上述步骤以添加更多声明和属性对。

请注意,某些 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 群组向用户分配 Looker 角色。当您更改 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 群组开关:

群组声明:输入您的 OP 用于存储群组名称的声明。对于“Groups”声明引入到系统中的每个 OpenID Connect 群组,Looker 都会创建一个 Looker 群组。您可以在 Looker 的管理部分的群组页面上查看这些 Looker 群组。群组可用于设置内容访问权限控制和分配用户属性

首选群组名称 / 角色 / OpenID Connect 群组名称:借助这组字段,您可以分配自定义群组名称以及分配给 Looker 中相应 OpenID Connect 群组的一个或多个角色:

  1. OpenID Connect 群组名称字段中输入 OpenID Connect 群组名称。如果 OpenID Connect 用户包含在 OpenID Connect 群组中,则系统会将该用户添加到 Looker 中的镜像群组。

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

  3. 自定义名称字段右侧的字段中,选择将分配给群组中每个用户的一个或多个 Looker 角色。

  4. 点击 + 可添加其他字段组,以配置其他镜像组。如果您配置了多个群组,并想移除某个群组的配置,请点击该群组的字段集旁边的 X

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

如果您在此页面中删除某个群组,该群组将不再镜像到 Looker 中,并且其成员将不再拥有通过该群组在 Looker 中分配给他们的角色。

对镜像群组所做的任何修改都会在相应群组的用户下次登录 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 登录时,此选项会通过查找电子邮件地址匹配的账号,将用户与其现有账号相关联。如果用户没有现有账号,系统会创建一个新用户账号。

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

如果您使用的是 Looker(Google Cloud 核心)和 OpenID Connect,合并功能将按上一部分所述的方式运行。不过,只有在满足以下两个条件之一时,才能实现此目的:

  • 条件 1:用户通过 OpenID Connect 协议使用其 Google 身份向 Looker (Google Cloud Core) 进行身份验证。
  • 条件 2:在选择合并选项之前,您已完成以下两个步骤:

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

如果设置不满足这两个条件中的任何一个,使用选项将不可用。

合并时,Looker 会搜索电子邮件地址完全相同的用户记录。

测试用户身份验证

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

测试将重定向到端点,并打开新的浏览器标签页。相应标签页会显示:

  • Looker 是否能够与各种端点通信并验证
  • 身份验证端点响应的轨迹
  • Looker 从用户信息端点获取的用户信息
  • 收到的 ID 令牌的解码版本和原始版本

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

提示

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

保存并应用设置

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