Update an API key
Generally available; Added in 8.4.0
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.
Required authorization
- Cluster privileges:
manage_own_api_key
Body
-
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_descriptorsparameter, 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 therole_descriptorsparameter or not. The structure of a role descriptor is the same as the request for the create API keys API. -
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. -
The expiration time for the API key. By default, API keys never expire. This property can be omitted to leave the expiration unchanged.
PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx
{
"role_descriptors": {
"role-a": {
"indices": [
{
"names": ["*"],
"privileges": ["write"]
}
]
}
},
"metadata": {
"environment": {
"level": 2,
"trusted": true,
"tags": ["production"]
}
}
}resp = client.security.update_api_key(
id="VuaCfGcBCdbkQm-e5aOx",
role_descriptors={
"role-a": {
"indices": [
{
"names": [
"*"
],
"privileges": [
"write"
]
}
]
}
},
metadata={
"environment": {
"level": 2,
"trusted": True,
"tags": [
"production"
]
}
},
)const response = await client.security.updateApiKey({
id: "VuaCfGcBCdbkQm-e5aOx",
role_descriptors: {
"role-a": {
indices: [
{
names: ["*"],
privileges: ["write"],
},
],
},
},
metadata: {
environment: {
level: 2,
trusted: true,
tags: ["production"],
},
},
});response = client.security.update_api_key(
id: "VuaCfGcBCdbkQm-e5aOx",
body: {
"role_descriptors": {
"role-a": {
"indices": [
{
"names": [
"*"
],
"privileges": [
"write"
]
}
]
}
},
"metadata": {
"environment": {
"level": 2,
"trusted": true,
"tags": [
"production"
]
}
}
}
)$resp = $client->security()->updateApiKey([
"id" => "VuaCfGcBCdbkQm-e5aOx",
"body" => [
"role_descriptors" => [
"role-a" => [
"indices" => array(
[
"names" => array(
"*",
),
"privileges" => array(
"write",
),
],
),
],
],
"metadata" => [
"environment" => [
"level" => 2,
"trusted" => true,
"tags" => array(
"production",
),
],
],
],
]);curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"role_descriptors":{"role-a":{"indices":[{"names":["*"],"privileges":["write"]}]}},"metadata":{"environment":{"level":2,"trusted":true,"tags":["production"]}}}' "$ELASTICSEARCH_URL/_security/api_key/VuaCfGcBCdbkQm-e5aOx"client.security().updateApiKey(u -> u
.id("VuaCfGcBCdbkQm-e5aOx")
.metadata("environment", JsonData.fromJson("{\"level\":2,\"trusted\":true,\"tags\":[\"production\"]}"))
.roleDescriptors("role-a", r -> r
.indices(i -> i
.names("*")
.privileges("write")
)
)
);
{
"role_descriptors": {
"role-a": {
"indices": [
{
"names": ["*"],
"privileges": ["write"]
}
]
}
},
"metadata": {
"environment": {
"level": 2,
"trusted": true,
"tags": ["production"]
}
}
}{
"role_descriptors": {}
}{
"updated": true
}