Update attributes of an existing API key.
This API supports updates to an API key's access scope, expiration, and metadata.
To use this API, you must have at least the manage_own_api_key cluster privilege.
Users can only update API keys that they created or that were granted to them.
To update another user’s API key, use the run_as feature to submit a request on behalf of another user.
Important
It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.
Use this API to update API keys created by the create API key or grant API Key APIs.
If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.
It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.
The access scope of an 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 the 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.
The role descriptors to assign to this API key.
The 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, you can supply an empty role_descriptors parameter, that is to say, 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 or not.
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.
Values:search_application_query
transient_metadatamapstring to object
metadataobject
Arbitrary metadata that you want to associate with the API key.
It supports a nested data structure.
Within the metadata object, keys beginning with _ are reserved for system usage.
When specified, this value fully replaces the metadata previously associated with the API key.
expirationuniononeOf
The expiration time for the API key.
By default, API keys never expire.
This property can be omitted to leave the expiration unchanged.