Get API key information

GET /_security/api_key

Retrieves information for one or more API keys. NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership.

Required authorization

Cluster privileges: manage_own_api_key,read_security

Query Parameters

id string Id: An API key id. This parameter cannot be used with any of name, realm_name or username.
name string Name: An API key name. This parameter cannot be used with any of id, realm_name or username. It supports prefix search with wildcard.
owner boolean · default: false: A boolean flag that can be used to query API keys owned by the currently authenticated user. The realm_name or username parameters cannot be specified when this parameter is set to true as they are assumed to be the currently authenticated ones.
realm_name string Name: The name of an authentication realm. This parameter cannot be used with either id or name or when owner flag is set to true.
username string: The username of a user. This parameter cannot be used with either id or name or when owner flag is set to true.
with_limited_by boolean · default: false: 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.
active_only boolean · default: false: A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as owner or name. If active_only is false, the response will include both active and inactive (expired or invalidated) keys.
with_profile_uid boolean · default: false: Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.

Response

application/json

Examples

A successful response from GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx&with_limited_by=true.

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_security/api_key?username=myuser&realm_name=native1

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_security/api_key?username=myuser&realm_name=native1" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().getApiKey(g -> g
    .realmName("native1")
    .username("myuser")
);

C# Elasticsearch .NET Client

var response = await client.Security
    .GetApiKeyAsync(d1 => d1
        .RealmName("native1")
        .Username("myuser")
    );

PHP Elasticsearch PHP Client

$resp = $client->security()->getApiKey([
    "username" => "myuser",
    "realm_name" => "native1",
]);

Ruby Elasticsearch Ruby Client

response = client.security.get_api_key(
  username: "myuser",
  realm_name: "native1"
)

Response

{
  "api_keys": [ 
    {
      "id": "VuaCfGcBCdbkQm-e5aOx", 
      "name": "my-api-key", 
      "creation": 1548550550158, 
      "expiration": 1548551550158, 
      "invalidated": false, 
      "username": "myuser", 
      "realm": "native1", 
      "realm_type": "native",
      "metadata": { 
        "application": "myapp"
      },
      "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
            }
          }
        }
      ]
    }
  ]
}

Required authorization

Query Parameters { id , name , owner , realm_name , username , with_limited_by , active_only , with_profile_uid , }

Response

Query Parameters