Enable users API

Enable users API

New API reference

For the most up-to-date API details, refer to Security APIs.

Enables users in the native realm.

Request

PUT /_security/user/<username>/_enable

Prerequisites

  • To use this API, you must have at least the manage_security cluster privilege.

Description

By default, when you create users, they are enabled. You can use this enable users API and the disable users API to change that attribute.

For more information about the native realm, see Realms and Native user authentication.

Path parameters

username

(Required, string) An identifier for the user.

Examples

The following example enables the user jacknich:

  1. resp = client.security.enable_user(
  2. username="jacknich",
  3. )
  4. print(resp)
  1. const response = await client.security.enableUser({
  2. username: "jacknich",
  3. });
  4. console.log(response);
  1. PUT /_security/user/jacknich/_enable