Link Search Menu Expand Document Documentation Menu
文档

获取安全配置 API

1.0 版引入

获取安全配置 API 用于检索当前的安全配置。此配置包括认证域和其他安全相关配置。

端点

GET /_plugins/_security/api/securityconfig

请求示例

GET /_plugins/_security/api/securityconfig

示例响应

{
  "config": {
    "dynamic": {
      "authc": {
        "basic_internal_auth_domain": {
          "http_enabled": true,
          "transport_enabled": true,
          "order": 0,
          "http_authenticator": {
            "challenge": true,
            "type": "basic",
            "config": {}
          },
          "authentication_backend": {
            "type": "internal",
            "config": {}
          }
        }
      },
      "authz": {
        "roles_from_myldap": {
          "http_enabled": true,
          "transport_enabled": true,
          "authorization_backend": {
            "type": "ldap",
            "config": {
              "roles_search_filter": "(uniqueMember={0})",
              "host": "ldap.example.com",
              "port": 389
            }
          }
        }
      },
      "multi_rolespan_enabled": true,
      "hosts_resolver_mode": "ip-only",
      "do_not_fail_on_forbidden": false
    }
  }
}

响应正文字段

响应正文是一个包含以下字段的 JSON 对象。

属性 数据类型 描述
config 对象 包含安全配置的根对象。
响应体字段：config

config 是一个包含以下字段的 JSON 对象。

属性 数据类型 描述
dynamic 对象 包含所有安全配置设置的主配置对象。包括认证域 (authc)、授权设置 (authz) 以及各种安全行为。

使用注意事项

获取配置 API 提供了一种检查当前安全配置的方法。使用此 API 时，请记住以下使用注意事项：

  • 只读操作：此 API 仅检索配置，不对其进行修改。

  • 访问控制：此 API 的访问应仅限于管理员，因为配置包含有关您的安全设置的敏感信息。

安全注意事项

安全配置包含有关您的认证机制、LDAP 设置和安全策略的敏感信息。请考虑以下安全最佳实践：

  • 谨慎存储或记录此 API 的输出，因为它可能包含敏感配置详细信息。
  • 与此 API 交互时使用 HTTPS/TLS 以防止信息泄露。

权限

在 plugins.security.restapi.roles_enabled: ["all_access", "security_rest_api_access"] 中定义了角色的任何用户都可以访问此 API。

剩余 350 字符

有问题？。

想贡献？ 或 。