アプリケーション権限API

アプリケーション権限を取得します。

リクエスト

GET /_security/privilege

GET /_security/privilege/<application>

GET /_security/privilege/<application>/<privilege>

前提条件

このAPIを使用するには、次のいずれかの権限が必要です:

  • read_security クラスター権限(または manage_securityall などのより大きな権限);または
  • リクエストで参照されているアプリケーションの「アプリケーション権限の管理」グローバル権限

説明

ユーザーのアプリケーション権限を確認するには、権限確認APIを使用します。

パスパラメータ

  • application
  • (オプション、文字列)アプリケーションの名前。アプリケーション権限は常に正確に1つのアプリケーションに関連付けられています。このパラメータを指定しない場合、APIはすべてのアプリケーションのすべての権限に関する情報を返します。
  • privilege
  • (オプション、文字列)権限の名前。このパラメータを指定しない場合、APIはリクエストされたアプリケーションのすべての権限に関する情報を返します。

次の例は、read 権限に関する情報を app01 アプリケーションから取得します:

Python

  1. resp = client.security.get_privileges(
  2. application="myapp",
  3. name="read",
  4. )
  5. print(resp)

Js

  1. const response = await client.security.getPrivileges({
  2. application: "myapp",
  3. name: "read",
  4. });
  5. console.log(response);

コンソール

  1. GET /_security/privilege/myapp/read

成功した呼び出しは、アプリケーション名と権限名でキー付けされたオブジェクトを返します。権限が定義されていない場合、リクエストは404ステータスで応答します。

コンソール-結果

  1. {
  2. "myapp": {
  3. "read": {
  4. "application": "myapp",
  5. "name": "read",
  6. "actions": [
  7. "data:read/*",
  8. "action:login"
  9. ],
  10. "metadata": {
  11. "description": "Read access to myapp"
  12. }
  13. }
  14. }
  15. }

アプリケーションのすべての権限を取得するには、権限名を省略します:

Python

  1. resp = client.security.get_privileges(
  2. application="myapp",
  3. )
  4. print(resp)

Js

  1. const response = await client.security.getPrivileges({
  2. application: "myapp",
  3. });
  4. console.log(response);

コンソール

  1. GET /_security/privilege/myapp/

すべての権限を取得するには、アプリケーション名と権限名の両方を省略します:

Python

  1. resp = client.security.get_privileges()
  2. print(resp)

Js

  1. const response = await client.security.getPrivileges();
  2. console.log(response);

コンソール

  1. GET /_security/privilege/