mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-01 16:39:11 +00:00
9d16a7b7f0
This change adds support for enable and disable user APIs to the high level rest client. There is a common request base class for both requests with specific requests that simplify the use of these APIs. The response for these APIs is simply an empty object so a new response class has been created for cases where we expect an empty response to be returned. Finally, the put user documentation has been moved to the proper location that is not within an x-pack sub directory and the document tags no longer contain x-pack. See #29827
53 lines
2.1 KiB
Plaintext
53 lines
2.1 KiB
Plaintext
[[java-rest-high-security-put-user]]
|
|
=== Put User API
|
|
|
|
[[java-rest-high-security-put-user-execution]]
|
|
==== Execution
|
|
|
|
Creating and updating a user can be performed using the `security().putUser()`
|
|
method:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/SecurityDocumentationIT.java[put-user-execute]
|
|
--------------------------------------------------
|
|
|
|
[[java-rest-high-security-put-user-response]]
|
|
==== Response
|
|
|
|
The returned `PutUserResponse` contains a single field, `created`. This field
|
|
serves as an indication if a user was created or if an existing entry was updated.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/SecurityDocumentationIT.java[put-user-response]
|
|
--------------------------------------------------
|
|
<1> `created` is a boolean indicating whether the user was created or updated
|
|
|
|
[[java-rest-high-security-put-user-async]]
|
|
==== Asynchronous Execution
|
|
|
|
This request can be executed asynchronously:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/SecurityDocumentationIT.java[put-user-execute-async]
|
|
--------------------------------------------------
|
|
<1> The `PutUserRequest` to execute and the `ActionListener` to use when
|
|
the execution completes.
|
|
|
|
The asynchronous method does not block and returns immediately. Once the request
|
|
has completed the `ActionListener` is called back using the `onResponse` method
|
|
if the execution successfully completed or using the `onFailure` method if
|
|
it failed.
|
|
|
|
A typical listener for a `PutUserResponse` looks like:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/SecurityDocumentationIT.java[put-user-execute-listener]
|
|
--------------------------------------------------
|
|
<1> Called when the execution is successfully completed. The response is
|
|
provided as an argument.
|
|
<2> Called in case of failure. The raised exception is provided as an argument.
|