This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« OpenID Connect logout API Query User API »
Elastic Docs ›Elasticsearch Guide [master] ›REST APIs ›Security APIs

Query API key information API

edit

Query API key information API

edit

Retrieves information for API keys with Query DSL in a paginated fashion.

Request

edit

GET /_security/_query/api_key

POST /_security/_query/api_key

Prerequisites

edit
  • To use this API, you must have at least the manage_own_api_key or the read_security cluster privileges.
  • If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. If you have the read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership.

Description

edit

Use this API to retrieve the API keys created with the create API key API in a paginated manner. You can optionally filter the results with a query.

Path parameters

edit
with_limited_by
(Optional, Boolean) A boolean flag to return the snapshot of the owner user’s role descriptors associated with the API key. An API key’s actual permission is the intersection of its assigned role descriptors and the owner user’s role descriptors (effectively limited by it). An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has manage_api_key or higher privileges.
with_profile_uid
(Optional, boolean) Determines whether to also retrieve the user profile uid, for the API key owner user. If it exists, the profile uid is returned under the profile_uid response field for each API key. Defaults to false.
typed_keys
(Optional, Boolean) If true, aggregation names are prefixed by their respective types in the response. Defaults to false.

Request body

edit

You can specify the following parameters in the request body:

query

(Optional, object) A query to filter which API keys to return. If the query parameter is missing, it is equivalent to a match_all query. The query supports a subset of query types, including match_all, bool, term, terms, match, ids, prefix, wildcard, exists, range, and simple query string.

You can query the following public values associated with an API key.

The queryable string values associated with API keys are internally mapped as keywords. Consequently, if no analyzer parameter is specified for a match query, then the provided match query string is interpreted as a single keyword value. Such a match query is hence equivalent to a term query.

Valid values for query
id
ID of the API key. Note id must be queried with the ids query.
type
API keys can be of type rest, if created via the Create API key or the Grant API key APIs, or of type cross_cluster if created via the Create Cross-Cluster API key API.
name
Name of the API key.
creation
Creation time of the API key in milliseconds.
expiration
Expiration time of the API key in milliseconds. This is null if the key was not configured to expire.
invalidated
Indicates whether the API key is invalidated. If true, the key is invalidated. Defaults to false.
invalidation
Invalidation time of the API key in milliseconds. This field is only set for invalidated API keys.
username
Username of the API key owner.
realm
Realm name of the API key owner.
metadata
Metadata field associated with the API key, such as metadata.my_field. Metadata is internally indexed as a flattened field type. This means that all fields act like keyword fields when querying and sorting. It’s not possible to refer to a subset of metadata fields using wildcard patterns, e.g. metadata.field*, even for query types that support field name patterns. Lastly, all the metadata fields can be searched together when simply mentioning metadata (not followed by any dot and sub-field name).

You cannot query the role descriptors of an API key.

aggs or aggregations
(Optional, object) Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only on the API keys that match the query. This supports only a subset of aggregation types, namely: terms, range, date range, missing, cardinality, value count, composite, filter, and filters. Additionally, aggregations only run over the same subset of fields that query works with.
from

(Optional, integer) Starting document offset. Needs to be non-negative and defaults to 0.

By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

size

(Optional, integer) The number of hits to return. Must not be negative and defaults to 10. The size parameter can be set to 0, in which case no API key matches are returned, only the aggregation results.

By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

sort
(Optional, object) Sort definition. Other than id, all public fields of an API key are eligible for sorting. In addition, sort can also be applied to the _doc field to sort by index order.
search_after
(Optional, array) Search after definition.

Response body

edit

This API returns the following top level fields:

total
The total number of API keys found.
count
The number of API keys returned in the response.
api_keys
A list of API key information.

Examples

edit

The following request lists all API keys, assuming you have the manage_api_key privilege:

resp = client.security.query_api_keys()
print(resp)
const response = await client.security.queryApiKeys();
console.log(response);
GET /_security/_query/api_key

A successful call returns a JSON structure that contains the information retrieved from one or more API keys:

