IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Enable users API

edit

Enable users API

edit

Enables users in the native realm.

Request

edit

PUT /_security/user/<username>/_enable

Prerequisites

edit

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

Description

edit

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

edit

username: (Required, string) An identifier for the user.

Examples

edit

The following example enables the user jacknich:

resp = client.security.enable_user(
    username="jacknich",
)
print(resp)

const response = await client.security.enableUser({
  username: "jacknich",
});
console.log(response);

PUT /_security/user/jacknich/_enable

« Disable users API Enroll Kibana API »