87 lines
4.5 KiB
Plaintext
87 lines
4.5 KiB
Plaintext
[[reference-security-query_api_keys]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.queryApiKeys]]
|
|
=== client.security.queryApiKeys
|
|
|
|
Find API keys with a query. Get a paginated list of API keys and their information. You can optionally filter the results with a query.
|
|
|
|
{ref}/security-api-query-api-key.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(SecurityQueryApiKeysRequest, options?): Promise<SecurityQueryApiKeysResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== SecurityQueryApiKeysRequest
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface SecurityQueryApiKeysRequest extends <<RequestBase>> {
|
|
with_limited_by?: boolean
|
|
with_profile_uid?: boolean
|
|
typed_keys?: boolean
|
|
aggregations?: Record<string, SecurityQueryApiKeysApiKeyAggregationContainer>
|
|
pass:[/**] @alias aggregations */
|
|
aggs?: Record<string, SecurityQueryApiKeysApiKeyAggregationContainer>
|
|
query?: SecurityQueryApiKeysApiKeyQueryContainer
|
|
from?: <<integer>>
|
|
sort?: <<Sort>>
|
|
size?: <<integer>>
|
|
search_after?: <<SortResults>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== SecurityQueryApiKeysResponse
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface SecurityQueryApiKeysResponse {
|
|
total: <<integer>>
|
|
count: <<integer>>
|
|
api_keys: <<SecurityApiKey>>[]
|
|
aggregations?: Record<<<AggregateName>>, SecurityQueryApiKeysApiKeyAggregate>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|