stack es security update-cross-cluster-api-key cli command

elastic stack es security update-cross-cluster-api-key \
  --id <id> \
  --access <access> \
  [options]
		

Update a cross-cluster API key.

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--id string required

The ID of the cross-cluster API key to update.

--access string required

The access to be granted to this API key. The access is composed of permissions for cross cluster search and cross cluster replication. At least one of them must be specified. When specified, the new access assignment fully replaces the previously assigned access.

--expiration string

The expiration time for the API key. By default, API keys never expire. This property can be omitted to leave the value unchanged.

--metadata string

Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage. When specified, this information fully replaces metadata previously associated with the API key.

--certificate-identity string

The certificate identity to associate with this API key. This field is used to restrict the API key to connections authenticated by a specific TLS certificate. The value should match the certificate's distinguished name (DN) pattern. When specified, this fully replaces any previously assigned certificate identity. To clear an existing certificate identity, explicitly set this field to null. When omitted, the existing certificate identity remains unchanged.

--input-file string

path to a JSON file to use as command input

--[no-]dry-run

validate all inputs and exit without performing any action (preview changes without applying them)

--[no-]json

output as JSON