mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 23:57:20 -04:00
255c9a7f95
**Problem:** For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. **Solution:** - Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory - Update doc snippet tests to use security Rel: https://github.com/elastic/platform-docs-team/issues/208
78 lines
2.3 KiB
Text
78 lines
2.3 KiB
Text
[role="xpack"]
|
|
[[security-api-clear-cache]]
|
|
=== Clear cache API
|
|
++++
|
|
<titleabbrev>Clear cache</titleabbrev>
|
|
++++
|
|
|
|
Evicts users from the user cache. You can completely clear
|
|
the cache or evict specific users.
|
|
|
|
[[security-api-clear-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST /_security/realm/<realms>/_clear_cache` +
|
|
|
|
`POST /_security/realm/<realms>/_clear_cache?usernames=<usernames>`
|
|
|
|
|
|
[[security-api-clear-desc]]
|
|
==== {api-description-title}
|
|
|
|
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, see
|
|
<<controlling-user-cache>>.
|
|
|
|
To evict roles from the role cache, see the
|
|
<<security-api-clear-role-cache,Clear roles cache API>>.
|
|
To evict privileges from the privilege cache, see the
|
|
<<security-api-clear-privilege-cache,Clear privileges cache API>>.
|
|
To evict API keys from the API key cache, see the
|
|
<<security-api-clear-api-key-cache,Clear API key cache API>>.
|
|
|
|
[[security-api-clear-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<realms>`::
|
|
(Required, string)
|
|
Comma-separated list of realms to clear. To clear all realms, use `*`. Does not
|
|
support other wildcard patterns.
|
|
|
|
`usernames`::
|
|
(Optional, list) 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.
|
|
|
|
[[security-api-clear-example]]
|
|
==== {api-examples-title}
|
|
|
|
For example, to evict all users cached by the `file` realm:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST /_security/realm/default_file/_clear_cache
|
|
--------------------------------------------------
|
|
|
|
To evict selected users, specify the `usernames` parameter:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST /_security/realm/default_file/_clear_cache?usernames=rdeniro,alpacino
|
|
--------------------------------------------------
|
|
|
|
To clear the caches for multiple realms, specify the realms as a comma-delimited
|
|
list:
|
|
|
|
[source,console]
|
|
------------------------------------------------------------
|
|
POST /_security/realm/default_file,ldap1/_clear_cache
|
|
------------------------------------------------------------
|
|
|
|
To clear the caches for all realms, use `*`.
|
|
|
|
[source,console]
|
|
----
|
|
POST /_security/realm/*/_clear_cache
|
|
----
|