mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 13:08:29 +00:00
32c4f99238
This commit adds support for API to create or update application privileges in high-level rest client.
40 lines
1.3 KiB
Plaintext
40 lines
1.3 KiB
Plaintext
--
|
|
:api: put-privileges
|
|
:request: PutPrivilegesRequest
|
|
:response: PutPrivilegesResponse
|
|
--
|
|
|
|
[id="{upid}-{api}"]
|
|
=== Put Privileges API
|
|
|
|
Application privileges can be created or updated using this API.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Put Privileges Request
|
|
A +{request}+ contains list of application privileges that
|
|
need to be created or updated. Each application privilege
|
|
consists of an application name, application privilege,
|
|
set of actions and optional metadata.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Put Privileges Response
|
|
|
|
The returned +{response}+ contains the information about the status
|
|
for each privilege present in the +{request}+. The status would be
|
|
`true` if the privilege was created, `false` if the privilege was updated.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> The response contains the status for given application name and
|
|
privilege name. The status would be `true` if the privilege was created,
|
|
`false` if the privilege was updated.
|