Disable users

POST also PUT /_security/user/{username}/_disable

Disable users in the native realm. By default, when you create users, they are enabled. You can use this API to revoke a user's access to Elasticsearch.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_security/user/jacknich/_disable

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.security.disable_user(
    username="jacknich",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_security/user/jacknich/_disable" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().disableUser(d -> d
    .username("jacknich")
);

C# Elasticsearch .NET Client

var response = await client.Security.DisableUserAsync(username: "jacknich");

PHP Elasticsearch PHP Client

$resp = $client->security()->disableUser([
    "username" => "jacknich",
]);

Ruby Elasticsearch Ruby Client

response = client.security.disable_user(
  username: "jacknich"
)

Response

No example