47 lines
1.8 KiB
Plaintext
47 lines
1.8 KiB
Plaintext
[[java-rest-high-security-disable-user]]
|
|
=== Disable User API
|
|
|
|
[[java-rest-high-security-disable-user-execution]]
|
|
==== Execution
|
|
|
|
Disabling a user can be performed using the `security().disableUser()`
|
|
method:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/SecurityDocumentationIT.java[disable-user-execute]
|
|
--------------------------------------------------
|
|
|
|
[[java-rest-high-security-disable-user-response]]
|
|
==== Response
|
|
|
|
The returned `EmptyResponse` does not contain any fields. The return of this
|
|
response indicates a successful request.
|
|
|
|
[[java-rest-high-security-disable-user-async]]
|
|
==== Asynchronous Execution
|
|
|
|
This request can be executed asynchronously:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/SecurityDocumentationIT.java[disable-user-execute-async]
|
|
--------------------------------------------------
|
|
<1> The `DisableUser` request 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 `EmptyResponse` looks like:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/SecurityDocumentationIT.java[disable-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.
|