82 lines
4.2 KiB
Plaintext
82 lines
4.2 KiB
Plaintext
[[reference-security-put_user]]
|
||
|
||
////////
|
||
===========================================================================================================================
|
||
|| ||
|
||
|| ||
|
||
|| ||
|
||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||
|| ||
|
||
|| ||
|
||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
||
|| You should update the script that does the generation, which can be found in: ||
|
||
|| https://github.com/elastic/elastic-client-generator-js ||
|
||
|| ||
|
||
|| You can run the script with the following command: ||
|
||
|| npm run elasticsearch -- --version <version> ||
|
||
|| ||
|
||
|| ||
|
||
|| ||
|
||
===========================================================================================================================
|
||
////////
|
||
|
||
[discrete]
|
||
[[client.security.putUser]]
|
||
=== client.security.putUser
|
||
|
||
Create or update users. A password is required for adding a new user but is optional when updating an existing user. To change a user’s password without updating any other fields, use the change password API.
|
||
|
||
{ref}/security-api-put-user.html[{es} documentation]
|
||
|
||
[discrete]
|
||
==== Function signature
|
||
|
||
[source,ts]
|
||
----
|
||
(SecurityPutUserRequest, options?): Promise<SecurityPutUserResponse>
|
||
----
|
||
|
||
[discrete]
|
||
==== SecurityPutUserRequest
|
||
|
||
[pass]
|
||
++++
|
||
<pre>
|
||
++++
|
||
interface SecurityPutUserRequest extends <<RequestBase>> {
|
||
username: <<Username>>
|
||
refresh?: <<Refresh>>
|
||
email?: string | null
|
||
full_name?: string | null
|
||
metadata?: <<Metadata>>
|
||
password?: <<Password>>
|
||
password_hash?: string
|
||
roles?: string[]
|
||
enabled?: boolean
|
||
}
|
||
|
||
[pass]
|
||
++++
|
||
</pre>
|
||
++++
|
||
[discrete]
|
||
==== SecurityPutUserResponse
|
||
|
||
[pass]
|
||
++++
|
||
<pre>
|
||
++++
|
||
interface SecurityPutUserResponse {
|
||
created: boolean
|
||
}
|
||
|
||
[pass]
|
||
++++
|
||
</pre>
|
||
++++
|