アプリケーション権限API
アプリケーション権限を取得します。
リクエスト
GET /_security/privilege
GET /_security/privilege/<application>
GET /_security/privilege/<application>/<privilege>
前提条件
このAPIを使用するには、次のいずれかの権限が必要です:
read_security
クラスター権限(またはmanage_security
やall
などのより大きな権限);または- リクエストで参照されているアプリケーションの「アプリケーション権限の管理」グローバル権限
説明
ユーザーのアプリケーション権限を確認するには、権限確認APIを使用します。
パスパラメータ
application
- (オプション、文字列)アプリケーションの名前。アプリケーション権限は常に正確に1つのアプリケーションに関連付けられています。このパラメータを指定しない場合、APIはすべてのアプリケーションのすべての権限に関する情報を返します。
privilege
- (オプション、文字列)権限の名前。このパラメータを指定しない場合、APIはリクエストされたアプリケーションのすべての権限に関する情報を返します。
例
次の例は、read
権限に関する情報を app01
アプリケーションから取得します:
Python
resp = client.security.get_privileges(
application="myapp",
name="read",
)
print(resp)
Js
const response = await client.security.getPrivileges({
application: "myapp",
name: "read",
});
console.log(response);
コンソール
GET /_security/privilege/myapp/read
成功した呼び出しは、アプリケーション名と権限名でキー付けされたオブジェクトを返します。権限が定義されていない場合、リクエストは404ステータスで応答します。
コンソール-結果
{
"myapp": {
"read": {
"application": "myapp",
"name": "read",
"actions": [
"data:read/*",
"action:login"
],
"metadata": {
"description": "Read access to myapp"
}
}
}
}
アプリケーションのすべての権限を取得するには、権限名を省略します:
Python
resp = client.security.get_privileges(
application="myapp",
)
print(resp)
Js
const response = await client.security.getPrivileges({
application: "myapp",
});
console.log(response);
コンソール
GET /_security/privilege/myapp/
すべての権限を取得するには、アプリケーション名と権限名の両方を省略します:
Python
resp = client.security.get_privileges()
print(resp)
Js
const response = await client.security.getPrivileges();
console.log(response);
コンソール
GET /_security/privilege/