Clear the user 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.
Path parameters
-
A comma-separated list of realms. To clear all realms, use an asterisk (
*
). It does not support other wildcard patterns.
Query parameters
-
usernames array[string]
A comma-separated list of the users to clear from the cache. If you do not specify this parameter, the API evicts all users from the user cache.
POST
/_security/realm/{realms}/_clear_cache
curl \
--request POST http://api.example.com/_security/realm/{realms}/_clear_cache
Response examples (200)
{
"_nodes": {
"failures": [
{
"type": "string",
"reason": "string",
"stack_trace": "string",
"caused_by": {},
"root_cause": [
{}
],
"suppressed": [
{}
]
}
],
"total": 42.0,
"successful": 42.0,
"failed": 42.0
},
"cluster_name": "string",
"nodes": {
"additionalProperty1": {
"name": "string"
},
"additionalProperty2": {
"name": "string"
}
}
}