获取角色 API
编辑获取角色 API编辑
检索本机领域中的角色。
先决条件编辑
- 要使用此 API,您必须至少具有
read_security
集群权限。
路径参数编辑
-
name
- (可选,字符串)角色的名称。您可以将多个角色指定为逗号分隔的列表。如果您未指定此参数,则 API 将返回有关所有角色的信息。
响应正文编辑
成功的调用将返回一个角色数组,其中包含角色的 JSON 表示形式。
响应代码编辑
如果本机领域中未定义角色,则请求将返回 404。
示例编辑
以下示例检索有关本机领域中 my_admin_role
角色的信息
GET /_security/role/my_admin_role
{ "my_admin_role": { "cluster" : [ "all" ], "indices" : [ { "names" : [ "index1", "index2" ], "privileges" : [ "all" ], "allow_restricted_indices" : false, "field_security" : { "grant" : [ "title", "body" ]} } ], "applications" : [ ], "run_as" : [ "other_user" ], "metadata" : { "version" : 1 }, "transient_metadata": { "enabled": true } } }
要检索所有角色,请省略角色名称
GET /_security/role