Подтверждение регистрации

Описание

Подтверждает учетную запись нового пользователя. Эта публичная операция API отправляет код, который Amazon Cognito отправил вашему пользователю при регистрации в вашем пуле пользователей. После того, как пользователь введет свой код, он подтвердит владение адресом электронной почты или номером телефона, которые он предоставил, и его учетная запись пользователя станет активной. В зависимости от конфигурации вашего пула пользователей пользователи получат код подтверждения по электронной почте или СМС-сообщению.

Только локальные пользователи, зарегистрированные в вашем пуле пользователей, могут подтвердить регистрацию с помощью кода. Пользователи, которые проходят аутентификацию через внешнего поставщика идентификации (IdP), уже были подтверждены своим IdP.

Примечание

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

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

Синтаксис

  confirm-sign-up
--client-id <value>
[--secret-hash <value>]
--username <value>
--confirmation-code <value>
[--force-alias-creation | --no-force-alias-creation]
[--analytics-metadata <value>]
[--user-context-data <value>]
[--client-metadata <value>]
[--session <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 (строка)

ID клиента приложения, связанного с пулом пользователей.

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

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

--username (строка)

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

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

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

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

Когда true , принудительно подтверждает пользователя, несмотря на существующие псевдонимы. По умолчанию false . Значение true мигрирует псевдоним из существующего пользователя в нового пользователя, если у существующего пользователя уже есть номер телефона или адрес электронной почты в качестве псевдонима.

Например, если у существующего пользователя есть атрибут email со значением bob@example.com, а электронная почта является псевдонимом в вашем пуле пользователей. Если у нового пользователя также есть электронная почта bob@example.com, а ваш ответ ConfirmSignUp устанавливает ForceAliasCreation в true, новый пользователь может войти с именем пользователя bob@example.com, а существующий пользователь больше не сможет этого сделать.

Если false и атрибут принадлежит существующему псевдониму, этот запрос возвращает ошибку AliasExistsException.

Дополнительную информацию о псевдонимах входа см. в разделе Настройка атрибутов входа.

--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 ConfirmSignUp Amazon Cognito вызывает функцию, назначенную триггеру после подтверждения. Когда Amazon Cognito вызывает эту функцию, она передает JSON-загрузку, которую функция получает как вход. Эта загрузка содержит атрибут clientMetadata, который содержит данные, которые вы присвоили параметру ClientMetadata в запросе ConfirmSignUp. В коде функции в Lambda вы можете обработать значение clientMetadata, чтобы улучшить рабочий процесс для ваших конкретных нужд.

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

Примечание

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

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

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--session (строка)

Необязательный идентификатор сеанса из запроса API SignUp. Вы можете войти в систему пользователя напрямую из процесса регистрации с потоком аутентификации USER_AUTH.

--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.

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

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

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

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

Примеры

Примечание

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

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

Подтверждение регистрации

Этот пример подтверждает регистрацию пользователя с именем пользователя diego@example.com.

Команда:

aws cognito-idp confirm-sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --confirmation-code CONF_CODE

Вывод

Сессия -> (строка)

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