API обновления ключа API

PUT /_security/api_key/<id>

Используйте этот API для обновления ключей API, созданных API создания ключа API или предоставления ключа API. Если вам нужно применить одно и то же обновление к многим ключам API, вы можете использовать массовое обновление ключей API, чтобы уменьшить нагрузку.

Невозможно обновить истекшие ключи API или ключи API, которые были аннулированы с помощью API аннулирования ключа API.

Этот API поддерживает обновления области доступа ключа API, метаданных и срока действия. Область доступа ключа API определяется из role_descriptors, указанного в запросе, и моментальной фотографии разрешений пользователя-владельца на момент запроса. Моментальная фотография разрешений владельца обновляется автоматически при каждом вызове.

В теле запроса, которое является необязательным, можно указать следующие параметры.

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

resp = client.security.create_api_key(
    name="my-api-key",
    role_descriptors={
        "role-a": {
            "cluster": [
                "all"
            ],
            "indices": [
                {
                    "names": [
                        "index-a*"
                    ],
                    "privileges": [
                        "read"
                    ]
                }
            ]
        }
    },
    metadata={
        "application": "my-application",
        "environment": {
            "level": 1,
            "trusted": True,
            "tags": [
                "dev",
                "staging"
            ]
        }
    },
)
print(resp)

const response = await client.security.createApiKey({
  name: "my-api-key",
  role_descriptors: {
    "role-a": {
      cluster: ["all"],
      indices: [
        {
          names: ["index-a*"],
          privileges: ["read"],
        },
      ],
    },
  },
  metadata: {
    application: "my-application",
    environment: {
      level: 1,
      trusted: true,
      tags: ["dev", "staging"],
    },
  },
});
console.log(response);

POST /_security/api_key
{
  "name": "my-api-key",
  "role_descriptors": {
    "role-a": {
      "cluster": ["all"],
      "indices": [
        {
          "names": ["index-a*"],
          "privileges": ["read"]
        }
      ]
    }
  },
  "metadata": {
    "application": "my-application",
    "environment": {
       "level": 1,
       "trusted": true,
       "tags": ["dev", "staging"]
    }
  }
}

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

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

Для примеров ниже предположим, что разрешения пользователя-владельца:

{
  "cluster": ["all"],
  "indices": [
    {
      "names": ["*"],
      "privileges": ["all"]
    }
  ]
}

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

resp = client.security.update_api_key(
    id="VuaCfGcBCdbkQm-e5aOx",
    role_descriptors={
        "role-a": {
            "indices": [
                {
                    "names": [
                        "*"
                    ],
                    "privileges": [
                        "write"
                    ]
                }
            ]
        }
    },
    metadata={
        "environment": {
            "level": 2,
            "trusted": True,
            "tags": [
                "production"
            ]
        }
    },
)
print(resp)

const response = await client.security.updateApiKey({
  id: "VuaCfGcBCdbkQm-e5aOx",
  role_descriptors: {
    "role-a": {
      indices: [
        {
          names: ["*"],
          privileges: ["write"],
        },
      ],
    },
  },
  metadata: {
    environment: {
      level: 2,
      trusted: true,
      tags: ["production"],
    },
  },
});
console.log(response);

PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx
{
  "role_descriptors": {
    "role-a": {
      "indices": [
        {
          "names": ["*"],
          "privileges": ["write"]
        }
      ]
    }
  },
  "metadata": {
    "environment": {
       "level": 2,
       "trusted": true,
       "tags": ["production"]
    }
  }
}

Успешный вызов возвращает JSON-структуру, указывающую, что ключ API был обновлён:

{
  "updated": true
}

Эффективные разрешения ключа API после обновления будут пересечением предоставленных описателей ролей и разрешений пользователя-владельца:

{
  "indices": [
    {
      "names": ["*"],
      "privileges": ["write"]
    }
  ]
}

Следующий пример удаляет ранее назначенные разрешения ключа API, заставляя его унаследовать полные разрешения пользователя-владельца.

resp = client.security.update_api_key(
    id="VuaCfGcBCdbkQm-e5aOx",
    role_descriptors={},
)
print(resp)

const response = await client.security.updateApiKey({
  id: "VuaCfGcBCdbkQm-e5aOx",
  role_descriptors: {},
});
console.log(response);

PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx
{
  "role_descriptors": {}
}

Что возвращает ответ:

{
  "updated": true
}

Эффективные разрешения ключа API после обновления будут такими же, как у пользователя-владельца:

{
  "cluster": ["all"],
  "indices": [
    {
      "names": ["*"],
      "privileges": ["all"]
    }
  ]
}

Для следующего примера предположим, что разрешения пользователя-владельца изменились с исходных разрешений на:

{
  "cluster": ["manage_security"],
  "indices": [
    {
      "names": ["*"],
      "privileges": ["read"]
    }
  ]
}

Следующий запрос автоматически обновляет моментальную фотографию разрешений пользователя, связанных с ключом API:

resp = client.security.update_api_key(
    id="VuaCfGcBCdbkQm-e5aOx",
)
print(resp)

const response = await client.security.updateApiKey({
  id: "VuaCfGcBCdbkQm-e5aOx",
});
console.log(response);

PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx

Что возвращает ответ:

{
  "updated": true
}

Результат - следующие эффективные разрешения для ключа API:

{
  "cluster": ["manage_security"],
  "indices": [
    {
      "names": ["*"],
      "privileges": ["read"]
    }
  ]
}