Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

admin-confirm-sign-up

Описание

Подтверждает регистрацию пользователя администратором.

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

Примечание

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

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

Чтобы настроить свой пул пользователей для требования административного подтверждения пользователей, установите значение AllowAdminCreateUserOnly в значение true в запросе CreateUserPool или UpdateUserPool.

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

Синтаксис

  admin-confirm-sign-up
--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 (карта)

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

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

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

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

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

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

Примеры

Примечание

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

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

Подтверждение регистрации пользователя

В этом примере подтверждается регистрация пользователя jane@example.com.

Команда:

aws cognito-idp admin-confirm-sign-up --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com

Вывод

Нет

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

Spec-Zone.ru

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