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

66 lines
4.2 KiB
Plaintext

[[reference-security-update_cross_cluster_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.updateCrossClusterApiKey
Update a cross-cluster API key. Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.
{ref}/security-api-update-cross-cluster-api-key.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SecurityUpdateCrossClusterApiKeyRequest, options?): Promise<SecurityUpdateCrossClusterApiKeyResponse>
----
[discrete]
===== `SecurityUpdateCrossClusterApiKeyRequest`
[source,ts]
----
interface SecurityUpdateCrossClusterApiKeyRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
access: SecurityAccess
expiration?: <<shared-type-duration, Duration>>
metadata?: <<shared-type-metadata, Metadata>>
}
----
[discrete]
===== `SecurityUpdateCrossClusterApiKeyResponse`
[source,ts]
----
interface SecurityUpdateCrossClusterApiKeyResponse {
updated: boolean
}
----