API получения информации о ключах API

GET /_security/api_key

Информацию о ключах API, созданных с помощью API создания ключа API, можно получить с помощью этого API.

В запросе GET можно указать следующие параметры, относящиеся к получению ключей API:

Если вы создаете ключ API следующим образом:

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

Успешный вызов возвращает JSON-структуру, содержащую информацию о ключе API. Например:

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

Вы можете использовать следующий пример для получения ключа API по идентификатору:

GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx

Вы можете использовать следующий пример для получения ключа API по имени:

GET /_security/api_key?name=my-api-key

Имя ключа API поддерживает поиск по префиксу с использованием символов подстановки:

GET /_security/api_key?name=my-*

Следующий пример получает все ключи API для домена native1:

GET /_security/api_key?realm_name=native1

Следующий пример получает все ключи API для пользователя myuser во всех доменах:

GET /_security/api_key?username=myuser

Следующий пример получает все ключи API, принадлежащие текущему аутентифицированному пользователю:

GET /_security/api_key?owner=true

Следующий пример получает все ключи API, если пользователь имеет право на это:

GET /_security/api_key

Следующее создает ключ API:

POST /_security/api_key
{
  "name": "my-api-key-1",
  "metadata": {
    "application": "my-application"
  }
}

Следующий пример получает ключ API, идентифицируемый указанным id, если он принадлежит текущему аутентифицированному пользователю:

GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx&owner=true

Наконец, следующий пример сразу получает все ключи API для пользователя myuser в домене native1:

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

Успешный вызов возвращает JSON-структуру, содержащую информацию об одном или нескольких полученных ключах API.

{
  "api_keys": [ 
    {
      "id": "0GF5GXsBCXxz2eDxWwFN", 
      "name": "hadoop_myuser_key", 
      "creation": 1548550550158, 
      "expiration": 1548551550158, 
      "invalidated": false, 
      "username": "myuser", 
      "realm": "native1", 
      "metadata": { 
        "application": "myapp"
      }
    },
    {
      "id": "6wHJmcQpReKBa42EHV5SBw",
      "name": "api-key-name-2",
      "creation": 1548550550158,
      "invalidated": false,
      "username": "user-y",
      "realm": "realm-2",
      "metadata": {}
    }
  ]
}