{
  "total": 3,
  "count": 3,
  "api_keys": [ 
    {
      "id": "nkvrGXsB8w290t56q3Rg",
      "name": "my-api-key-1",
      "creation": 1628227480421,
      "expiration": 1629091480421,
      "invalidated": false,
      "username": "elastic",
      "realm": "reserved",
      "realm_type": "reserved",
      "metadata": {
        "letter": "a"
      },
      "role_descriptors": { 
        "role-a": {
          "cluster": [
            "monitor"
          ],
          "indices": [
            {
              "names": [
                "index-a"
              ],
              "privileges": [
                "read"
              ],
              "allow_restricted_indices": false
            }
          ],
          "applications": [ ],
          "run_as": [ ],
          "metadata": { },
          "transient_metadata": {
            "enabled": true
          }
        }
      }
    },
    {
      "id": "oEvrGXsB8w290t5683TI",
      "name": "my-api-key-2",
      "creation": 1628227498953,
      "expiration": 1628313898953,
      "invalidated": false,
      "username": "elastic",
      "realm": "reserved",
      "metadata": {
        "letter": "b"
      },
      "role_descriptors": { } 
    }
  ]
}

The list of API keys that were retrieved for this request

The role descriptors that are assigned to this API key when it was created or last updated. Note the API key’s effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of the owner user’s permissions.

An empty role descriptors means the API key inherits the owner user’s permissions.

If you create an API key with the following details:

resp = client.security.create_api_key(
    name="application-key-1",
    metadata={
        "application": "my-application"
    },
)
print(resp)
const response = await client.security.createApiKey({
  name: "application-key-1",
  metadata: {
    application: "my-application",
  },
});
console.log(response);
POST /_security/api_key
{
  "name": "application-key-1",
  "metadata": { "application": "my-application"}
}

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

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

Use the information from the response to retrieve the API key by ID:

resp = client.security.query_api_keys(
    with_limited_by=True,
    query={
        "ids": {
            "values": [
                "VuaCfGcBCdbkQm-e5aOx"
            ]
        }
    },
)
print(resp)
const response = await client.security.queryApiKeys({
  with_limited_by: "true",
  query: {
    ids: {
      values: ["VuaCfGcBCdbkQm-e5aOx"],
    },
  },
});
console.log(response);
GET /_security/_query/api_key?with_limited_by=true
{
  "query": {
    "ids": {
      "values": [
        "VuaCfGcBCdbkQm-e5aOx"
      ]
    }
  }
}

A successful call returns a JSON structure for API key information including its limited-by role descriptors:

{
  "api_keys": [
    {
      "id": "VuaCfGcBCdbkQm-e5aOx",
      "name": "application-key-1",
      "creation": 1548550550158,
      "expiration": 1548551550158,
      "invalidated": false,
      "username": "myuser",
      "realm": "native1",
      "realm_type": "native",
      "metadata": {
        "application": "my-application"
      },
      "role_descriptors": { },
      "limited_by": [ 
        {
          "role-power-user": {
            "cluster": [
              "monitor"
            ],
            "indices": [
              {
                "names": [
                  "*"
                ],
                "privileges": [
                  "read"
                ],
                "allow_restricted_indices": false
              }
            ],
            "applications": [ ],
            "run_as": [ ],
            "metadata": { },
            "transient_metadata": {
              "enabled": true
            }
          }
        }
      ]
    }
  ]
}

The owner user’s permissions associated with the API key. It is a point-in-time snapshot captured at creation and subsequent updates. An API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.

You can also retrieve the API key by name:

resp = client.security.query_api_keys(
    query={
        "term": {
            "name": {
                "value": "application-key-1"
            }
        }
    },
)
print(resp)
const response = await client.security.queryApiKeys({
  query: {
    term: {
      name: {
        value: "application-key-1",
      },
    },
  },
});
console.log(response);
GET /_security/_query/api_key
{
  "query": {
    "term": {
      "name": {
        "value": "application-key-1"
      }
    }
  }
}

Use a bool query to issue complex logical conditions and use from, size, sort to help paginate the result:

