加载中

用户配置文件

ECE ECK Elastic Cloud 托管

仅限间接使用

用户配置文件功能仅设计用于 Kibana 以及 Elastic 的 Observability 和 Elastic Security 解决方案。个人用户和外部应用程序不应直接调用此 API。Elastic 保留将来发布版本中更改或删除此功能的权利,恕不另行通知。

由于 Elastic Stack 支持外部管理的(例如通过 SAML 身份验证的用户,或存储在 LDAP 目录中的用户),因此用户与其配置文件之间存在区别。

用户是指向 Elastic Stack 请求身份验证的实体。每个用户都有一个用户名和一组特权(由 角色表示),这些角色决定了他们能够发出哪些类型的请求。用户可能是短暂的;它们可能仅存在于向 Elasticsearch API 发送请求期间,或者存在于 Kibana 会话的生命周期内。这些用户在会话结束后无法检索,并且无法在会话之间存储偏好设置。

用户配置文件提供用户的持久且稳定的表示。即使用户离线,用户配置文件也会存在,因此其配置文件会在会话之间持久化。分配给每个配置文件的唯一标识符在部署的整个生命周期中都不会改变,从而提供了一种引用关联用户的稳定方式。每个配置文件都有一个唯一标识符,是可搜索的,并且可以存储用户数据,例如格式和通知偏好设置。

无论用户是否在线,都能唯一地引用用户的能力是支持 Kibana 中个性化和协作等重要功能的基础。这是一项关键功能。

用户配置文件是 Elastic Stack 为每个向 Kibana 进行身份验证的交互式用户存储的持久记录。

当用户登录 Kibana 时,会自动为该用户创建配置文件,或者更新现有配置文件以反映用户的活动会话。通过使用用户配置文件的唯一 ID,Kibana 可以为每个用户单独存储用户级别的数据,例如偏好设置,这是实现精细化自定义的关键。Kibana 使用此唯一 ID 将消息和通知路由到特定用户,无论该用户是否已登录。

您可以在多个领域(realms)为单个用户使用相同的用户名。在 Elasticsearch 中,两个不同的领域可能使用相同的用户名和不同的角色对用户进行身份验证。Elasticsearch 不会假定这些用户是同一个人,默认情况下会将他们视为具有不同用户配置文件的独立个体。

注意

对于一个个人可以针对多个领域进行身份验证的用例,您可以使用 安全域 功能,以便将这些不同的用户视为相同的身份并共享一个用户配置文件。

要创建新的用户配置文件或更新现有用户配置文件,请使用 激活用户配置文件 API。当您提交请求时,Elasticsearch 会尝试查找指定用户的现有配置文件文档。如果不存在,Elasticsearch 会创建一个新的配置文件文档。

在这两种情况下,配置文件文档都会捕获用户的 full_nameemailrolesrealms,还包括配置文件的唯一 ID 和操作时间戳。您可以通过包含配置文件的唯一 ID (uid) 来使用 获取用户配置文件 API 来检索用户配置文件。

除了用户的基本信息外,您还可以使用 更新用户配置文件 API 将数据添加到配置文件文档中。例如,您可以将用户特定的偏好设置作为配置文件数据的一部分添加。

使用 建议用户配置文件 API 来检索符合给定条件的配置文件。此 API 旨在支持用户建议,并与 Kibana 中的功能协同工作。但是,建议用户配置文件 API 无意提供通用搜索 API。

最后,您可以使用 用户配置文件的权限检查 API 来检查多个用户的权限,方法是指定其配置文件的唯一 ID。这可以与建议用户配置文件 API 结合使用,以限制建议仅限于具有必要权限才能在上下文中实际执行操作的用户。

  • 创建新的用户配置文件需要用户的身份验证详细信息(usernamepassword 或其 OAuth2 访问令牌)。这意味着用户必须至少进行一次身份验证才能创建用户配置文件。从未向 Kibana(或其他支持配置文件的应用程序)进行身份验证的用户将没有用户配置文件,并且 建议用户配置文件 API 不会返回这些用户的任何结果。

  • 用户配置文件适用于交互式用户,例如与 Kibana 交互的普通用户。因此,用户配置文件不支持 API 密钥或 服务帐户

    注意

    代表交互式最终用户的 OAuth2 令牌 是支持的。

© . This site is unofficial and not affiliated with Elasticsearch BV.