用户配置
编辑用户配置
编辑用户配置功能仅供 Kibana 和 Elastic 的可观测性、企业搜索和 Elastic 安全解决方案使用。个人用户和外部应用程序不应直接调用此 API。Elastic 保留将来在不事先通知的情况下更改或删除此功能的权利。
由于 Elastic Stack 支持外部管理的用户(例如通过 SAML 身份验证的用户或存储在 LDAP 目录中的用户),因此在用户和他们的配置之间存在区别。
用户指的是对 Elastic Stack 的请求进行身份验证的实体。每个用户都有一个用户名和一组权限(由角色表示),这些权限决定了他们可以发出哪些类型的请求。用户可以是临时的;它们可能仅在对 Elasticsearch API 的请求期间或在 Kibana 中会话的生命周期内存在。这些用户在会话结束后无法检索,也无法跨会话存储偏好设置。
用户配置 提供用户的持久和稳定的表示。即使用户处于离线状态,用户配置也存在,因此他们的配置会跨会话持久存在。分配给每个配置的唯一标识符在部署的整个生命周期中不会更改,从而提供了一种引用关联用户的稳定方式。每个配置都有一个唯一的标识符,可以搜索,并且可以存储用户数据,例如格式和通知首选项。
无论用户是否在线,都能够唯一地引用用户的功能是一项关键功能,它支撑了 Kibana 中个性化和协作等重要功能。
Kibana 中的用户配置
编辑用户配置是 Elastic Stack 为每个向 Kibana 进行身份验证的交互用户存储的持久记录。
当用户登录 Kibana 时,会自动为该用户创建一个配置,或者更新现有配置以反映用户的活动会话。通过使用用户配置的唯一 ID,Kibana 可以为每个用户单独存储用户级数据(例如首选项),这对于精细的自定义级别至关重要。Kibana 使用此唯一 ID 将消息和通知路由到不同的用户,无论他们是否已登录。
创建和管理用户配置
编辑要创建新的用户配置或更新现有的用户配置,请使用激活用户配置 API。当您提交请求时,Elasticsearch 会尝试查找指定用户的现有配置文档。如果不存在,Elasticsearch 会创建一个新的配置文档。
在任何一种情况下,配置文档都会捕获用户的 full_name
、email
、roles
和 realms
,还包括配置的唯一 ID 和操作时间戳。您可以使用获取用户配置 API,通过包含配置的唯一 ID (uid
) 来检索用户配置。
除了用户的基本信息外,您还可以使用更新用户配置 API 将数据添加到配置文档。例如,您可以将用户特定的首选项添加为配置数据的一部分。
使用建议用户配置 API 来检索与给定条件匹配的配置。此 API 旨在支持用户建议,并与 Kibana 中找到的功能(如那些功能)协同工作。但是,建议用户配置 API 不打算提供通用的搜索 API。
最后,您可以使用用户配置的具有权限 API,通过指定其配置的唯一 ID 来检查多个用户的权限。这可以与建议用户配置 API 结合使用,以便将建议限制为仅限具有在上下文中实际执行操作所需权限的用户。
限制
编辑- 创建新的用户配置需要用户的身份验证详细信息(
username
和password
或其OAuth2 访问令牌)。这意味着用户必须至少进行一次身份验证才能创建用户配置。从未向 Kibana(或其他支持配置的应用程序)进行身份验证的用户将没有用户配置,并且建议用户配置 API 不会返回这些用户的任何结果。 -
用户配置适用于交互用户,例如与 Kibana 交互的人类用户。因此,用户配置不支持 API 密钥或服务帐户。
支持表示交互式最终用户的OAuth2 令牌。