搜索用户

版本 4.0.23.6（最新）

搜索用户

返回符合指定搜索条件的所有 ^* 用户记录。

如果指定了多个搜索参数且 filter_or 为 FALSE 或未指定，则搜索参数会在逻辑 AND 运算中合并。系统将仅返回与所有搜索参数条件匹配的行。

如果 filter_or 为 TRUE，系统会将多个搜索参数合并到一个逻辑 OR 运算中。结果将包含与任何搜索条件匹配的行。

字符串搜索参数使用不区分大小写的匹配方式。字符串搜索参数可以包含 % 和“_”，因为 SQL LIKE 模式将匹配通配符表达式。example="dan%" 将与“danger”和“Danzig”匹配，但与“David”不匹配 example="D_m%”将与“Damage”和“dump”匹配

整数搜索参数可以接受单个值，也可以接受逗号分隔值列表。系统会在逻辑 OR 运算下合并多个值，结果会至少与给定值中的一个匹配。

大多数搜索参数可以接受“IS NULL”和“NOT NULL”作为特殊表达式，以匹配或排除相应的列为 null 的行。

布尔值搜索参数仅接受“true”和“false”作为值。

(^*) 始终按调用者可查看的信息级别过滤结果。 Looker 管理员可以查看所有用户详细信息；开放系统中的普通用户可以查看其他用户的名称，但不能查看详细信息；封闭系统中的普通用户只能看到与该用户同属一个群组的其他用户的名称。

请求

获取 /users/search

数据类型

说明

请求

HTTP 请求

查询

HTTPQuery

展开 HTTPQuery 定义...

字段

字符串

响应中仅包含这些字段

page

整数

已弃用。改为使用限制和偏移量。仅返回分页结果的第 N 页

每页

整数

已弃用。改为使用限制和偏移量。每页返回 N 行数据

限制

整数

要返回的结果数。（与偏移值搭配使用，并且优先级高于 page 和 per_page）

offset

整数

在返回任何结果之前要跳过的结果数。（与限制一起使用，优先级高于 page 和 per_page）

排序

字符串

排序依据。

字符串

匹配用户 ID。

first_name（名字）

字符串

匹配名字。

last_name（姓氏）

字符串

匹配姓氏。

经验证的员工

布尔值

搜索与 Looker 员工关联的用户帐号

嵌入用户

布尔值

仅搜索嵌入用户

电子邮件

字符串

使用此电子邮件地址搜索用户

已停用

布尔值

搜索已停用的用户帐号

过滤条件或

布尔值

以布尔值 OR 表达式合并指定的搜索条件

content_metadata_id

字符串

搜索有权访问此 content_metadata 项目的用户

group_id

字符串

搜索属于此群组的直接成员

响应

200：匹配用户。

数据类型

说明

（数组）

用户[]

可以

对象

当前用户可以对此对象执行的操作

头像

字符串

头像图片的网址（可能是通用网址）

头像_网址_大小不调整

字符串

头像图片的网址（可能通用），不指定大小

credentials_api3

CredentialsApi3[]

展开 CredentialsApi3 定义...

可以

对象

当前用户可以对此对象执行的操作

字符串

唯一 ID

client_id

字符串

API 密钥 client_id

创建时间

字符串

此凭据的创建时间戳

已停用

布尔值

此凭据已停用？

类型

字符串

此类凭据类型的简称

网址

字符串

用于获取此商品的链接

credentials_email

CredentialsEmail

电子邮件地址/密码登录凭据

展开 CredentialsEmail 定义...

可以

对象

当前用户可以对此对象执行的操作

创建时间

字符串

此凭据的创建时间戳

电子邮件

字符串

用于用户登录的电子邮件地址

forced_password_reset_at_next_login

布尔值

强制用户在下次登录时更改密码

user_id

字符串

用户的唯一 ID

已停用

布尔值

此凭据已停用？

字符串

最近使用凭据登录的时间戳

密码重置网址

字符串

包含可供用户用来重置密码的密码的一次性密码的网址

帐号设置网址

字符串

包含一次性密文的网址，用户可通过该令牌设置帐号

类型

字符串

此类凭据类型的简称

网址

字符串

用于获取此商品的链接

用户网址

字符串

用于获取此用户的链接

credentials_embed

CredentialsEmbed[]

展开 CredentialsEmbed 定义...

可以

对象

当前用户可以对此对象执行的操作

创建时间

字符串

此凭据的创建时间戳

external_group_id [外部群组 ID]

字符串

最近登录期间添加了该用户的群组的嵌入者 ID

external_user_id

字符串

用户的嵌入器唯一 ID

字符串

唯一 ID

已停用

布尔值

此凭据已停用？

字符串

最近使用凭据登录的时间戳

类型

字符串

此类凭据类型的简称

网址

字符串

用于获取此商品的链接

credentials_google

CredentialsGoogle

Google 身份验证凭据

展开 CredentialsGoogle 定义...

可以

对象

当前用户可以对此对象执行的操作

创建时间

字符串

此凭据的创建时间戳

域

字符串

Google 网域

电子邮件

字符串

电子邮件地址

google_user_id

字符串

该用户的 Google 唯一 ID

已停用

布尔值

此凭据已停用？

字符串

最近使用凭据登录的时间戳

类型

字符串

此类凭据类型的简称

网址

字符串

用于获取此商品的链接

credentials_ldap

CredentialsLDAP

LDAP 凭据

展开 CredentialsLDAP 定义...

可以

对象

当前用户可以对此对象执行的操作

创建时间

字符串

此凭据的创建时间戳

电子邮件

字符串

电子邮件地址

已停用

布尔值

