ロールマッピング削除API

ロールマッピングを削除します。

リクエスト

DELETE /_security/role_mapping/<name>

前提条件

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

説明

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

ロールマッピングAPIは、ロールマッピングファイルを使用するよりも、ロールマッピングを管理するための一般的に推奨される方法です。削除ロールマッピングAPIは、ロールマッピングファイルに定義されたロールマッピングを削除することはできません。

パスパラメータ

  • name
  • (文字列) ロールマッピングを識別するための固有の名前。この名前は、APIを介した相互作用を容易にするための識別子としてのみ使用され、マッピングの動作には影響しません。

次の例は、ロールマッピングを削除します:

Python

  1. resp = client.security.delete_role_mapping(
  2. name="mapping1",
  3. )
  4. print(resp)

Js

  1. const response = await client.security.deleteRoleMapping({
  2. name: "mapping1",
  3. });
  4. console.log(response);

コンソール

  1. DELETE /_security/role_mapping/mapping1

マッピングが正常に削除されると、リクエストは{"found": true}を返します。そうでない場合、foundはfalseに設定されます。

コンソール-結果

  1. {
  2. "found" : true
  3. }