Files
elasticsearch-js/docs/reference-security-clear_cached_roles.asciidoc
2024-12-05 14:46:46 -06:00

65 lines
4.0 KiB
Plaintext

[[reference-security-clear_cached_roles]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.security.clearCachedRoles
Clear the roles cache. Evict roles from the native role cache.
{ref}/security-api-clear-role-cache.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SecurityClearCachedRolesRequest, options?): Promise<SecurityClearCachedRolesResponse>
----
[discrete]
===== `SecurityClearCachedRolesRequest`
[source,ts]
----
interface SecurityClearCachedRolesRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-names, Names>>
}
----
[discrete]
===== `SecurityClearCachedRolesResponse`
[source,ts]
----
interface SecurityClearCachedRolesResponse {
_nodes: <<shared-type-node-statistics, NodeStatistics>>
cluster_name: <<shared-type-name, Name>>
nodes: Record<string, SecurityClusterNode>
}
----