2018-08-18 02:17:33 -04:00
|
|
|
[role="xpack"]
|
|
|
|
|
[[security-api-enable-user]]
|
|
|
|
|
=== Enable users API
|
2018-12-20 13:23:28 -05:00
|
|
|
++++
|
|
|
|
|
<titleabbrev>Enable users</titleabbrev>
|
|
|
|
|
++++
|
2018-08-18 02:17:33 -04:00
|
|
|
|
|
|
|
|
Enables users in the native realm.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
==== Request
|
|
|
|
|
|
2018-12-11 04:13:10 -05:00
|
|
|
`PUT /_security/user/<username>/_enable`
|
2018-08-18 02:17:33 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
==== Description
|
|
|
|
|
|
|
|
|
|
By default, when you create users, they are enabled. You can use this enable
|
|
|
|
|
users API and the <<security-api-disable-user,disable users API>> to change that attribute.
|
|
|
|
|
|
|
|
|
|
For more information about the native realm, see
|
|
|
|
|
{stack-ov}/realms.html[Realms] and <<configuring-native-realm>>.
|
|
|
|
|
|
|
|
|
|
==== Path Parameters
|
|
|
|
|
|
|
|
|
|
`username` (required)::
|
|
|
|
|
(string) An identifier for the user.
|
|
|
|
|
|
|
|
|
|
//==== Request Body
|
|
|
|
|
|
|
|
|
|
==== Authorization
|
|
|
|
|
|
|
|
|
|
To use this API, you must have at least the `manage_security` cluster privilege.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
==== Examples
|
|
|
|
|
|
|
|
|
|
The following example enables the user `jacknich`:
|
|
|
|
|
|
|
|
|
|
[source,js]
|
|
|
|
|
--------------------------------------------------
|
2018-12-11 04:13:10 -05:00
|
|
|
PUT /_security/user/jacknich/_enable
|
2018-08-18 02:17:33 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
|
// CONSOLE
|
|
|
|
|
// TEST[setup:jacknich_user]
|