GET /_security/_query/api_key
{
  "query": {
    "bool": {
      "must": [
        {
          "prefix": {
            "name": "app1-key-" 
          }
        },
        {
          "term": {
            "invalidated": "false" 
          }
        }
      ],
      "must_not": [
        {
          "term": {
            "name": "app1-key-01" 
          }
        }
      ],
      "filter": [
        {
          "wildcard": {
            "username": "org-*-user" 
          }
        },
        {
          "term": {
            "metadata.environment": "production" 
          }
        }
      ]
    }
  },
  "from": 20, 
  "size": 10, 
  "sort": [ 
    { "creation": { "order": "desc", "format": "date_time" } },
    "name"
  ]
}

The API key name must begin with app1-key-

The API key must still be valid

The API key name must not be app1-key-01

The API key must be owned by a username of the wildcard pattern org-*-user

The API key must have the metadata field environment that has the value of production

The offset to begin the search result is the 20th (zero-based index) API key

The page size of the response is 10 API keys

The result is first sorted by creation date in descending order, then by name in ascending order

The response contains a list of matched API keys along with their sort values:

{
  "total": 100,
  "count": 10,
  "api_keys": [
    {
      "id": "CLXgVnsBOGkf8IyjcXU7",
      "name": "app1-key-79",
      "creation": 1629250154811,
      "invalidated": false,
      "username": "org-admin-user",
      "realm": "native1",
      "metadata": {
        "environment": "production"
      },
      "role_descriptors": { },
      "_sort": [
        "2021-08-18T01:29:14.811Z",  
        "app1-key-79"  
      ]
    },
    {
      "id": "BrXgVnsBOGkf8IyjbXVB",
      "name": "app1-key-78",
      "creation": 1629250153794,
      "invalidated": false,
      "username": "org-admin-user",
      "realm": "native1",
      "metadata": {
        "environment": "production"
      },
      "role_descriptors": { },
      "_sort": [
        "2021-08-18T01:29:13.794Z",
        "app1-key-78"
      ]
    },
    ...
  ]
}

The first sort value is creation time, which is displayed in date_time format as defined in the request

The second sort value is the API key name

Aggregations Example

edit

For example, given 2 users "june" and "king", each owning 3 API keys:

  • one that never expires (invalidated for user "king")
  • one that expires in 10 days
  • and one that expires in 100 day (invalidated for user "june")

the following request returns the names of valid (not expired and not invalidated) API keys that expire soon (in 30 days time), grouped by owner username.

Request

edit
resp = client.security.query_api_keys(
    size=0,
    query={
        "bool": {
            "must": {
                "term": {
                    "invalidated": False
                }
            },
            "should": [
                {
                    "range": {
                        "expiration": {
                            "gte": "now"
                        }
                    }
                },
                {
                    "bool": {
                        "must_not": {
                            "exists": {
                                "field": "expiration"
                            }
                        }
                    }
                }
            ],
            "minimum_should_match": 1
        }
    },
    aggs={
        "keys_by_username": {
            "composite": {
                "sources": [
                    {
                        "usernames": {
                            "terms": {
                                "field": "username"
                            }
                        }
                    }
                ]
            },
            "aggs": {
                "expires_soon": {
                    "filter": {
                        "range": {
                            "expiration": {
                                "lte": "now+30d/d"
                            }
                        }
                    },
                    "aggs": {
                        "key_names": {
                            "terms": {
                                "field": "name"
                            }
                        }
                    }
                }
            }
        }
    },
)
print(resp)
const response = await client.security.queryApiKeys({
  size: 0,
  query: {
    bool: {
      must: {
        term: {
          invalidated: false,
        },
      },
      should: [
        {
          range: {
            expiration: {
              gte: "now",
            },
          },
        },
        {
          bool: {
            must_not: {
              exists: {
                field: "expiration",
              },
            },
          },
        },
      ],
      minimum_should_match: 1,
    },
  },
  aggs: {
    keys_by_username: {
      composite: {
        sources: [
          {
            usernames: {
              terms: {
                field: "username",
              },
            },
          },
        ],
      },
      aggs: {
        expires_soon: {
          filter: {
            range: {
              expiration: {
                lte: "now+30d/d",
              },
            },
          },
          aggs: {
            key_names: {
              terms: {
                field: "name",
              },
            },
          },
        },
      },
    },
  },
});
console.log(response);
POST /_security/_query/api_key
{
  "size": 0,
  "query": {
    "bool": {
      "must": {
        "term": {
          "invalidated": false  
        }
      },
      "should": [  
        {
          "range": { "expiration": { "gte": "now" } }
        },
        {
          "bool": { "must_not": { "exists": { "field": "expiration" } } }
        }
      ],
      "minimum_should_match": 1
    }
  },
  "aggs": {
    "keys_by_username": {
      "composite": {
        "sources": [ { "usernames": { "terms": { "field": "username" } } } ]  
      },
      "aggs": {
        "expires_soon": {
          "filter": {
            "range": { "expiration": { "lte": "now+30d/d" } }  
          },
          "aggs": {
            "key_names": { "terms": { "field": "name" } }
          }
        }
      }
    }
  }
}

