It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.
This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.
It is not possible to update expired or invalidated API keys.
This API supports updates to API key access scope, metadata and expiration.
The access scope of each API key is derived from the role_descriptors you specify in the request and a snapshot of the owner user's permissions at the time of the request.
The snapshot of the owner's permissions is updated automatically on every call.
Important
If you don't specify role_descriptors in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.
A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.
Expiration time for the API keys.
By default, API keys never expire.
This property can be omitted to leave the value unchanged.
Values:-10
idsunionstring | string[]required
The API key identifiers.
metadataobject
Arbitrary nested metadata to associate with the API keys.
Within the metadata object, top-level keys beginning with an underscore (_) are reserved for system usage.
Any information specified with this parameter fully replaces metadata previously associated with the API key.
role_descriptorsmapstring to object
The role descriptors to assign to the API keys.
An API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user.
You can assign new privileges by specifying them in this parameter.
To remove assigned privileges, supply the role_descriptors parameter as an empty object {}.
If an API key has no assigned privileges, it inherits the owner user's full permissions.
The snapshot of the owner's permissions is always updated, whether you supply the role_descriptors parameter.
The structure of a role descriptor is the same as the request for the create API keys API.
<string>object
clusterunionanyOf[]
A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.
A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
templateobject
When you create a role, you can specify a query that defines the document level security permissions. You can optionally
use Mustache templates in the role query to insert the username of the current authenticated user into the role.
Like other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based
templates and define custom parameters. You access the details for the current authenticated user through the _user parameter.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
idstring
The id for a stored script.
paramsmapstring to object
Specifies any named parameters that are passed into the script as variables.
Use parameters instead of hard-coded values to decrease compile time.
langunionanyOf · default: painless
Specifies the language the script is written in.
Supported values include:
painless: Painless scripting language, purpose-built for Elasticsearch.
expression: Lucene’s expressions language, compiles a JavaScript expression to bytecode.
mustache: Mustache templated, used for templates.
java: Expert Java API
Values:painlessexpressionmustachejava
optionsmapstring to string
applicationsobject[]
A list of application privilege entries
applicationstringrequired
The name of the application to which this entry applies.
privilegesstring[]required
A list of strings, where each element is the name of an application privilege or action.
resourcesstring[]required
A list resources to which the privileges are applied.
metadataobject
Optional meta-data. Within the metadata object, keys that begin with _ are reserved for system usage.
run_asstring[]
A list of users that the API keys can impersonate.
NOTE: In Elastic Cloud Serverless, the run-as feature is disabled.
For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected.
Restriction for when the role descriptor is allowed to be effective.
workflowsunionanyOf[]required
A list of workflows to which the API key is restricted.
NOTE: In order to use a role restriction, an API key must be created with a single role descriptor.