82 lines
4.9 KiB
Plaintext
82 lines
4.9 KiB
Plaintext
[[reference-security-invalidate_api_key]]
|
||
|
||
////////
|
||
===========================================================================================================================
|
||
|| ||
|
||
|| ||
|
||
|| ||
|
||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||
|| ||
|
||
|| ||
|
||
|| 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.invalidateApiKey]]
|
||
=== client.security.invalidateApiKey
|
||
|
||
Invalidate API keys. This API invalidates API keys created by the create API key or grant API key APIs. Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. The `manage_api_key` privilege allows deleting any API keys. The `manage_own_api_key` only allows deleting API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user’s identity. - Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.
|
||
|
||
{ref}/security-api-invalidate-api-key.html[{es} documentation]
|
||
|
||
[discrete]
|
||
==== Function signature
|
||
|
||
[source,ts]
|
||
----
|
||
(SecurityInvalidateApiKeyRequest, options?): Promise<SecurityInvalidateApiKeyResponse>
|
||
----
|
||
|
||
[discrete]
|
||
==== Request
|
||
|
||
[pass]
|
||
++++
|
||
<pre>
|
||
++++
|
||
interface SecurityInvalidateApiKeyRequest extends <<RequestBase>> {
|
||
id?: <<Id>>
|
||
ids?: <<Id>>[]
|
||
name?: <<Name>>
|
||
owner?: boolean
|
||
realm_name?: string
|
||
username?: <<Username>>
|
||
}
|
||
|
||
[pass]
|
||
++++
|
||
</pre>
|
||
++++
|
||
[discrete]
|
||
==== Response
|
||
|
||
[pass]
|
||
++++
|
||
<pre>
|
||
++++
|
||
interface SecurityInvalidateApiKeyResponse {
|
||
error_count: <<integer>>
|
||
error_details?: <<ErrorCause>>[]
|
||
invalidated_api_keys: string[]
|
||
previously_invalidated_api_keys: string[]
|
||
}
|
||
|
||
[pass]
|
||
++++
|
||
</pre>
|
||
++++
|