› › ›

Enable users API

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:

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

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-enable-user.html