ロールマッピングの取得（Get role mappings）

役割マッピングAPI

役割マッピングを取得します。

リクエスト

GET /_security/role_mapping

GET /_security/role_mapping/<name>

前提条件

• このAPIを使用するには、少なくともread_securityクラスター特権を持っている必要があります。

説明

役割マッピングは、各ユーザーに割り当てられる役割を定義します。詳細については、ユーザーとグループを役割にマッピングするを参照してください。

役割マッピングAPIは、役割マッピングファイルを使用するよりも、役割マッピングを管理するための一般的に推奨される方法です。役割マッピングファイルで定義された役割マッピングは、get役割マッピングAPIでは取得できません。

パスパラメータ

• name
• （オプション、文字列）役割マッピングを識別するための固有の名前。この名前は、APIを介した相互作用を容易にするための識別子としてのみ使用され、マッピングの動作には影響しません。カンマ区切りのリストとして複数のマッピング名を指定できます。このパラメータを指定しない場合、APIはすべての役割マッピングに関する情報を返します。

レスポンスボディ

成功した呼び出しは、リクエストマッピングの名前がキーで、これらのマッピングのJSON表現が値であるオブジェクトを取得します。詳細については、役割マッピングリソースを参照してください。

レスポンスコード

リクエストされた名前のマッピングが存在しない場合、レスポンスはステータスコード404を持ちます。

例

次の例は、mapping1役割マッピングに関する情報を取得します:

Python

resp = client.security.get_role_mapping(
   name="mapping1",
)
print(resp)

Js

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": {}
  }
}