enable-users.asciidoc 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. [role="xpack"]
  2. [[security-api-enable-user]]
  3. === Enable users API
  4. ++++
  5. <titleabbrev>Enable users</titleabbrev>
  6. ++++
  7. Enables users in the native realm.
  8. [[security-api-enable-user-request]]
  9. ==== {api-request-title}
  10. `PUT /_security/user/<username>/_enable`
  11. [[security-api-enable-user-prereqs]]
  12. ==== {api-prereq-title}
  13. * To use this API, you must have at least the `manage_security` cluster privilege.
  14. [[security-api-enable-user-desc]]
  15. ==== {api-description-title}
  16. By default, when you create users, they are enabled. You can use this enable
  17. users API and the <<security-api-disable-user,disable users API>> to change that attribute.
  18. For more information about the native realm, see
  19. <<realms>> and <<native-realm>>.
  20. [[security-api-enable-user-path-params]]
  21. ==== {api-path-parms-title}
  22. `username`::
  23. (Required, string) An identifier for the user.
  24. [[security-api-enable-user-example]]
  25. ==== {api-examples-title}
  26. The following example enables the user `jacknich`:
  27. [source,console]
  28. --------------------------------------------------
  29. PUT /_security/user/jacknich/_enable
  30. --------------------------------------------------
  31. // TEST[setup:jacknich_user]