admin-set-user-password

Описание

Устанавливает пароль указанного пользователя в пуле пользователей. Данная операция административно устанавливает временный или постоянный пароль для пользователя. С помощью этой операции вы можете обойти самообслуживание смены пароля и разрешить немедленный вход с установленным вами паролем. Для этого установите Permanent в true.

Вы также можете установить новый временный пароль в этом запросе, отправить его пользователю и потребовать от него выбора нового пароля при следующем входе. Для этого установите Permanent в false.

Если пароль временный, состояние пользователя Status становится FORCE_CHANGE_PASSWORD. При следующей попытке входа пользователя в ответ InitiateAuth или AdminInitiateAuth будет включен вызов NEW_PASSWORD_REQUIRED. Если пользователь не войдёт в систему до истечения срока действия временного пароля, он больше не сможет войти в систему, и вам необходимо повторить эту операцию, чтобы установить для него временный или постоянный пароль.

После того, как пользователь установит новый пароль, или если вы установите постоянный пароль, его состояние станет Confirmed.

AdminSetUserPassword может установить пароль для профиля пользователя, который Amazon Cognito создаёт для пользователей с федеративной аутентификацией сторонних поставщиков. При установке пароля статус федеративного пользователя меняется с EXTERNAL_PROVIDER на CONFIRMED. Пользователь в этом состоянии может войти в систему как федеративный пользователь и инициировать потоки аутентификации в API, как связанный родной пользователь. Он также может изменять свой пароль и атрибуты в запросах API с аутентификацией токенов, таких как ChangePassword и UpdateUserAttributes. В качестве лучшей меры безопасности и для синхронизации пользователей с вашим внешним IdP не устанавливайте пароли для профилей федеративных пользователей. Чтобы настроить федеративного пользователя для входа в систему с родным пользователем, связанным с родным пользователем, см. Связывание федеративных пользователей с существующим профилем пользователя.

Примечание

Amazon Cognito оценивает политики управления идентификацией и доступом (IAM) в запросах для этой операции API. Для этой операции вы должны использовать учетные данные IAM для авторизации запросов и предоставить себе соответствующее разрешение IAM в политике.

Подробнее

Подписание запросов к API Amazon Web Services
Использование API пулов пользователей Amazon Cognito и конечных точек пулов пользователей

См. также: Документация по API AWS

Синтаксис

  admin-set-user-password
--user-pool-id <value>
--username <value>
--password <value>
[--permanent | --no-permanent]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--user-pool-id (строка)

Идентификатор пула пользователей, в котором вы хотите установить пароль пользователя.

--username (строка)

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

--password (строка)

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

--permanent | --no-permanent (логическое значение)

Установите значение true, чтобы установить пароль, с которым пользователь может немедленно войти в систему. Установите значение false, чтобы установить временный пароль, который пользователь должен изменить при следующем входе.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с использованием значения, предоставленного JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команды и вернёт пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись.

--endpoint-url (строка)

Переопределить значение URL по умолчанию для команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию, связанное с проверкой сертификатов SSL.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

json
text
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет параметры конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

on
off
auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружаться, если этот аргумент предоставлен.

--ca-bundle (строка)

Пакет сертификатов CA для использования при проверке сертификатов SSL. Переопределяет параметры конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается на двоичный блок, fileb:// всегда будет рассматриваться как двоичный и будет использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить тулбар AWS CLI для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

За исключением случаев, когда указано иное, все примеры используют правила цитирования, подобные правилам Unix. Эти примеры потребуют адаптации к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Установить пароль пользователя как администратор

Следующий пример admin-set-user-password постоянно устанавливает пароль для diego@example.com.

aws cognito-idp admin-set-user-password \
    --user-pool-id us-west-2_EXAMPLE \
    --username diego@example.com \
    --password MyExamplePassword1! \
    --permanent

Эта команда не выводит никаких данных.

Для получения дополнительной информации см. Пароли, восстановление паролей и политики паролей в Руководстве разработчика Amazon Cognito.

Вывод

Нет