Matching API keys must not be invalidated

Matching API keys must be either not expired or not have an expiration date

Aggregate all matching keys (i.e. all valid keys) by their owner username

Further aggregate the per-username valid keys into a soon-to-expire bucket

Response

edit
{
  "total" : 4,  
  "count" : 0,
  "api_keys" : [ ],
  "aggregations" : {
    "keys_by_username" : {
      "after_key" : {
        "usernames" : "king"
      },
      "buckets" : [
        {
          "key" : {
            "usernames" : "june"
          },
          "doc_count" : 2,  
          "expires_soon" : {
            "doc_count" : 1,
            "key_names" : {
              "doc_count_error_upper_bound" : 0,
              "sum_other_doc_count" : 0,
              "buckets" : [
                {
                  "key" : "june-key-10",
                  "doc_count" : 1
                }
              ]
            }
          }
        },
        {
          "key" : {
            "usernames" : "king"
          },
          "doc_count" : 2,
          "expires_soon" : {
            "doc_count" : 1,  
            "key_names" : {
              "doc_count_error_upper_bound" : 0,
              "sum_other_doc_count" : 0,
              "buckets" : [  
                {
                  "key" : "king-key-10",
                  "doc_count" : 1
                }
              ]
            }
          }
        }
      ]
    }
  }
}

Total number of valid API keys (2 for each user)

Number of valid API keys for user "june"

Number of valid API keys expiring soon for user "king"

The names of soon-to-expire API keys for user "king"

To retrieve the invalidated (but not yet deleted) API keys, grouped by owner username and API key name, issue the following request:

Request

edit
resp = client.security.query_api_keys(
    size=0,
    query={
        "bool": {
            "filter": {
                "term": {
                    "invalidated": True
                }
            }
        }
    },
    aggs={
        "invalidated_keys": {
            "composite": {
                "sources": [
                    {
                        "username": {
                            "terms": {
                                "field": "username"
                            }
                        }
                    },
                    {
                        "key_name": {
                            "terms": {
                                "field": "name"
                            }
                        }
                    }
                ]
            }
        }
    },
)
print(resp)
const response = await client.security.queryApiKeys({
  size: 0,
  query: {
    bool: {
      filter: {
        term: {
          invalidated: true,
        },
      },
    },
  },
  aggs: {
    invalidated_keys: {
      composite: {
        sources: [
          {
            username: {
              terms: {
                field: "username",
              },
            },
          },
          {
            key_name: {
              terms: {
                field: "name",
              },
            },
          },
        ],
      },
    },
  },
});
console.log(response);
POST /_security/_query/api_key
{
  "size": 0,
  "query": {
    "bool": {
      "filter": {
        "term": {
          "invalidated": true
        }
      }
    }
  },
  "aggs": {
    "invalidated_keys": {
      "composite": {
        "sources": [
          { "username": { "terms": { "field": "username" } } },
          { "key_name": { "terms": { "field": "name" } } }
        ]
      }
    }
  }
}

Response

edit
{
  "total" : 2,
  "count" : 0,
  "api_keys" : [ ],
  "aggregations" : {
    "invalidated_keys" : {
      "after_key" : {
        "username" : "king",
        "key_name" : "king-key-no-expire"
      },
      "buckets" : [
        {
          "key" : {
            "username" : "june",
            "key_name" : "june-key-100"
          },
          "doc_count" : 1
        },
        {
          "key" : {
            "username" : "king",
            "key_name" : "king-key-no-expire"
          },
          "doc_count" : 1
        }
      ]
    }
  }
}
« OpenID Connect logout API Query User API »