获取角色映射 API
编辑获取角色映射 API
编辑检索角色映射。
先决条件
编辑- 要使用此 API,您必须至少拥有
read_security
集群权限。
描述
编辑角色映射定义了哪些角色被分配给每个用户。有关更多信息,请参见 将用户和组映射到角色。
通常,角色映射 API 是管理角色映射的首选方式,而不是使用 角色映射文件。获取角色映射 API 无法检索在角色映射文件中定义的角色映射。
路径参数
编辑-
name
- (可选,字符串) 用于标识角色映射的唯一名称。 该名称仅用作标识符,以方便通过 API 进行交互;它不会以任何方式影响映射的行为。您可以将多个映射名称指定为逗号分隔的列表。如果您不指定此参数,则 API 将返回有关所有角色映射的信息。
响应代码
编辑如果没有具有请求名称的映射,则响应的状态代码将为 404
。
示例
编辑以下示例检索有关 mapping1
角色映射的信息
resp = client.security.get_role_mapping( name="mapping1", ) print(resp)
const response = await client.security.getRoleMapping({ name: "mapping1", }); console.log(response);
GET /_security/role_mapping/mapping1
{ "mapping1": { "enabled": true, "roles": [ "user" ], "rules": { "field": { "username": "*" } }, "metadata": {} } }