Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

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

Описание

Сбрасывает пароль указанного пользователя в пуле пользователей. Данная операция не изменяет пароль пользователя, но отправляет код для сброса пароля.

Для использования этой API операции ваш пул пользователей должен иметь включенную самообслуживающую восстановление учетной записи.

Примечание

Данное действие может генерировать SMS сообщение. Начиная с 1 июня 2021 года, операторы сотовой связи США требуют регистрировать номер отправки перед отправкой SMS сообщений на номера телефонов в США. Если вы используете SMS сообщения в Amazon Cognito, вы должны зарегистрировать номер телефона в Amazon Pinpoint. Amazon Cognito автоматически использует зарегистрированный номер. В противном случае пользователи Amazon Cognito, которые должны получать SMS сообщения, могут не смочь зарегистрироваться, активировать свои учетные записи или войти в систему.

Если вы никогда не использовали SMS сообщения с Amazon Cognito или любой другой службой Amazon Web Services, Amazon Simple Notification Service может поместить вашу учетную запись в режим песочницы SMS. В режиме песочницы вы можете отправлять сообщения только на проверенные номера телефонов. После того, как вы протестируете ваше приложение в среде песочницы, вы можете перейти из режима песочницы в рабочее состояние. Для получения дополнительной информации см. Настройки SMS сообщений для пулов пользователей Amazon Cognito в Руководстве разработчика Amazon Cognito.

Примечание

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

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

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

Синопсис

  admin-reset-user-password
--user-pool-id <value>
--username <value>
[--client-metadata <value>]
[--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.

--client-metadata (массив)

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

Вы создаете пользовательские рабочие процессы, назначая функции Lambda триггерам пула пользователей. Операция API AdminResetUserPassword вызывает функцию, назначенную триггеру custom message. Когда Amazon Cognito вызывает эту функцию, она передает JSON payload, который функция получает как входные данные. Этот payload содержит атрибут clientMetadata, который предоставляет данные, которые вы назначили параметру ClientMetadata в вашем запросе AdminResetUserPassword. В коде вашей функции в Lambda вы можете обработать значение clientMetadata для повышения эффективности вашего рабочего процесса в соответствии с вашими потребностями.

Дополнительную информацию см. в разделе Использование триггеров Lambda в Руководстве разработчика Amazon Cognito.

Примечание

При использовании параметра ClientMetadata обратите внимание, что Amazon Cognito не будет выполнять следующие действия:

  • Хранить значение ClientMetadata. Эти данные доступны только для триггеров Lambda, которые назначены пулу пользователей для поддержки пользовательских рабочих процессов. Если в настройке вашего пула пользователей нет триггеров, параметр ClientMetadata не имеет смысла.
  • Проверять значение ClientMetadata.
  • Шифровать значение ClientMetadata. Не передавайте конфиденциальную информацию в этом параметре.

ключ -> (строка)

значение -> (строка)

Сокращенная синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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 (логический)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (логический)

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

--no-cli-auto-prompt (логический)

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

Примеры

Примечание

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

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

Для сброса пароля пользователя

В этом примере сбрасывается пароль для diego@example.com.

Команда:

aws cognito-idp admin-reset-user-password --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com

Вывод

Нет

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API