Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

confirm-forgot-password

Описание

Данная операция публичного API принимает код подтверждения, отправленный Amazon Cognito пользователю, и принимает новый пароль для этого пользователя.

Примечание

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

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

Синтаксис

  confirm-forgot-password
--client-id <value>
[--secret-hash <value>]
--username <value>
--confirmation-code <value>
--password <value>
[--analytics-metadata <value>]
[--user-context-data <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]

Параметры

--client-id (строка)

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

--secret-hash (строка)

Код аутентификации сообщения с ключом-хешем (HMAC), рассчитанный с использованием секретного ключа клиента пула пользователей и имени пользователя плюс идентификатора клиента в сообщении. Дополнительную информацию о SecretHash см. в разделе Вычисление значений секретных хешей .

--username (строка)

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

--confirmation-code (строка)

Код подтверждения, который ваш пул пользователей предоставил, когда ваш пользователь запросил сброс пароля.

--password (строка)

Новый пароль, который ваш пользователь хочет установить.

--analytics-metadata (структура)

Информация, поддерживающая аналитические результаты с Amazon Pinpoint, включая идентификатор конечной точки пользователя. Идентификатор конечной точки является местом назначения push-уведомлений Amazon Pinpoint, например, идентификатор устройства, адрес электронной почты или номер телефона.

AnalyticsEndpointId -> (строка)

Идентификатор конечной точки. Информация, которую вы хотите передать Amazon Pinpoint о том, куда отправлять уведомления.

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

AnalyticsEndpointId=string

Синтаксис JSON:

{
  "AnalyticsEndpointId": "string"
}

--user-context-data (структура)

Контекстная информация о вашей сессии пользователя, такая как отпечаток устройства, IP-адрес или местоположение. Защита от угроз Amazon Cognito оценивает риск события аутентификации на основе контекста, который ваше приложение генерирует и передает в Amazon Cognito при выполнении запросов API.

Дополнительную информацию см. в разделе Сбор данных для защиты от угроз в приложениях .

IpAddress -> (строка)

IP-адрес источника устройства вашего пользователя.

EncodedData -> (строка)

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

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

IpAddress=string,EncodedData=string

Синтаксис JSON:

{
  "IpAddress": "string",
  "EncodedData": "string"
}

--client-metadata (карта)

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

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

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

Примечание

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

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

key -> (строка)

value -> (строка)

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

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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

--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 (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для подтверждения забытого пароля

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

Команда:

aws cognito-idp confirm-forgot-password --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --password PASSWORD --confirmation-code CONF_CODE

Вывод

Отсутствует

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

Spec-Zone.ru

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