Files
elasticsearch-js/docs/reference-security-change_password.asciidoc
2024-12-05 14:46:52 -06:00

76 lines
4.0 KiB
Plaintext

[[reference-security-change_password]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.changePassword]]
=== client.security.changePassword
Change passwords. Change the passwords of users in the native realm and built-in users.
{ref}/security-api-change-password.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SecurityChangePasswordRequest, options?): Promise<SecurityChangePasswordResponse>
----
[discrete]
==== SecurityChangePasswordRequest
[pass]
++++
<pre>
++++
interface SecurityChangePasswordRequest extends <<RequestBase>> {
username?: <<Username>>
refresh?: <<Refresh>>
password?: <<Password>>
password_hash?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== SecurityChangePasswordResponse
[pass]
++++
<pre>
++++
interface SecurityChangePasswordResponse {
}
[pass]
++++
</pre>
++++