Invalidate API key API

DELETE /_security/api_key

This API invalidates API keys created by the create API key or grant API key APIs. Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.

The following parameters can be specified in the body of a DELETE request and pertain to invalidating api keys:

A successful call returns a JSON structure that contains the ids of the API keys that were invalidated, the ids of the API keys that had already been invalidated, and potentially a list of errors encountered while invalidating specific api keys.

If you create an API key as follows:

resp = client.security.create_api_key(
    name="my-api-key",
)
print(resp)

const response = await client.security.createApiKey({
  name: "my-api-key",
});
console.log(response);

POST /_security/api_key
{
  "name": "my-api-key"
}

A successful call returns a JSON structure that provides API key information. For example:

{
  "id": "VuaCfGcBCdbkQm-e5aOx",
  "name": "my-api-key",
  "api_key": "ui2lp2axTNmsyakw9tvNnw",
  "encoded": "VnVhQ2ZHY0JDZGJrUW0tZTVhT3g6dWkybHAyYXhUTm1zeWFrdzl0dk5udw=="
}

The following example invalidates the API key identified by specified ids immediately:

resp = client.security.invalidate_api_key(
    ids=[
        "VuaCfGcBCdbkQm-e5aOx"
    ],
)
print(resp)

const response = await client.security.invalidateApiKey({
  ids: ["VuaCfGcBCdbkQm-e5aOx"],
});
console.log(response);

DELETE /_security/api_key
{
  "ids" : [ "VuaCfGcBCdbkQm-e5aOx" ]
}

The following example invalidates the API key identified by specified name immediately:

resp = client.security.invalidate_api_key(
    name="my-api-key",
)
print(resp)

const response = await client.security.invalidateApiKey({
  name: "my-api-key",
});
console.log(response);

DELETE /_security/api_key
{
  "name" : "my-api-key"
}

The following example invalidates all API keys for the native1 realm immediately:

resp = client.security.invalidate_api_key(
    realm_name="native1",
)
print(resp)

const response = await client.security.invalidateApiKey({
  realm_name: "native1",
});
console.log(response);

DELETE /_security/api_key
{
  "realm_name" : "native1"
}

The following example invalidates all API keys for the user myuser in all realms immediately:

resp = client.security.invalidate_api_key(
    username="myuser",
)
print(resp)

const response = await client.security.invalidateApiKey({
  username: "myuser",
});
console.log(response);

DELETE /_security/api_key
{
  "username" : "myuser"
}

The following example invalidates the API key identified by the specified ids if it is owned by the currently authenticated user immediately:

resp = client.security.invalidate_api_key(
    ids=[
        "VuaCfGcBCdbkQm-e5aOx"
    ],
    owner=True,
)
print(resp)

const response = await client.security.invalidateApiKey({
  ids: ["VuaCfGcBCdbkQm-e5aOx"],
  owner: "true",
});
console.log(response);

DELETE /_security/api_key
{
  "ids" : ["VuaCfGcBCdbkQm-e5aOx"],
  "owner" : "true"
}

The following example invalidates all API keys owned by the currently authenticated user immediately:

resp = client.security.invalidate_api_key(
    owner=True,
)
print(resp)

const response = await client.security.invalidateApiKey({
  owner: "true",
});
console.log(response);

DELETE /_security/api_key
{
  "owner" : "true"
}

Finally, the following example invalidates all API keys for the user myuser in the native1 realm immediately:

resp = client.security.invalidate_api_key(
    username="myuser",
    realm_name="native1",
)
print(resp)

const response = await client.security.invalidateApiKey({
  username: "myuser",
  realm_name: "native1",
});
console.log(response);

DELETE /_security/api_key
{
  "username" : "myuser",
  "realm_name" : "native1"
}

{
  "invalidated_api_keys": [ 
    "api-key-id-1"
  ],
  "previously_invalidated_api_keys": [ 
    "api-key-id-2",
    "api-key-id-3"
  ],
  "error_count": 2, 
  "error_details": [ 
    {
      "type": "exception",
      "reason": "error occurred while invalidating api keys",
      "caused_by": {
        "type": "illegal_argument_exception",
        "reason": "invalid api key id"
      }
    },
    {
      "type": "exception",
      "reason": "error occurred while invalidating api keys",
      "caused_by": {
        "type": "illegal_argument_exception",
        "reason": "invalid api key id"
      }
    }
  ]
}