创建 OIDC 测试配置

版本 4.0.23.6(最新)

创建 OIDC 测试配置。

请求

POST /oidc_test_configs
数据类型
说明
请求
HTTP 请求
body
HTTP 正文
展开 HTTPBody 定义...
body
OIDC 测试配置
展开 OIDCConfig 定义...
可以
对象
当前用户可以对此对象执行的操作
alternate_email_login_allowed
布尔值
允许通过“/login/email”为管理员和具有“login_special_email”权限的指定用户提供备用邮箱登录方式。在 LDAP 设置期间、 LDAP 配置问题之后或当您需要支持 LDAP 目录中的一些用户时,此选项都非常有用。启用 LDAP 后,系统会为常规用户停用 Looker 电子邮件地址/密码登录功能。
受众群体
字符串
OpenID 提供商受众群体
auth_required_role
布尔值
除非在 OIDC 中发现用户的角色设为 true,否则系统将不允许用户登录
授权端点
字符串
OpenID 提供商授权网址
default_new_user_group_ids
字符串 []
default_new_user_groups
default_new_user_role_ids
字符串 []
default_new_user_roles
已启用
布尔值
为服务器启用/停用 OIDC 身份验证
groups_attribute
字符串
用于指明群组的用户记录属性的名称。在“groups_finder_type”设置为“grouped_attribute_values”时使用
groups_with_role_ids
identifier
字符串
依赖方标识符(由 OpenID 提供商提供)
issuer
字符串
OpenID 提供方颁发者
已修改
字符串
上次修改此配置的时间
修改时间
字符串
上次修改此配置的用户的用户 ID
new_user_migration_types
字符串
按电子邮件地址将首次 oidc 登录合并到现有用户帐号。用户首次通过 oidc 登录时,此选项会通过测试现有用户的给定类型的凭据,找到具有匹配的电子邮件地址的帐号,从而将此用户与其现有帐号相关联。否则,系统会为用户创建一个新的用户帐号。此列表(如果提供)必须是以英文逗号分隔的字符串列表,例如“email,ldap,google”
scopes
字符串 []
Secret
字符串
(只写)依赖方密钥(由 OpenID 提供商提供)
set_roles_from_groups
布尔值
根据 OIDC 中的群组在 Looker 中设置用户角色
test_slug
字符串
运行 Slug,以识别为了运行 OIDC 配置测试而创建的配置
token_endpoint
字符串
OpenID 提供方令牌网址
user_attribute_map_email
字符串
用于指明电子邮件地址字段的用户记录属性的名称
user_attribute_map_first_name
字符串
用于表明名字的用户记录属性的名称
user_attribute_map_last_name
字符串
用于指明姓氏的用户记录属性的名称
user_attributes
user_attributes_with_ids
userinfo_endpoint
字符串
OpenID 提供商用户信息网址
allow_normal_group_membership
布尔值
允许 OIDC 身份验证的用户是未反映的 Looker 群组的成员。如果设为“false”,登录的用户将从非反映群组中移除。
allow_roles_from_normal_groups
布尔值
OIDC 身份验证的用户将继承未反映的 Looker 群组的角色。
allow_direct_roles
布尔值
允许将角色直接分配给 OIDC 身份验证用户。
网址
字符串
用于获取此商品的链接

响应

200:OIDC 测试配置