此凭据已停用？

LDAP 目录

字符串

该用户的 LDAP 可分辨名称（截至上次登录）

LDAP ID

字符串

此用户的 LDAP 唯一 ID

字符串

最近使用凭据登录的时间戳

类型

字符串

此类凭据类型的简称

网址

字符串

用于获取此商品的链接

credentials_looker_openid

CredentialsLookerOpenid

LookerOpenID 凭据。供 Looker 分析师登录

展开 CredentialsLookerOpenid 定义...

可以

对象

当前用户可以对此对象执行的操作

创建时间

字符串

此凭据的创建时间戳

电子邮件

字符串

用于用户登录的电子邮件地址

已停用

布尔值

此凭据已停用？

字符串

最近使用凭据登录的时间戳

登录_IP

字符串

客户端的 IP 地址，最近使用凭据登录

类型

字符串

此类凭据类型的简称

网址

字符串

用于获取此商品的链接

用户网址

字符串

用于获取此用户的链接

credentials_oidc

CredentialsOIDC

OpenID Connect 身份验证凭据

展开 CredentialsOIDC 定义...

可以

对象

当前用户可以对此对象执行的操作

创建时间

字符串

此凭据的创建时间戳

电子邮件

字符串

电子邮件地址

已停用

布尔值

此凭据已停用？

字符串

最近使用凭据登录的时间戳

oidc_user_id

字符串

该用户的 OIDC OP 的唯一 ID

类型

字符串

此类凭据类型的简称

网址

字符串

用于获取此商品的链接

credentials_saml

CredentialsSaml

Saml 身份验证凭据

展开 CredentialsSaml 定义...

可以

对象

当前用户可以对此对象执行的操作

创建时间

字符串

此凭据的创建时间戳

电子邮件

字符串

电子邮件地址

已停用

布尔值

此凭据已停用？

字符串

最近使用凭据登录的时间戳

saml_user_id

字符串

该用户的 Saml IdP 唯一 ID

类型

字符串

此类凭据类型的简称

网址

字符串

用于获取此商品的链接

credentials_totp

CredentialsTotp

双重验证凭据

展开 CredentialsTotp 定义...

可以

对象

当前用户可以对此对象执行的操作

创建时间

字符串

此凭据的创建时间戳

已停用

布尔值

此凭据已停用？

类型

字符串

此类凭据类型的简称

已验证

布尔值

用户已通过验证

网址

字符串

用于获取此商品的链接

display_name

字符串

要显示的全名（仅在设置了 first_name 和 last_name 的情况下可用）

电子邮件

字符串

电子邮件地址

embed_group_space_id

字符串

（已弃用）（仅限嵌入）基于嵌入用户登录期间指定的 external_group_id 的用户群组空间的 ID

first_name（名字）

字符串

名字

组 ID

字符串 []

home_folder_id

字符串

用户主文件夹的 ID 字符串

字符串

唯一 ID

已停用

布尔值

帐号已停用

last_name（姓氏）

字符串

姓氏

locale

字符串

用户的首选语言区域。用户语言区域的优先级高于 Looker 系统级默认语言区域。语言区域决定了 API 响应中显示字符串的语言和日期和数字格式。语言区域字符串必须是语言代码（由 2 个字母组成）或语言代码和区域代码的组合（例如“en”或“en-US”）。

Looker_versions

字符串 []

模型_目录验证

布尔值

已检查用户的开发工作区是否存在适用的生产项目

个人文件夹 ID

字符串

用户个人文件夹的 ID

presumed_looker_员工

布尔值

用户被标识为 Looker 的员工

角色 ID

字符串 []

sessions

会话[]

展开会话定义...

可以

对象

当前用户可以对此对象执行的操作

字符串

唯一 ID

ip_address

字符串

此会话启动时用户的 IP 地址

browser

字符串

用户的浏览器类型

operating_system

字符串

用户的操作系统

城市

字符串

用户所在位置的城市部分（衍生自 IP 地址）

state

字符串

用户位置的状态组件（派生自 IP 地址）

country

字符串

用户位置所在的国家/地区（衍生自 IP 地址）

credentials_type

字符串

用于记录此次会话的凭据类型

扩展后

字符串

用户上次延长此会话的时间

扩展计数

整数

此会话的延长次数

sudo_user_id

字符串

此会话中的另一用户代表另一用户的情况下的实际用户

创建时间

字符串

此会话发起的时间

到期_时间

字符串

此会话的到期时间

网址

字符串

用于获取此商品的链接

界面状态

对象

由 Looker 界面拥有的未记录状态信息的用户字典。

经验证的员工

布尔值

用户通过 Looker 公司身份验证并确认为 Looker 的员工

roles_externally_managed

布尔值

用户的角色由外部目录（如 SAML 或 LDAP）管理，无法直接更改。

allow_direct_roles

布尔值

可以直接为用户分配角色。

allow_normal_group_membership

布尔值

用户可以是常规 Looker 群组的直接成员。

allow_roles_from_normal_groups

布尔值

用户可以从常规 Looker 群组继承角色。

embed_group_folder_id

字符串

（仅限嵌入）用户群组文件夹的 ID，基于嵌入用户登录期间指定的 external_group_id

网址

字符串

用于获取此商品的链接

400：错误请求

数据类型

说明

（对象）

错误

消息

字符串

错误详情

文档网址

字符串

文档链接

404：未找到

数据类型

说明

（对象）

错误

消息

字符串

错误详情

文档网址

字符串

文档链接

示例

搜索用户

搜索用户

请求

响应

200：匹配用户。

400：错误请求

404：未找到

示例

Python

TypeScript

Kotlin

Swift