honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/security/put-user.asciidoc

59 lines
2.1 KiB
Plaintext
Raw Normal View History

HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
--
:api: put-user
:request: PutUserRequest
:response: PutUserResponse
--
[DOCS] Add missing icons to security HLRC APIs (#46619)
2019-09-11 16:19:13 -04:00
[role="xpack"]
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
[id="{upid}-{api}"]
HLRC: add enable and disable user API support (#33481) 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
2018-09-07 13:51:37 -04:00
=== Put User API
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
[id="{upid}-{api}-request"]
==== Put User Request Request
The +{request}+ class is used to create or update a user in the Native Realm.
There are 3 different factory methods for creating a request.
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
===== Create or Update User with a Password
If you wish to create a new user (or update an existing user) and directly specifying the user's new password, use the
`withPassword` method as shown below:
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
include-tagged::{doc-tests-file}[{api}-password-request]
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
--------------------------------------------------
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
===== Create or Update User with a Hashed Password
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
If you wish to create a new user (or update an existing user) and perform password hashing on the client,
then use the `withPasswordHash` method:
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
include-tagged::{doc-tests-file}[{api}-hash-request]
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
--------------------------------------------------
===== Update a User without changing their password
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
If you wish to update an existing user, and do not wish to change the user's password,
then use the `updateUserProperties` method:
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
include-tagged::{doc-tests-file}[{api}-update-request]
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
--------------------------------------------------
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
include::../execution.asciidoc[]
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
[id="{upid}-{api}-response"]
==== Put User 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.
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
include-tagged::{doc-tests}/SecurityDocumentationIT.java[put-user-response]
HLRest: add put user API (#32332) This commit adds a security client to the high level rest client, which includes an implementation for the put user api. As part of these changes, a new request and response class have been added that are specific to the high level rest client. One change here is that the response was previously wrapped inside a user object. The plan is to remove this wrapping and this PR adds an unwrapped response outside of the user object so we can remove the user object later on. See #29827
2018-09-05 12:56:30 -04:00
--------------------------------------------------
HLRC: Add ability to put user with a password hash (#35844) Update PutUserRequest to support password_hash (see: #35242) This also updates the documentation to bring it in line with our more recent approach to HLRC docs.
2018-11-26 23:07:24 -05:00
<1> `created` is a boolean indicating whether the user was created or updated