[ aws . cognito-idp ]
admin-create-user
Описание
Создает нового пользователя в указанном пуле пользователей.
Если MessageAction не задано, по умолчанию отправляется приветственное сообщение по электронной почте или телефону (SMS).
Это сообщение основано на шаблоне, который вы настроили при создании или обновлении пула пользователей. Шаблон включает ваши пользовательские инструкции по регистрации и заглушки для имени пользователя и временного пароля.
В качестве альтернативы, вы можете вызвать AdminCreateUser с SUPPRESS для параметра MessageAction, и Amazon Cognito не будет отправлять электронное письмо.
В любом случае, если у пользователя есть пароль, он будет в состоянии FORCE_CHANGE_PASSWORD до тех пор, пока не войдет в систему и не установит свой пароль. Шаблон вашего приглашения должен содержать заглушку для пароля {####}, если у ваших пользователей есть пароли. Если в вашем шаблоне нет этой заглушки, Amazon Cognito не отправит сообщение о приглашении. В этом случае вам необходимо обновить шаблон сообщения и повторно отправить пароль с новым запросом AdminCreateUser со значением параметра MessageAction, равным RESEND.
Примечание
Этот метод может генерировать 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-create-user
--user-pool-id <value>
--username <value>
[--user-attributes <value>]
[--validation-data <value>]
[--temporary-password <value>]
[--force-alias-creation | --no-force-alias-creation]
[--message-action <value>]
[--desired-delivery-mediums <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 применяются следующие условия.
- Имя пользователя не может дублировать другое имя пользователя в том же пуле пользователей.
- Вы не можете изменить значение имени пользователя после его создания.
- Вы можете указать значение только в том случае, если имена пользователей являются допустимым атрибутом входа для вашего пула пользователей. Если ваш пул пользователей поддерживает только номера телефонов или адреса электронной почты в качестве атрибутов входа, Amazon Cognito автоматически генерирует значение имени пользователя. Для получения дополнительной информации см. Настройка атрибутов входа .
--user-attributes (список)
Массив пар имя-значение, содержащих атрибуты пользователя и значения атрибутов, которые нужно установить для создаваемого пользователя. Вы можете создать пользователя, не указывая никаких атрибутов, кроме Username . Однако любые атрибуты, которые вы указали как обязательные (при создании пула пользователей или на вкладке **Атрибуты** консоли), либо должны быть предоставлены (в вашем вызове AdminCreateUser ), либо пользователь должен предоставить их (при регистрации в ответ на ваше приветственное сообщение).
Для пользовательских атрибутов вы должны добавить префикс custom: к имени атрибута.
Чтобы отправить сообщение, приглашающее пользователя зарегистрироваться, вы должны указать адрес электронной почты или номер телефона пользователя. Вы можете сделать это в своем вызове AdminCreateUser или на вкладке **Пользователи** консоли Amazon Cognito для управления пулами пользователей.
Вы также должны предоставить адрес электронной почты или номер телефона, когда ожидаете, что пользователь выполнит вход без пароля с помощью электронной почты или SMS-кода OTP. Эти атрибуты должны быть предоставлены, когда доступны только варианты без пароля, или когда вы не отправляете TemporaryPassword.
В своем запросе AdminCreateUser вы можете установить атрибуты email_verified и phone_number_verified в значение true. Применяются следующие условия:
Адрес электронной почты, на который вы хотите, чтобы пользователь получал свой код подтверждения и имя пользователя. Вы должны указать значение для email, когда хотите установить email_verified в значение true, или если вы установили EMAIL в параметре DesiredDeliveryMediums.
Номер телефона, на который вы хотите, чтобы пользователь получал свой код подтверждения и имя пользователя. Вы должны указать значение для phone_number, когда хотите установить phone_number_verified в значение true, или если вы установили SMS в параметре DesiredDeliveryMediums.
(структура)
Имя и значение атрибута пользователя.
Имя -> (строка)
Значение -> (строка)
Сокращенная синтаксическая конструкция:
Name=string,Value=string ...
Синтаксис JSON:
[
{
"Name": "string",
"Value": "string"
}
...
]
--validation-data (список)
Временные атрибуты пользователя, которые влияют на результаты вашего триггера Lambda до регистрации. Этот набор пар ключ-значение предназначен для пользовательской проверки информации, которую вы собираете от пользователей, но не хотите сохранять.
Ваша функция Lambda может анализировать эти дополнительные данные и действовать на их основе. Функция может автоматически подтверждать и проверять выбранных пользователей или выполнять внешние операции API, такие как регистрация атрибутов пользователей и данных проверки в Amazon CloudWatch Logs.
Дополнительную информацию о триггере Lambda до регистрации см. в разделе Триггер Lambda до регистрации .
(структура)
Имя и значение атрибута пользователя.
Имя -> (строка)
Значение -> (строка)
Сокращенная синтаксическая конструкция:
Name=string,Value=string ...
Синтаксис JSON:
[
{
"Name": "string",
"Value": "string"
}
...
]
--temporary-password (строка)
Временный пароль пользователя. Этот пароль должен соответствовать политике паролей, которую вы указали при создании пула пользователей.
Исключение из требования пароля возникает, когда ваш пул пользователей поддерживает вход без пароля с помощью электронной почты или SMS-кода OTP. Чтобы создать пользователя без пароля, опустите этот параметр или отправьте пустое значение. Вы можете создать пользователя без пароля только тогда, когда доступен вход без пароля.
Временный пароль действителен только один раз. Чтобы завершить процесс Admin Create User, пользователь должен ввести временный пароль на странице входа, а также новый пароль, который будет использоваться при всех будущих входах.
Если вы не укажете значение, Amazon Cognito сгенерирует его для вас, если только у вас не активированы варианты входа без пароля для вашего пула пользователей.
Временный пароль может использоваться только до истечения срока действия учетной записи, установленного для вашего пула пользователей. Чтобы сбросить учетную запись после истечения этого срока, вы должны снова вызвать AdminCreateUser и указать RESEND для параметра MessageAction.
--force-alias-creation | --no-force-alias-creation (логическое значение)
Этот параметр используется только в том случае, если атрибут phone_number_verified или email_verified установлен в значение True. В противном случае он игнорируется.
Если этот параметр установлен в значение True, и номер телефона или адрес электронной почты, указанные в параметре UserAttributes, уже существуют как псевдоним с другим пользователем, этот запрос мигрирует псевдоним от предыдущего пользователя к новосозданному пользователю. Предыдущий пользователь больше не сможет войти с помощью этого псевдонима.
Если этот параметр установлен в значение False, API возвращает ошибку AliasExistsException, если псевдоним уже существует. Значение по умолчанию — False.
--message-action (строка)
Установите значение RESEND, чтобы повторно отправить приглашение пользователю, который уже существует, и сбросить срок действия временного пароля с новым временным паролем. Установите значение SUPPRESS, чтобы подавить отправку сообщения. Вы можете указать только одно значение.
Возможные значения:
RESENDSUPPRESS
--desired-delivery-mediums (список)
Укажите EMAIL, если для отправки приветственного сообщения будет использоваться электронная почта. Укажите SMS, если будет использоваться номер телефона. Значение по умолчанию — SMS. Вы можете указать несколько значений.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
SMS
EMAIL
--client-metadata (словарь)
Словарь пользовательских пар ключ-значение, которые вы можете предоставить в качестве входных данных для любых пользовательских рабочих процессов, которые запускает эта операция.
Вы создаете пользовательские рабочие процессы, назначая функции Lambda триггерам пула пользователей. При использовании действия API AdminCreateUser Amazon Cognito вызывает функцию, назначенную триггеру до регистрации. Когда Amazon Cognito вызывает эту функцию, он передает JSON-полезную нагрузку, которую функция получает в качестве входных данных. Эта полезная нагрузка содержит атрибут ClientMetadata, предоставляющий данные, которые вы назначили параметру ClientMetadata в вашем запросе AdminCreateUser. В коде вашей функции в 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 (boolean)
Включить отладку регистрации.
--endpoint-url (string)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию по проверке SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использование определенного профиля из файла учетных данных.
--region (string)
Регион для использования. Переопределяет параметры конфигурации/среды.
--version (string)
Отображение версии этого инструмента.
--color (string)
Включение/выключение цветного вывода.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружаться, если этот параметр указан.
--ca-bundle (string)
Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет параметры конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (string)
Стиль форматирования, используемый для бинарных блоков. Формат по умолчанию — 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 (boolean)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Создание пользователя
Следующий admin-create-user пример создает пользователя с указанными настройками адреса электронной почты и номера телефона.
aws cognito-idp admin-create-user \
--user-pool-id us-west-2_aaaaaaaaa \
--username diego \
--user-attributes Name=email,Value=diego@example.com Name=phone_number,Value="+15555551212" \
--message-action SUPPRESS
Вывод:
{
"User": {
"Username": "diego",
"Attributes": [
{
"Name": "sub",
"Value": "7325c1de-b05b-4f84-b321-9adc6e61f4a2"
},
{
"Name": "phone_number",
"Value": "+15555551212"
},
{
"Name": "email",
"Value": "diego@example.com"
}
],
"UserCreateDate": 1548099495.428,
"UserLastModifiedDate": 1548099495.428,
"Enabled": true,
"UserStatus": "FORCE_CHANGE_PASSWORD"
}
}
Вывод
Пользователь -> (структура)
Подробная информация о новом пользователе.
Имя пользователя -> (строка)
Атрибуты -> (список)
Имена и значения атрибутов пользователя, например email.
(структура)
Имя и значение атрибута пользователя.
Имя -> (строка)
Значение -> (строка)
Дата создания пользователя -> (временная метка)
Date.Дата последнего изменения пользователя -> (временная метка)
Date.Включен -> (boolean)
Статус пользователя -> (строка)
Статус пользователя. Может быть одним из следующих:
-
UNCONFIRMED: Пользователь создан, но не подтвержден. -
CONFIRMED: Пользователь подтвержден. -
EXTERNAL_PROVIDER: Пользователь вошел в систему с помощью стороннего поставщика IdP. -
RESET_REQUIRED: Пользователь подтвержден, но пользователь должен запросить код и сбросить пароль, прежде чем сможет войти в систему. -
FORCE_CHANGE_PASSWORD: Пользователь подтвержден и может войти в систему с временным паролем, но при первом входе в систему пользователь должен изменить свой пароль на новое значение, прежде чем делать что-либо еще.
Статусы ARCHIVED, UNKNOWN и COMPROMISED больше не используются.
МФОпции -> (список)
Настройка MFA пользователя.
(структура)
Средство доставки -> (строка)
SMS средства доставки.Имя атрибута -> (строка)
phone_number.
© Copyright 2025, Amazon Web Services. Created using Sphinx.
