Токены API

[править на GitHub]

Обзор

Токены API используются для доступа к API Chef Automate. Они являются единственным способом аутентификации в API Chef Automate. Токены могут быть добавлены в качестве членов политик, чтобы предоставить им разрешения.

Для взаимодействия с токенами требуется разрешение на действие iam:tokens. Любой пользователь, являющийся частью команды admins или политики Administrator, будет обладать этим разрешением. В противном случае можно создать пользовательские политики IAM, чтобы назначить это разрешение. Пользовательские политики IAM

Управление токенами API

Создание токенов API

Перейдите в раздел Токены API во вкладке Настройки. Затем используйте кнопку Создать токен, которая откроет диалоговое окно для ввода имени токена API и, необязательно, для назначения токена API одной или нескольким Политикам и одному или нескольким Проектам. Идентификатор токена автоматически генерируется при создании. Если вы хотите изменить идентификатор токена, выберите кнопку Изменить ID.

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

Значение токена API

После создания токена API вы можете получить значение токена, открыв меню в конце строки таблицы и выбрав Скопировать токен.

Токены администратора

Токены администратора — это токены, которые автоматически добавляются к политике администратора, предоставляющей полный доступ к Chef Automate. Токены администратора могут быть созданы только с помощью команды chef-automate командной строки.

chef-automate iam token create <your-token-name> --admin

Чтобы создать токен администратора и сразу же сохранить его в переменной среды для удобного доступа, можно вместо этого выполнить:

export TOKEN=`chef-automate iam token create <your-token-name> --admin`
echo $TOKEN

После получения токена API администратора вы можете использовать его для выполнения запросов, передав его в заголовке api-token:

curl -s -H "api-token: $TOKEN" https://automate.example.com/apis/iam/v2/policies -v

Удаление токенов API

Перейдите в раздел Токены API во вкладке Настройки. Затем откройте меню в конце строки таблицы и выберите Удалить токен.

Изменение деталей токена API

Имя токена API, проекты, к которым принадлежит токен, и статус токена могут быть изменены, перейдя в раздел Токены API из вкладки Настройки, выбрав отдельный токен и перейдя на вкладку Подробности.