mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 23:57:20 -04:00
255c9a7f95
**Problem:** For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. **Solution:** - Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory - Update doc snippet tests to use security Rel: https://github.com/elastic/platform-docs-team/issues/208
97 lines
2.7 KiB
Text
97 lines
2.7 KiB
Text
[role="xpack"]
|
|
[[security-api-get-privileges]]
|
|
=== Get application privileges API
|
|
++++
|
|
<titleabbrev>Get application privileges</titleabbrev>
|
|
++++
|
|
|
|
Retrieves <<application-privileges,application privileges>>.
|
|
|
|
[[security-api-get-privileges-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET /_security/privilege` +
|
|
|
|
`GET /_security/privilege/<application>` +
|
|
|
|
`GET /_security/privilege/<application>/<privilege>`
|
|
|
|
|
|
[[security-api-get-privileges-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
To use this API, you must have either:
|
|
|
|
- the `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`); _or_
|
|
- the _"Manage Application Privileges"_ global privilege for the application being referenced
|
|
in the request
|
|
|
|
[[security-api-get-privileges-desc]]
|
|
==== {api-description-title}
|
|
|
|
To check a user's application privileges, use the
|
|
<<security-api-has-privileges,has privileges API>>.
|
|
|
|
|
|
[[security-api-get-privileges-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`application`::
|
|
(Optional, string) The name of the application. Application privileges are
|
|
always associated with exactly one application. If you do not specify this
|
|
parameter, the API returns information about all privileges for all
|
|
applications.
|
|
|
|
`privilege`::
|
|
(Optional, string) The name of the privilege. If you do not specify this
|
|
parameter, the API returns information about all privileges for the requested
|
|
application.
|
|
|
|
|
|
[[security-api-get-privileges-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example retrieves information about the `read` privilege for the
|
|
`app01` application:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_security/privilege/myapp/read
|
|
--------------------------------------------------
|
|
// TEST[setup:app0102_privileges]
|
|
|
|
A successful call returns an object keyed by application name and privilege
|
|
name. If the privilege is not defined, the request responds with a 404 status.
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"myapp": {
|
|
"read": {
|
|
"application": "myapp",
|
|
"name": "read",
|
|
"actions": [
|
|
"data:read/*",
|
|
"action:login"
|
|
],
|
|
"metadata": {
|
|
"description": "Read access to myapp"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
|
|
To retrieve all privileges for an application, omit the privilege name:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_security/privilege/myapp/
|
|
--------------------------------------------------
|
|
|
|
To retrieve every privilege, omit both the application and privilege names:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_security/privilege/
|
|
--------------------------------------------------
|