Disable users Generally available

POST /_security/user/{username}/_disable
Api key auth Basic auth Bearer auth

All methods and paths for this operation:

PUT /_security/user/{username}/_disable

POST /_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

  • Cluster privileges: manage_security

Path parameters

  • username string Required

    An identifier for the user.

Query parameters

  • refresh string

    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 are true, false, or wait_for.

Responses

  • 200 application/json
POST /_security/user/{username}/_disable 
PUT /_security/user/jacknich/_disable

resp = client.security.disable_user(
    username="jacknich",
)
const response = await client.security.disableUser({
  username: "jacknich",
});
response = client.security.disable_user(
  username: "jacknich"
)
$resp = $client->security()->disableUser([
    "username" => "jacknich",
]);
curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_security/user/jacknich/_disable"
client.security().disableUser(d -> d
    .username("jacknich")
);