rest-api-spec.api.security.get_api_key.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

Elasticsearch subproject :rest-api-spec

There is a newer version: 8.16.0

{
  "security.get_api_key":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html",
      "description":"Retrieves information for one or more API keys."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"]
    },
    "url":{
      "paths":[
        {
          "path":"/_security/api_key",
          "methods":[
            "GET"
          ]
        }
      ]
    },
    "params":{
      "id":{
        "type":"string",
        "description":"API key id of the API key to be retrieved"
      },
      "name":{
        "type":"string",
        "description":"API key name of the API key to be retrieved"
      },
      "username":{
        "type":"string",
        "description":"user name of the user who created this API key to be retrieved"
      },
      "realm_name":{
        "type":"string",
        "description":"realm name of the user who created this API key to be retrieved"
      },
      "owner":{
        "type":"boolean",
        "default":false,
        "description":"flag to query API keys owned by the currently authenticated user"
      }
    }
  }
}