Clear the user cache

POST /_security/realm/{realms}/_clear_cache

Evict users from the user cache. You can completely clear the cache or evict specific users.

User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request. There are realm settings that you can use to configure the user cache. For more information, refer to the documentation about controlling the user cache.

About controlling the user cache

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/realm/default_file/_clear_cache

JavaScript Elasticsearch JavaScript Client

const response = await client.security.clearCachedRealms({
  realms: "default_file",
});

Python Elasticsearch Python Client

resp = client.security.clear_cached_realms(
    realms="default_file",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_security/realm/default_file/_clear_cache" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().clearCachedRealms(c -> c
    .realms("default_file")
);

C# Elasticsearch .NET Client

var response = await client.Security.ClearCachedRealmsAsync(realms: new[] { "default_file" });

PHP Elasticsearch PHP Client

$resp = $client->security()->clearCachedRealms([
    "realms" => "default_file",
]);

Ruby Elasticsearch Ruby Client

response = client.security.clear_cached_realms(
  realms: "default_file"
)

Response

No example