安全 API

安全插件提供了许多用于管理其资源的REST API。这些API类似于OpenSearch REST API，由包含资源路径、HTTP方法（GET、PUT、POST、DELETE）、请求体和输出响应字段的HTTP请求组成。

所有安全API都使用基本路径_plugins/_security/，后跟每个操作的特定路径。例如，升级执行API的路径将是/_plugins/_security/api/_upgrade_perform。

许多安全API操作可以通过REST API调用和OpenSearch Dashboards设置来使用。本文档重点介绍REST API，它们为程序化访问和自动化提供了最大的灵活性。

API格式

大多数安全API遵循一致的格式

<HTTP-METHOD> _plugins/_security/<PATH>
{
  "request": "body"
}

对于大多数资源类型，API支持标准CRUD操作

• 创建: 使用包含资源定义的请求体进行PUT或POST操作
• 读取: 使用GET检索当前配置
• 更新: 使用包含新配置的请求体进行PUT操作
• 删除: 使用DELETE删除特定资源

身份验证

大多数安全API调用需要使用管理员凭据进行HTTP基本身份验证。请确保在您的请求中包含适当的身份验证头。

以下示例展示了一个基本的HTTP身份验证调用

curl -XGET https://:9200/_plugins/_security/api/roles/ -u admin:admin -k

演示配置

安全插件附带一个默认的演示配置，用于测试目的。此配置不应用于生产环境。对于生产部署，您应该生成安全的凭据和证书。

后续步骤

有关安全插件和安全最佳实践的更多信息，请参阅安全文档。

相关文章

• 身份验证 API
• 配置 API