数据类型
说明
(对象)
可以
对象
当前用户可以对此对象执行的操作
alternate_email_login_allowed
布尔值
允许通过“/login/email”为管理员和具有“login_special_email”权限的指定用户提供备用邮箱登录方式。在 LDAP 设置期间、 LDAP 配置问题之后或当您需要支持 LDAP 目录中的一些用户时,此选项都非常有用。启用 LDAP 后,系统会为常规用户停用 Looker 电子邮件地址/密码登录功能。
受众群体
字符串
OpenID 提供商受众群体
auth_required_role
布尔值
除非在 OIDC 中发现用户的角色设为 true,否则系统将不允许用户登录
授权端点
字符串
OpenID 提供商授权网址
default_new_user_group_ids
字符串 []
default_new_user_groups
展开群组定义...
可以
对象
当前用户可以对此对象执行的操作
can_add_to_content_metadata
布尔值
群组可用于内容访问权限控制
包含当前用户
布尔值
当前登录的用户是群组成员
external_group_id [外部群组 ID]
字符串
外部 ID 组(如果嵌入组)
由外部管理
布尔值
群组成员资格由 Looker 外部控制
id
字符串
唯一 ID
include_by_default
布尔值
默认情况下,新用户会添加到此群组
name
字符串
群组名称
用户计数
整数
此群组中包含的用户数量
default_new_user_role_ids
字符串 []
default_new_user_roles
展开角色定义...
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
name
字符串
角色名称
权限集
(只读)权限集
展开 PermissionSet 定义...
可以
对象
当前用户可以对此对象执行的操作
all_access
布尔值
内置
布尔值
id
字符串
唯一 ID
name
字符串
PermissionSet 的名称
权限
字符串 []
网址
字符串
用于获取此商品的链接
permission_set_id [权限集 ID]
字符串
(只写)权限集 ID
模型集
(只读)模型集
展开 ModelSet 定义...
可以
对象
当前用户可以对此对象执行的操作
all_access
布尔值
内置
布尔值
id
字符串
唯一 ID
模型
字符串 []
name
字符串
ModelSet 的名称
网址
字符串
用于获取此商品的链接
模型集 ID
字符串
(只写)模型集 ID
网址
字符串
用于获取此商品的链接
用户网址
字符串
用于获取具有此角色的用户列表的链接
已启用
布尔值
为服务器启用/停用 OIDC 身份验证
展开 OIDCGroupRead 定义...
id
字符串
唯一 ID
Looker_group_id
字符串
Looker 中群组的唯一 ID
Looker_group_name
字符串
Looker 中的群组名称
name
字符串
OIDC 中的群组名称
角色
展开角色定义...
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
name
字符串
角色名称
权限集
(只读)权限集
permission_set_id [权限集 ID]
字符串
(只写)权限集 ID
模型集
(只读)模型集
模型集 ID
字符串
(只写)模型集 ID
网址
字符串
用于获取此商品的链接
用户网址
字符串
用于获取具有此角色的用户列表的链接
groups_attribute
字符串
用于指明群组的用户记录属性的名称。在“groups_finder_type”设置为“grouped_attribute_values”时使用
groups_with_role_ids
展开 OIDCGroupWrite 定义...
id
字符串
唯一 ID
Looker_group_id
字符串
Looker 中群组的唯一 ID
Looker_group_name
字符串
Looker 中的群组名称
name
字符串
OIDC 中的群组名称
角色 ID
字符串 []
identifier
字符串
依赖方标识符(由 OpenID 提供商提供)
issuer
字符串
OpenID 提供方颁发者
已修改
字符串
上次修改此配置的时间
修改时间
字符串
上次修改此配置的用户的用户 ID
new_user_migration_types
字符串
按电子邮件地址将首次 oidc 登录合并到现有用户帐号。用户首次通过 oidc 登录时,此选项会通过测试现有用户的给定类型的凭据,找到具有匹配的电子邮件地址的帐号,从而将此用户与其现有帐号相关联。否则,系统会为用户创建一个新的用户帐号。此列表(如果提供)必须是以英文逗号分隔的字符串列表,例如“email,ldap,google”
scopes
字符串 []
Secret
字符串
(只写)依赖方密钥(由 OpenID 提供商提供)
set_roles_from_groups
布尔值
根据 OIDC 中的群组在 Looker 中设置用户角色
test_slug
字符串
运行 Slug,以识别为了运行 OIDC 配置测试而创建的配置
token_endpoint
字符串
OpenID 提供方令牌网址
user_attribute_map_email
字符串
用于指明电子邮件地址字段的用户记录属性的名称
user_attribute_map_first_name
字符串
用于表明名字的用户记录属性的名称
user_attribute_map_last_name
字符串
用于指明姓氏的用户记录属性的名称
user_attributes
展开 OIDCUserAttributeRead 定义...
name
字符串
OIDC 中用户属性的名称
必填
布尔值
必须在 OIDC 断言中成功登录才能成功
user_attributes
展开 UserAttribute 定义...
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
name
字符串
用户属性的名称
标签
字符串
方便用户使用的用户属性标签
类型
字符串
用户属性类型(“字符串”“数字”“日期时间”“是”“邮政编码”)
default_value
字符串
未设置用户时的默认值
is_system
布尔值
属性是系统默认属性
是永久的
布尔值
该属性是永久性的,无法删除
值已隐藏
布尔值
如果为 true,用户将无法查看此属性的值
用户查看
布尔值
非管理员用户可以查看属性的值,并可以用它们进行过滤
__修改_用户
布尔值
用户可以自行更改此属性的值
隐藏_值_域_白名单
字符串
接收隐藏属性的目的地。一经设置便无法修改。
user_attributes_with_ids
展开 OIDCUserAttributeWrite 定义...
name
字符串
OIDC 中用户属性的名称
必填
布尔值
必须在 OIDC 断言中成功登录才能成功
user_attribute_ids
字符串 []
userinfo_endpoint
字符串
OpenID 提供商用户信息网址
allow_normal_group_membership
布尔值
允许 OIDC 身份验证的用户是未反映的 Looker 群组的成员。如果设为“false”,登录的用户将从非反映群组中移除。
allow_roles_from_normal_groups
布尔值
OIDC 身份验证的用户将继承未反映的 Looker 群组的角色。
allow_direct_roles
布尔值
允许将角色直接分配给 OIDC 身份验证用户。
网址
字符串
用于获取此商品的链接

400:错误请求

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

403:权限遭拒

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

404:未找到

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

422:验证错误

数据类型
说明
(对象)
消息
字符串
错误详情
展开 ValidationErrorDetail 定义...
字段
字符串
出错的字段
代码
字符串
错误代码
消息
字符串
错误信息消息
文档网址
字符串
文档链接
文档网址
字符串
文档链接