Disable users

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

Auth

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

Cluster privileges manage_security

Path parameters

username string required: An identifier for the user.

Query parameters

refresh enum: If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.; Values: true false wait_for

Response

application/json

Response Type: object

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

{}

Generated from the API spec