[ aws . cognito-idp ]
создать-пул-пользователей
Описание
Создаёт новый пул пользователей Amazon Cognito. Данная операция устанавливает основные и расширенные параметры конфигурации.
Предупреждение
Если вы не предоставите значение для атрибута, Amazon Cognito установит его по умолчанию.Примечание
Данное действие может генерировать 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 и конечных точек пула пользователей
См. также: Документация AWS API
Синопсис
create-user-pool
--pool-name <value>
[--policies <value>]
[--deletion-protection <value>]
[--lambda-config <value>]
[--auto-verified-attributes <value>]
[--alias-attributes <value>]
[--username-attributes <value>]
[--sms-verification-message <value>]
[--email-verification-message <value>]
[--email-verification-subject <value>]
[--verification-message-template <value>]
[--sms-authentication-message <value>]
[--mfa-configuration <value>]
[--user-attribute-update-settings <value>]
[--device-configuration <value>]
[--email-configuration <value>]
[--sms-configuration <value>]
[--user-pool-tags <value>]
[--admin-create-user-config <value>]
[--schema <value>]
[--user-pool-add-ons <value>]
[--username-configuration <value>]
[--account-recovery-setting <value>]
[--user-pool-tier <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]
Параметры
--pool-name (строка)
--policies (структура)
Политика паролей и политика входа в пул пользователей. Политика паролей устанавливает параметры, такие как требования к сложности паролей и истории паролей. Политика входа устанавливает параметры, доступные приложениям в аутентификации на основе выбора.
PasswordPolicy -> (структура)
Настройки политики паролей для пула пользователей, включая требования к сложности, истории и длине.
MinimumLength -> (целое число)
RequireUppercase -> (булево)
RequireLowercase -> (булево)
RequireNumbers -> (булево)
RequireSymbols -> (булево)
PasswordHistorySize -> (целое число)
n предыдущих паролей, где n — это значение PasswordHistorySize.TemporaryPasswordValidityDays -> (целое число)
Количество дней, в течение которых временный пароль действителен в политике паролей. Если пользователь не войдёт в систему в течение этого времени, администратор должен сбросить его пароль. По умолчанию 7. Если вы передадите значение 0, Amazon Cognito обрабатывает его как null и устанавливает TemporaryPasswordValidityDays на его значение по умолчанию.
Примечание
Когда вы устанавливаетеTemporaryPasswordValidityDays для пула пользователей, вы больше не можете устанавливать значение для параметра UnusedAccountValidityDays в этом пуле пользователей.SignInPolicy -> (структура)
Политика разрешенных типов аутентификации в пуле пользователей.
AllowedFirstAuthFactors -> (список)
Методы входа, которые поддерживает пул пользователей в качестве первого фактора. Вы можете разрешить пользователям начать аутентификацию с использованием стандартного имени пользователя и пароля или с помощью других одноразовых паролей и аппаратных факторов.
(строка)
Сокращенная синтаксическая запись:
PasswordPolicy={MinimumLength=integer,RequireUppercase=boolean,RequireLowercase=boolean,RequireNumbers=boolean,RequireSymbols=boolean,PasswordHistorySize=integer,TemporaryPasswordValidityDays=integer},SignInPolicy={AllowedFirstAuthFactors=[string,string]}
Синтаксис JSON:
{
"PasswordPolicy": {
"MinimumLength": integer,
"RequireUppercase": true|false,
"RequireLowercase": true|false,
"RequireNumbers": true|false,
"RequireSymbols": true|false,
"PasswordHistorySize": integer,
"TemporaryPasswordValidityDays": integer
},
"SignInPolicy": {
"AllowedFirstAuthFactors": ["PASSWORD"|"EMAIL_OTP"|"SMS_OTP"|"WEB_AUTHN", ...]
}
}
--deletion-protection (строка)
При активации DeletionProtection предотвращает случайное удаление вашего пула пользователей. Прежде чем вы сможете удалить пул пользователей, защищенный от удаления, вы должны деактивировать эту функцию.
Когда вы пытаетесь удалить защищенный пул пользователей в запросе API DeleteUserPool, Amazon Cognito возвращает ошибку InvalidParameterException. Чтобы удалить защищенный пул пользователей, отправьте новый запрос DeleteUserPool после деактивации защиты от удаления в запросе API UpdateUserPool.
Возможные значения:
ACTIVEINACTIVE
--lambda-config (структура)
Коллекция триггеров Lambda для пула пользователей. Amazon Cognito вызывает триггеры на нескольких возможных этапах операций аутентификации. Триггеры могут изменить результат операций, которые их вызвали.
PreSignUp -> (строка)
CustomMessage -> (строка)
PostConfirmation -> (строка)
PreAuthentication -> (строка)
PostAuthentication -> (строка)
DefineAuthChallenge -> (строка)
CreateAuthChallenge -> (строка)
VerifyAuthChallengeResponse -> (строка)
PreTokenGeneration -> (строка)
Настройка триггера Lambda до генерации токена в пуле пользователей (устаревшая версия).
Установите этот параметр для совместимости со старыми версиями. Если вы также устанавливаете значение ARN в PreTokenGenerationConfig, его значение должно быть идентично PreTokenGeneration. Для новых случаев триггеров до генерации токена установите LambdaArn параметра PreTokenGenerationConfig.
UserMigration -> (строка)
PreTokenGenerationConfig -> (структура)
Подробная настройка триггера Lambda до генерации токена в пуле пользователей. Если вы также устанавливаете значение ARN в PreTokenGeneration, его значение должно быть идентично PreTokenGenerationConfig.
LambdaVersion -> (строка)
LambdaArn -> (строка)
Идентификатор Amazon Resource Name (ARN) функции, которую вы хотите назначить вашему триггеру Lambda.
Этот параметр и свойство PreTokenGeneration объекта LambdaConfig имеют одинаковое значение. Для новых случаев триггеров до генерации токена установите LambdaArn.
CustomSMSSender -> (структура)
Настройка триггера Lambda для пользовательских отправителей SMS. Этот триггер перенаправляет все SMS-уведомления из пула пользователей в функцию Lambda, которая передает сообщение с использованием пользовательской логики.
LambdaVersion -> (строка)
Версия триггера пула пользователей, которую Amazon Cognito отправляет в вашу функцию Lambda. Версии с более высокими номерами добавляют поля, которые поддерживают новые функции.
Вы должны использовать LambdaVersion версию V1_0 с функцией пользовательского отправителя.
LambdaArn -> (строка)
CustomEmailSender -> (структура)
Настройка триггера Lambda для пользовательских отправителей электронной почты. Этот триггер перенаправляет все уведомления по электронной почте из пула пользователей в функцию Lambda, которая передает сообщение с использованием пользовательской логики.
LambdaVersion -> (строка)
Версия триггера пула пользователей, которую Amazon Cognito отправляет в вашу функцию Lambda. Версии с более высокими номерами добавляют поля, которые поддерживают новые функции.
Вы должны использовать LambdaVersion версию V1_0 с функцией пользовательского отправителя.
LambdaArn -> (строка)
KMSKeyID -> (строка)
Сокращенная синтаксическая запись:
PreSignUp=string,CustomMessage=string,PostConfirmation=string,PreAuthentication=string,PostAuthentication=string,DefineAuthChallenge=string,CreateAuthChallenge=string,VerifyAuthChallengeResponse=string,PreTokenGeneration=string,UserMigration=string,PreTokenGenerationConfig={LambdaVersion=string,LambdaArn=string},CustomSMSSender={LambdaVersion=string,LambdaArn=string},CustomEmailSender={LambdaVersion=string,LambdaArn=string},KMSKeyID=string
Синтаксис JSON:
{
"PreSignUp": "string",
"CustomMessage": "string",
"PostConfirmation": "string",
"PreAuthentication": "string",
"PostAuthentication": "string",
"DefineAuthChallenge": "string",
"CreateAuthChallenge": "string",
"VerifyAuthChallengeResponse": "string",
"PreTokenGeneration": "string",
"UserMigration": "string",
"PreTokenGenerationConfig": {
"LambdaVersion": "V1_0"|"V2_0"|"V3_0",
"LambdaArn": "string"
},
"CustomSMSSender": {
"LambdaVersion": "V1_0",
"LambdaArn": "string"
},
"CustomEmailSender": {
"LambdaVersion": "V1_0",
"LambdaArn": "string"
},
"KMSKeyID": "string"
}
--auto-verified-attributes (список)
Атрибуты, которые вы хотите, чтобы ваш пул пользователей автоматически проверял. Дополнительную информацию см. в разделе Проверка контактной информации при регистрации.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
phone_number
email
--alias-attributes (список)
Атрибуты, поддерживаемые в качестве псевдонима для этого пула пользователей. Дополнительную информацию об атрибутах псевдонимов см. в разделе Настройка атрибутов входа в систему.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
phone_number
email
preferred_username
--username-attributes (список)
Указывает, может ли пользователь использовать адрес электронной почты или номер телефона в качестве имени пользователя при регистрации. Дополнительную информацию см. в разделе Настройка атрибутов входа в систему.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
phone_number
email
--sms-verification-message (строка)
--email-verification-message (строка)
--email-verification-subject (строка)
--verification-message-template (структура)
Шаблон сообщения для проверки, которое ваш пул пользователей отправляет пользователям, которые установили атрибут электронной почты или номер телефона.
Установите тип сообщения электронной почты, соответствующий вашему выбору. Для DefaultEmailOption, укажите EmailMessageByLink и оставьте EmailMessage пустым. Для CONFIRM_WITH_CODE, укажите EmailMessage и оставьте EmailMessageByLink пустым. Если вы укажете оба параметра с любым выбором, Amazon Cognito вернёт ошибку.
SmsMessage -> (строка)
EmailMessage -> (строка)
EmailMessage только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда ваш EmailSendingAccount равен DEVELOPER, ваш пул пользователей отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.EmailSubject -> (строка)
EmailSubject только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда ваш EmailSendingAccount равен DEVELOPER, ваш пул пользователей отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.EmailMessageByLink -> (строка)
EmailMessageByLink только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда ваш EmailSendingAccount равен DEVELOPER, ваш пул пользователей отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.EmailSubjectByLink -> (строка)
EmailSubjectByLink только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда ваш EmailSendingAccount равен DEVELOPER, ваш пул пользователей отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.DefaultEmailOption -> (строка)
Настройка сообщений электронной почты для подтверждения, содержащих нажатие ссылки или код подтверждения.
Для ссылки тело вашего шаблона должно содержать текст ссылки в формате {##Click here##}. «Нажмите здесь» в примере — это настраиваемая строка. Для кода тело вашего шаблона должно содержать заполнитель кода в формате {####}.
Краткая запись синтаксиса:
SmsMessage=string,EmailMessage=string,EmailSubject=string,EmailMessageByLink=string,EmailSubjectByLink=string,DefaultEmailOption=string
Синтаксис JSON:
{
"SmsMessage": "string",
"EmailMessage": "string",
"EmailSubject": "string",
"EmailMessageByLink": "string",
"EmailSubjectByLink": "string",
"DefaultEmailOption": "CONFIRM_WITH_LINK"|"CONFIRM_WITH_CODE"
}
--sms-authentication-message (строка)
--mfa-configuration (строка)
Устанавливает многофакторную аутентификацию (MFA) на включение, выключение или необязательность. Когда ON, все пользователи должны настроить MFA, прежде чем они смогут войти в систему. Когда OPTIONAL, ваше приложение должно определить, хочет ли пользователь зарегистрировать устройство MFA. Для пулов пользователей с адаптивной аутентификацией с защитой от угроз выберите OPTIONAL.
Когда MfaConfiguration равно OPTIONAL, управляемый вход не автоматически запрашивает пользователей настроить MFA. Amazon Cognito генерирует запросы MFA в ответах API и в управляемом входе для пользователей, которые выбрали и настроили предпочтительный фактор MFA.
Возможные значения:
OFFONOPTIONAL
--user-attribute-update-settings (структура)
Настройки обновлений атрибутов пользователей. Эти настройки включают свойство AttributesRequireVerificationBeforeUpdate, настройку пула пользователей, которая сообщает Amazon Cognito, как обрабатывать изменения значения атрибутов электронной почты и номера телефона ваших пользователей. Дополнительная информация приведена в разделе Проверка обновлений адресов электронной почты и номеров телефонов.
AttributesRequireVerificationBeforeUpdate -> (список)
Требует, чтобы пользователь подтвердил свой адрес электронной почты, номер телефона или оба перед тем, как Amazon Cognito обновит значение этого атрибута. При обновлении атрибута пользователя, для которого эта опция активирована, Amazon Cognito отправляет сообщение проверки на новый номер телефона или адрес электронной почты. Amazon Cognito не изменяет значение атрибута до тех пор, пока пользователь не ответит на сообщение проверки и не подтвердит новое значение.
Когда AttributesRequireVerificationBeforeUpdate равно false, ваш пул пользователей не требует, чтобы ваши пользователи подтверждали изменения атрибутов перед обновлением Amazon Cognito. В пуле пользователей, где AttributesRequireVerificationBeforeUpdate равно false, операции API, изменяющие значения атрибутов, могут сразу обновить атрибут email или phone_number пользователя.
(строка)
Краткая запись синтаксиса:
AttributesRequireVerificationBeforeUpdate=string,string
Синтаксис JSON:
{
"AttributesRequireVerificationBeforeUpdate": ["phone_number"|"email", ...]
}
--device-configuration (структура)
Настройка запоминания устройства для пула пользователей. Запоминание устройства или отслеживание устройств — это опция «Запомнить меня на этом устройстве» для пулов пользователей, которые выполняют аутентификацию с ключом устройства надёжного устройства на стороне сервера, а не с кодом MFA, предоставленным пользователем. Дополнительную информацию об аутентификации устройств см. в разделе Работа с устройствами пользователей в вашем пуле пользователей. Значение null указывает, что запоминание устройства в вашем пуле пользователей отключено.
Примечание
Когда вы предоставляете значение для любого поляDeviceConfiguration, вы активируете функцию запоминания устройств Amazon Cognito. Дополнительную информацию см. в разделе Работа с устройствами.ChallengeRequiredOnNewDevice -> (булево)
При значении true, запомненное устройство может войти в систему с помощью аутентификации устройства вместо факторов SMS и временных одноразовых паролей (TOTP) для многофакторной аутентификации (MFA).
Примечание
Независимо от того, является лиChallengeRequiredOnNewDevice true или false, пользователи, которые входят в систему с устройствами, которые не были подтверждены или запомнены, по-прежнему должны предоставить второй фактор в пуле пользователей, который требует MFA.DeviceOnlyRememberedOnUserPrompt -> (булево)
При значении true Amazon Cognito не автоматически запоминает устройство пользователя, когда ваше приложение отправляет запрос API ConfirmDevice. В вашем приложении создайте запрос для пользователя, чтобы он выбрал, хочет ли он запомнить своё устройство. Верните выбор пользователя в запросе API UpdateDeviceStatus.
Когда DeviceOnlyRememberedOnUserPrompt равно false, Amazon Cognito сразу же запоминает устройства, которые вы регистрируете в запросе API ConfirmDevice.
Краткая запись синтаксиса:
ChallengeRequiredOnNewDevice=boolean,DeviceOnlyRememberedOnUserPrompt=boolean
Синтаксис JSON:
{
"ChallengeRequiredOnNewDevice": true|false,
"DeviceOnlyRememberedOnUserPrompt": true|false
}
--email-configuration (структура)
Настройка электронной почты для вашего пула пользователей. Тип конфигурации электронной почты устанавливает предпочтительный метод отправки, регион Amazon Web Services и отправителя для сообщений из вашего пула пользователей.
SourceArn -> (строка)
ARN проверенного адреса электронной почты или адреса из проверенного домена в Amazon SES. Вы можете установить SourceArn электронную почту из проверенного домена только с помощью запроса API. Вы можете установить проверенный адрес электронной почты, но не адрес в проверенном домене, в консоли Amazon Cognito. Amazon Cognito использует адрес электронной почты, который вы предоставили, следующим образом, в зависимости от значения параметра EmailSendingAccount:
- Если вы укажете
COGNITO_DEFAULT, Amazon Cognito использует этот адрес в качестве пользовательского адреса ОТПРАВЛЕНО от, когда отправляет электронные письма вашим пользователям, используя свою встроенную учетную запись электронной почты. - Если вы укажете
DEVELOPER, Amazon Cognito отправляет электронные письма вашим пользователям, вызывая Amazon SES от вашего имени.
Значение параметра SourceArn должно указывать поддерживаемый регион Amazon Web Services для вашего пула пользователей. Как правило, регион в SourceArn и регион пула пользователей совпадают. Дополнительную информацию см. в руководстве разработчика Amazon Cognito в разделе Amazon SES email configuration regions.
ReplyToEmailAddress -> (строка)
EmailSendingAccount -> (строка)
Указывает, использует ли Amazon Cognito свою встроенную функциональность для отправки электронных писем вашим пользователям или использует вашу конфигурацию электронной почты Amazon Simple Email Service. Укажите одно из следующих значений:
Когда Amazon Cognito отправляет электронные письма вашим пользователям, он использует свою встроенную функциональность электронной почты. При использовании параметра по умолчанию Amazon Cognito позволяет отправлять только ограниченное количество писем в день для вашего пула пользователей. В типичных производственных средах предел отправки электронной почты по умолчанию меньше необходимого объема доставки. Чтобы добиться большего объема доставки, укажите DEVELOPER для использования вашей конфигурации электронной почты Amazon SES.
Чтобы узнать лимит доставки электронной почты для параметра по умолчанию, см. раздел Limits в руководстве разработчика Amazon Cognito.
Адрес отправителя по умолчанию — no-reply@verificationemail.com. Чтобы настроить адрес отправителя, предоставьте Amazon Resource Name (ARN) проверенного адреса электронной почты Amazon SES для параметра SourceArn.
Когда Amazon Cognito отправляет электронные письма вашим пользователям, он использует вашу конфигурацию Amazon SES. Amazon Cognito вызывает Amazon SES от вашего имени для отправки электронных писем с вашего проверенного адреса электронной почты. При использовании этого параметра лимиты доставки электронных писем совпадают с лимитами, применимыми к вашему проверенному адресу электронной почты Amazon SES в вашей учетной записи Amazon Web Services.
Если вы используете этот параметр, предоставьте ARN проверенного адреса электронной почты Amazon SES для параметра SourceArn.
Для отправки электронных писем вашим пользователям Amazon Cognito требует дополнительных разрешений для вызова Amazon SES от вашего имени. При обновлении вашего пула пользователей с этим параметром Amazon Cognito создает роль связанную с сервисом, которая является типом роли в вашей учетной записи Amazon Web Services. Эта роль содержит разрешения, которые позволяют вам получать доступ к Amazon SES и отправлять электронные письма с вашего адреса электронной почты. Дополнительную информацию о роли, связанной с сервисом, которую создает Amazon Cognito, см. в руководстве разработчика Amazon Cognito в разделе Использование ролей, связанных с сервисом, для Amazon Cognito.
From -> (строка)
testuser@example.com или Test User <testuser@example.com>. Этот адрес отображается перед телом письма.ConfigurationSet -> (строка)
Набор правил конфигурации, которые могут быть применены к электронным письмам, отправляемым с помощью Amazon Simple Email Service. Набор конфигурации применяется к электронному письму путем включения ссылки на набор конфигурации в заголовках письма. После применения к письму применяются все правила в этом наборе конфигурации. Наборы конфигурации можно использовать для применения следующих типов правил к электронным письмам:
Amazon Simple Email Service может отслеживать количество отправленных, доставленных, открытых, нажатых, возвращенных и жалобных событий для каждого отправленного письма. Используйте публикацию событий для отправки информации об этих событиях в другие службы Amazon Web Services, такие как Amazon CloudWatch.
При аренде выделенных IP-адресов с Amazon Simple Email Service вы можете создавать группы IP-адресов, называемые выделенными пулами IP-адресов. Затем вы можете связать выделенные пулы IP-адресов с наборами конфигурации.
Сокращенная синтаксическая запись:
SourceArn=string,ReplyToEmailAddress=string,EmailSendingAccount=string,From=string,ConfigurationSet=string
Синтаксис JSON:
{
"SourceArn": "string",
"ReplyToEmailAddress": "string",
"EmailSendingAccount": "COGNITO_DEFAULT"|"DEVELOPER",
"From": "string",
"ConfigurationSet": "string"
}
--sms-configuration (структура)
Параметры вашего пула пользователей Amazon Cognito для отправки сообщений SMS с Amazon Simple Notification Service. Для отправки сообщений SMS с Amazon SNS в нужном вам регионе Amazon Web Services пул пользователей Amazon Cognito использует роль Identity and Access Management (IAM) в вашей учетной записи Amazon Web Services. Дополнительную информацию см. в разделе Параметры сообщений SMS.
SnsCallerArn -> (строка)
ExternalId -> (строка)
Внешний идентификатор обеспечивает дополнительную безопасность для вашей роли IAM. Вы можете использовать ExternalId с ролью IAM, которую вы используете с Amazon SNS для отправки сообщений SMS для вашего пула пользователей. Если вы предоставите ExternalId, ваш пул пользователей Amazon Cognito включит его в запрос для получения вашей роли IAM. Вы можете настроить политику доверия роли таким образом, чтобы потребовать, чтобы Amazon Cognito и любой другой субъект предоставили ExternalID. Если вы используете Amazon Cognito Management Console для создания роли для многофакторной аутентификации (MFA) по SMS, Amazon Cognito создаст роль с необходимыми разрешениями и политикой доверия, демонстрирующей использование ExternalId.
Дополнительную информацию о ExternalId роли см. в разделе Как использовать внешний идентификатор при предоставлении доступа к вашим ресурсам Amazon Web Services сторонней организации.
SnsRegion -> (строка)
Регион Amazon Web Services, который необходимо использовать с интегрированием Amazon SNS. Вы можете выбрать тот же регион, что и ваш пул, или поддерживаемый **альтернативный регион Amazon SNS**.
Ресурсы Amazon Cognito в регионе Amazon Web Services Азия-Тихий океан (Сеул) должны использовать вашу конфигурацию Amazon SNS в регионе Азия-Тихий океан (Токио). Дополнительную информацию см. в разделе Параметры сообщений SMS для пулов пользователей Amazon Cognito.
Сокращенная синтаксическая запись:
SnsCallerArn=string,ExternalId=string,SnsRegion=string
Синтаксис JSON:
{
"SnsCallerArn": "string",
"ExternalId": "string",
"SnsRegion": "string"
}
--user-pool-tags (массив)
Ключи и значения тегов, которые необходимо назначить пулу пользователей. Тег — это метка, которую вы можете использовать для категоризации и управления пулами пользователей различными способами, например, по назначению, владельцу, среде или другим критериям.
key -> (строка)
value -> (строка)
Сокращенная синтаксическая запись:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--admin-create-user-config (структура)
Конфигурация для административного создания пользователей. Включает шаблон сообщения об приглашении для новых пользователей, срок действия временных паролей и разрешение на самообслуживание.
AllowAdminCreateUserOnly -> (булево значение)
true, только администраторы могут создавать новые профили пользователей. Когда значение false, пользователи могут регистрироваться сами и создавать новый профиль пользователя с помощью операции SignUp.UnusedAccountValidityDays -> (целое число)
Этот параметр больше не используется.
Срок действия пароля в днях для созданных администраторами пользователей. После истечения этого срока пользователь не сможет войти в систему с помощью временного пароля. Чтобы сбросить учетную запись после этого срока, необходимо снова вызвать AdminCreateUser, указав RESEND для параметра MessageAction.
Значение параметра по умолчанию — 7.
InviteMessageTemplate -> (структура)
Шаблон сообщения приветствия для новых пользователей. Этот шаблон должен включать заполнитель временного пароля {####}, если вы создаете пользователей с паролями. Если у ваших пользователей нет паролей, вы можете опустить этот заполнитель.
См. также раздел Настройка сообщений об приглашениях для пользователей.
SMSMessage -> (строка)
EmailMessage -> (строка)
EmailSubject -> (строка)
Сокращенная синтаксическая запись:
AllowAdminCreateUserOnly=boolean,UnusedAccountValidityDays=integer,InviteMessageTemplate={SMSMessage=string,EmailMessage=string,EmailSubject=string}
Синтаксис JSON:
{
"AllowAdminCreateUserOnly": true|false,
"UnusedAccountValidityDays": integer,
"InviteMessageTemplate": {
"SMSMessage": "string",
"EmailMessage": "string",
"EmailSubject": "string"
}
}
--schema (список)
Массив атрибутов для нового пользовательского пула. Вы можете добавить пользовательские атрибуты и изменить свойства стандартных атрибутов. Параметры в этом наборе определяют требуемые атрибуты в вашем пользовательском пуле. Дополнительная информация представлена в разделе Работа с атрибутами пользователей.
(структура)
Список атрибутов пользователей и их свойств в вашем пользовательском пуле. Схема атрибутов содержит стандартные атрибуты, пользовательские атрибуты с префиксом custom: и атрибуты разработчиков с префиксом dev:. Дополнительную информацию можно найти в разделе Атрибуты пользовательского пула.
Атрибуты разработчиков (только для разработчиков) dev: — это устаревшая функция пользовательских пулов, и они являются только для чтения для всех клиентов приложений. Вы можете создавать и обновлять атрибуты только для разработчиков с помощью операций API с аутентификацией IAM. Используйте разрешения на чтение/запись клиента приложения вместо этого.
Имя -> (строка)
Name равным MyAttribute, Amazon Cognito создает пользовательский атрибут custom:MyAttribute. Когда DeveloperOnlyAttribute равно true, Amazon Cognito создает атрибут как dev:MyAttribute. При операции описания пользовательского пула Amazon Cognito возвращает это значение как value для стандартных атрибутов, custom:value для пользовательских атрибутов и dev:value для атрибутов, доступных только разработчикам.AttributeDataType -> (строка)
AttributeDataType Amazon Cognito проверяет входные данные на соответствие типу данных. Значение пользовательского атрибута в токен пользователя всегда является строкой, например, "custom:isMember" : "true" или "custom:YearsAsMember" : "12".DeveloperOnlyAttribute -> (булево)
Примечание
Вы должны использовать WriteAttributes в клиенте пользовательского пула для управления тем, как атрибуты могут быть изменены для новых случаев использования вместо использованияDeveloperOnlyAttribute.Указывает, является ли тип атрибута только для разработчиков. Этот атрибут может быть изменен только администратором. Пользователи не смогут изменить этот атрибут, используя свой токен доступа. Например, DeveloperOnlyAttribute может быть изменен с помощью AdminUpdateUserAttributes, но не может быть обновлен с помощью UpdateUserAttributes.
Mutable -> (булево)
Указывает, может ли значение атрибута быть изменено.
Любой атрибут пользовательского пула, значение которого вы отображаете из атрибута IdP, должен быть изменяемым, со значением параметра true. Amazon Cognito обновляет сопоставленные атрибуты, когда пользователи входят в ваше приложение через IdP. Если атрибут неизменяем, Amazon Cognito генерирует ошибку при попытке обновить атрибут. Дополнительная информация приведена в разделе Указание сопоставлений атрибутов поставщика удостоверений для вашего пользовательского пула.
Required -> (булево)
NumberAttributeConstraints -> (структура)
Устанавливает ограничения для атрибута числового типа.
MinValue -> (строка)
MaxValue -> (строка)
2^1023, представленным как строка длиной не более 131072 символов.StringAttributeConstraints -> (структура)
Устанавливает ограничения для атрибута строкового типа.
MinLength -> (строка)
MaxLength -> (строка)
2^1023, представленным как строка длиной не более 131072 символов.Краткая запись:
Name=string,AttributeDataType=string,DeveloperOnlyAttribute=boolean,Mutable=boolean,Required=boolean,NumberAttributeConstraints={MinValue=string,MaxValue=string},StringAttributeConstraints={MinLength=string,MaxLength=string} ...
Синтаксис JSON:
[
{
"Name": "string",
"AttributeDataType": "String"|"Number"|"DateTime"|"Boolean",
"DeveloperOnlyAttribute": true|false,
"Mutable": true|false,
"Required": true|false,
"NumberAttributeConstraints": {
"MinValue": "string",
"MaxValue": "string"
},
"StringAttributeConstraints": {
"MinLength": "string",
"MaxLength": "string"
}
}
...
]
--user-pool-add-ons (структура)
Содержит параметры для активации защиты от угроз, включая режим работы и дополнительные типы аутентификации. Для регистрации информации о безопасности пользователей, но без каких-либо действий, установите значение AUDIT. Для настройки автоматических ответов на потенциально нежелательный трафик в ваш пользовательский пул, установите значение ENFORCED.
Дополнительная информация представлена в разделе Добавление расширенной защиты к пользовательскому пулу. Для активации этого параметра ваш пользовательский пул должен быть на уровне Plus.
AdvancedSecurityMode -> (строка)
AdvancedSecurityAdditionalFlows -> (структура)
Параметры настройки защиты от угроз для дополнительных типов аутентификации в вашем пользовательском пуле, включая пользовательскую аутентификацию.
CustomAuthMode -> (строка)
Краткая запись:
AdvancedSecurityMode=string,AdvancedSecurityAdditionalFlows={CustomAuthMode=string}
Синтаксис JSON:
{
"AdvancedSecurityMode": "OFF"|"AUDIT"|"ENFORCED",
"AdvancedSecurityAdditionalFlows": {
"CustomAuthMode": "AUDIT"|"ENFORCED"
}
}
--username-configuration (структура)
Настраивает опцию чувствительности к регистру для имен пользователей при входе в систему. Когда CaseSensitive имеет значение false (регистронезависимый), пользователи могут войти в систему с любой комбинацией заглавных и строчных букв. Например, username, USERNAME или UserName, или для электронной почты, email@example.com или EMaiL@eXamplE.Com. Для большинства случаев рекомендуется установить чувствительность к регистру в значение false. Когда имена пользователей и адреса электронной почты нечувствительны к регистру, Amazon Cognito рассматривает любые различия в регистре как одного пользователя и предотвращает назначение варианта регистра того же атрибута для разных пользователей.
Когда CaseSensitive имеет значение true (регистрозависимый), Amazon Cognito интерпретирует USERNAME и UserName как разных пользователей.
Эта настройка не может быть изменена после ее установки.
CaseSensitive -> (булево)
Указывает, будет ли применена чувствительность к регистру имени пользователя для всех пользователей в пользовательском пуле через Amazon Cognito API. Для большинства случаев рекомендуется установить чувствительность к регистру в значение False (нечувствительный к регистру). Когда имена пользователей и адреса электронной почты нечувствительны к регистру, пользователи могут войти как один и тот же пользователь, вводя разную регистровую запись своего имени пользователя.
Допустимые значения:
Включает чувствительность к регистру для всех вводов имен пользователей. При установке этого значения в true пользователи должны войти в систему, используя точную регистровую запись своего имени пользователя, например, «ИмяПользователя». Это значение по умолчанию.
Включает нечувствительность к регистру для всех вводов имен пользователей. Например, при установке этого значения в false, пользователи могут войти, используя username, USERNAME или UserName. Этот параметр также делает preferred_username и email псевдоним нечувствительными к регистру, помимо атрибута username.
Краткая запись:
CaseSensitive=boolean
Синтаксис JSON:
{
"CaseSensitive": true|false
}
--account-recovery-setting (структура)
Доступные проверенные методы, которые пользователь может использовать для восстановления пароля при вызове ForgotPassword. Вы можете использовать этот параметр для определения предпочтительного метода, когда у пользователя доступно несколько методов. При этом SMS не подходит для действительного механизма восстановления пароля, если у пользователя также активирована многофакторная аутентификация (MFA) по SMS. MFA по электронной почте также не подходит для восстановления учетной записи с помощью электронной почты. В отсутствие этого параметра Amazon Cognito использует устаревшее поведение для определения метода восстановления, где SMS имеет приоритет перед электронной почтой.
В качестве рекомендации настройте как verified_email, так и verified_phone_number, при этом один из них имеет более высокий приоритет.
RecoveryMechanisms -> (список)
Список вариантов и приоритетов для доставки сообщений пользователю при операциях сброса пароля. Настраивает или отображает предпочтения пользовательского пула для приоритетов электронной почты или SMS, должны ли пользователи переходить к второму методу доставки и должны ли пароли сбрасываться только администраторами.
(структура)
Вариант восстановления для пользователя. Тип данных AccountRecoverySettingType — это массив этого объекта. Каждый RecoveryOptionType имеет свойство приоритета, определяющее, является ли он основным или дополнительным вариантом.
Например, если verified_email имеет приоритет 1, а verified_phone_number имеет приоритет 2, ваш пользовательский пул отправляет сообщения о восстановлении учетной записи на подтвержденный адрес электронной почты, но переходит к сообщению SMS, если у пользователя есть подтвержденный номер телефона. Вариант admin_only предотвращает самообслуживание восстановления учетной записи.
Priority -> (целое число)
1.Name -> (строка)
Краткая запись:
RecoveryMechanisms=[{Priority=integer,Name=string},{Priority=integer,Name=string}]
Синтаксис JSON:
{
"RecoveryMechanisms": [
{
"Priority": integer,
"Name": "verified_email"|"verified_phone_number"|"admin_only"
}
...
]
}
--user-pool-tier (строка)
План функций или уровень пользовательского пула. Этот параметр определяет возможность пользовательского пула использовать функции, такие как управляемый вход в систему, настройка токенов доступа и защита от угроз. Значение по умолчанию — ESSENTIALS.
Возможные значения:
LITEESSENTIALSPLUS
--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 для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическую запрос параметров ввода CLI.
Примеры
Примечание
Чтобы использовать следующие примеры, у вас должен быть установлен и настроен AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI .
Для создания минимально настроенного пользовательского пула
В этом примере создается пул пользователей с именем MyUserPool с использованием значений по умолчанию. Нет обязательных атрибутов и клиентов приложений. MFA и расширенная безопасность отключены.
Команда:
aws cognito-idp create-user-pool --pool-name MyUserPool
Вывод:
{
"UserPool": {
"SchemaAttributes": [
{
"Name": "sub",
"StringAttributeConstraints": {
"MinLength": "1",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": true,
"AttributeDataType": "String",
"Mutable": false
},
{
"Name": "name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "given_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "family_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "middle_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "nickname",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "preferred_username",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "profile",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "picture",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "website",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "email",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"AttributeDataType": "Boolean",
"DeveloperOnlyAttribute": false,
"Required": false,
"Name": "email_verified",
"Mutable": true
},
{
"Name": "gender",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "birthdate",
"StringAttributeConstraints": {
"MinLength": "10",
"MaxLength": "10"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "zoneinfo",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "locale",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "phone_number",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"AttributeDataType": "Boolean",
"DeveloperOnlyAttribute": false,
"Required": false,
"Name": "phone_number_verified",
"Mutable": true
},
{
"Name": "address",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "updated_at",
"NumberAttributeConstraints": {
"MinValue": "0"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "Number",
"Mutable": true
}
],
"MfaConfiguration": "OFF",
"Name": "MyUserPool",
"LastModifiedDate": 1547833345.777,
"AdminCreateUserConfig": {
"UnusedAccountValidityDays": 7,
"AllowAdminCreateUserOnly": false
},
"EmailConfiguration": {},
"Policies": {
"PasswordPolicy": {
"RequireLowercase": true,
"RequireSymbols": true,
"RequireNumbers": true,
"MinimumLength": 8,
"RequireUppercase": true
}
},
"CreationDate": 1547833345.777,
"EstimatedNumberOfUsers": 0,
"Id": "us-west-2_aaaaaaaaa",
"LambdaConfig": {}
}
}
Для создания пула пользователей с двумя обязательными атрибутами
В этом примере создается пул пользователей MyUserPool. Пул настроен на прием электронного адреса в качестве атрибута имени пользователя. Он также устанавливает адрес источника электронного адреса на валидный адрес с использованием Amazon Simple Email Service.
Команда:
aws cognito-idp create-user-pool --pool-name MyUserPool --username-attributes "email" --email-configuration=SourceArn="arn:aws:ses:us-east-1:111111111111:identity/jane@example.com",ReplyToEmailAddress="jane@example.com"
Вывод:
{
"UserPool": {
"SchemaAttributes": [
{
"Name": "sub",
"StringAttributeConstraints": {
"MinLength": "1",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": true,
"AttributeDataType": "String",
"Mutable": false
},
{
"Name": "name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "given_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "family_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "middle_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "nickname",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "preferred_username",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "profile",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "picture",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "website",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "email",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"AttributeDataType": "Boolean",
"DeveloperOnlyAttribute": false,
"Required": false,
"Name": "email_verified",
"Mutable": true
},
{
"Name": "gender",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "birthdate",
"StringAttributeConstraints": {
"MinLength": "10",
"MaxLength": "10"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "zoneinfo",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "locale",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "phone_number",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"AttributeDataType": "Boolean",
"DeveloperOnlyAttribute": false,
"Required": false,
"Name": "phone_number_verified",
"Mutable": true
},
{
"Name": "address",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "updated_at",
"NumberAttributeConstraints": {
"MinValue": "0"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "Number",
"Mutable": true
}
],
"MfaConfiguration": "OFF",
"Name": "MyUserPool",
"LastModifiedDate": 1547837788.189,
"AdminCreateUserConfig": {
"UnusedAccountValidityDays": 7,
"AllowAdminCreateUserOnly": false
},
"EmailConfiguration": {
"ReplyToEmailAddress": "jane@example.com",
"SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/jane@example.com"
},
"Policies": {
"PasswordPolicy": {
"RequireLowercase": true,
"RequireSymbols": true,
"RequireNumbers": true,
"MinimumLength": 8,
"RequireUppercase": true
}
},
"UsernameAttributes": [
"email"
],
"CreationDate": 1547837788.189,
"EstimatedNumberOfUsers": 0,
"Id": "us-west-2_aaaaaaaaa",
"LambdaConfig": {}
}
}
Вывод
UserPool -> (структура)
Подробности созданного пула пользователей.
Id -> (строка)
Name -> (строка)
Policies -> (структура)
Список политик пула пользователей. Содержит политику, устанавливающую требования к сложности паролей.
PasswordPolicy -> (структура)
Настройки политики паролей для пула пользователей, включая требования к сложности, истории и длине.
MinimumLength -> (целое число)
RequireUppercase -> (булево)
RequireLowercase -> (булево)
RequireNumbers -> (булево)
RequireSymbols -> (булево)
PasswordHistorySize -> (целое число)
n предыдущих паролей, где n — значение PasswordHistorySize.TemporaryPasswordValidityDays -> (целое число)
Количество дней, в течение которых временный пароль действителен в политике паролей. Если пользователь не войдёт в систему в течение этого времени, администратор должен сбросить его пароль. Значение по умолчанию — 7. Если вы передаёте значение 0, Amazon Cognito обрабатывает его как значение null и устанавливает TemporaryPasswordValidityDays на значение по умолчанию.
Примечание
Когда вы устанавливаетеTemporaryPasswordValidityDays для пула пользователей, вы больше не можете установить значение для устаревшего параметра UnusedAccountValidityDays в этом пуле пользователей.SignInPolicy -> (структура)
Политика разрешённых типов аутентификации в пуле пользователей.
AllowedFirstAuthFactors -> (список)
Методы входа в систему, поддерживаемые пулом пользователей в качестве первого фактора. Вы можете разрешить пользователям начинать аутентификацию с использованием стандартного имени пользователя и пароля или с другими одноразовыми паролями и аппаратными факторами.
(строка)
DeletionProtection -> (строка)
При включении DeletionProtection предотвращается случайное удаление вашего пула пользователей. Прежде чем вы сможете удалить пул пользователей, защищённый от удаления, вам необходимо отключить эту функцию.
При попытке удалить защищённый пул пользователей в запросе API DeleteUserPool Amazon Cognito возвращает ошибку InvalidParameterException. Чтобы удалить защищённый пул пользователей, отправьте новый запрос DeleteUserPool после отключения защиты от удаления в запросе API UpdateUserPool.
LambdaConfig -> (структура)
Коллекция триггеров Lambda для пула пользователей. Amazon Cognito вызывает триггеры на нескольких возможных этапах операций с пулом пользователей. Триггеры могут изменить результат операций, которые их вызвали.
PreSignUp -> (строка)
CustomMessage -> (строка)
PostConfirmation -> (строка)
PreAuthentication -> (строка)
PostAuthentication -> (строка)
DefineAuthChallenge -> (строка)
CreateAuthChallenge -> (строка)
VerifyAuthChallengeResponse -> (строка)
PreTokenGeneration -> (строка)
Устаревшая настройка триггера Lambda перед генерацией токена в пуле пользователей.
Установите этот параметр для устаревших целей. Если вы также установите значение ARN в PreTokenGenerationConfig, его значение должно быть идентично PreTokenGeneration. Для новых экземпляров триггеров перед генерацией токена установите LambdaArn для PreTokenGenerationConfig.
UserMigration -> (строка)
PreTokenGenerationConfig -> (структура)
Подробная настройка триггера Lambda перед генерацией токена в пуле пользователей. Если вы также установите значение ARN в PreTokenGeneration, его значение должно быть идентично PreTokenGenerationConfig.
LambdaVersion -> (строка)
LambdaArn -> (строка)
Amazon Resource Name (ARN) функции, которую вы хотите назначить своему триггеру Lambda.
Этот параметр и свойство PreTokenGeneration объекта LambdaConfig имеют одинаковое значение. Для новых экземпляров триггеров перед генерацией токена установите LambdaArn.
CustomSMSSender -> (структура)
Настройка триггера Lambda для пользовательского отправителя SMS. Этот триггер перенаправляет все SMS-уведомления из пула пользователей в функцию Lambda, которая отправляет сообщение с использованием пользовательской логики.
LambdaVersion -> (строка)
Версия триггера пула пользователей запроса, который Amazon Cognito отправляет вашей функции Lambda. Версии с более высокими номерами добавляют поля, которые поддерживают новые функции.
Вы должны использовать LambdaVersion с V1_0 для функции пользовательского отправителя.
LambdaArn -> (строка)
CustomEmailSender -> (структура)
Настройка триггера Lambda для пользовательского отправителя электронных писем. Этот триггер перенаправляет все электронные письма из пула пользователей в функцию Lambda, которая отправляет сообщение с использованием пользовательской логики.
LambdaVersion -> (строка)
Версия триггера пула пользователей запроса, который Amazon Cognito отправляет вашей функции Lambda. Версии с более высокими номерами добавляют поля, которые поддерживают новые функции.
Вы должны использовать LambdaVersion с V1_0 для функции пользовательского отправителя.
LambdaArn -> (строка)
KMSKeyID -> (строка)
Status -> (строка)
LastModifiedDate -> (отметка времени)
Date.CreationDate -> (отметка времени)
Date.SchemaAttributes -> (список)
Список атрибутов пользователя и их свойств в вашем пуле пользователей. Схема атрибутов содержит стандартные атрибуты, пользовательские атрибуты с префиксом custom:, и атрибуты разработчика с префиксом dev:. Для получения дополнительной информации см. атрибуты пула пользователей.
Атрибуты только для разработчиков — это устаревшая функция пулов пользователей и доступны только для чтения всем клиентам приложений. Вы можете создавать и обновлять атрибуты только для разработчиков только с помощью операций API с аутентификацией IAM. Используйте разрешения на чтение/запись клиента приложения вместо этого.
(структура)
Список атрибутов пользователя и их свойств в вашем пуле пользователей. Схема атрибутов содержит стандартные атрибуты, пользовательские атрибуты с префиксом custom:, и атрибуты разработчика с префиксом dev:. Для получения дополнительной информации см. атрибуты пула пользователей.
Атрибуты только для разработчиков dev: — это устаревшая функция пулов пользователей и доступны только для чтения всем клиентам приложений. Вы можете создавать и обновлять атрибуты только для разработчиков только с помощью операций API с аутентификацией IAM. Используйте разрешения на чтение/запись клиента приложения вместо этого.
Имя -> (строка)
Name равным MyAttribute, Amazon Cognito создает пользовательский атрибут custom:MyAttribute. Когда DeveloperOnlyAttribute равно true, Amazon Cognito создает ваш атрибут как dev:MyAttribute. В операции, описывающей пул пользователей, Amazon Cognito возвращает это значение как value для стандартных атрибутов, custom:value для пользовательских атрибутов и dev:value для атрибутов только для разработчиков.ТипДанныхАтрибута -> (строка)
AttributeDataType, Amazon Cognito проверяет входные данные на соответствие типу данных. Значение пользовательского атрибута в вашем токен ID пользователя всегда является строкой, например, "custom:isMember" : "true" или "custom:YearsAsMember" : "12".ТолькоДляРазработчиков -> (булево)
Примечание
Вы должны использовать WriteAttributes в клиенте пула пользователей для управления тем, как атрибуты могут быть изменены для новых случаев использования вместо использованияDeveloperOnlyAttribute.Указывает, является ли тип атрибута только для разработчиков. Этот атрибут может быть изменён только администратором. Пользователи не смогут изменить этот атрибут с помощью своего маркера доступа. Например, DeveloperOnlyAttribute может быть изменён с помощью AdminUpdateUserAttributes, но не может быть обновлён с помощью UpdateUserAttributes.
Изменяемый -> (булево)
Указывает, можно ли изменить значение атрибута.
Любой атрибут пула пользователей, значение которого вы отображаете из атрибута IdP, должен быть изменяемым со значением параметра true. Amazon Cognito обновляет сопоставленные атрибуты, когда пользователи входят в вашу систему через IdP. Если атрибут неизменяем, Amazon Cognito возвращает ошибку при попытке обновить атрибут. Для получения дополнительной информации см. Указание сопоставлений атрибутов поставщика идентификации для вашего пула пользователей.
Обязательный -> (булево)
ОграниченияЧисловыхАтрибутов -> (структура)
Указывает ограничения для атрибута типа числовой.
МинимальноеЗначение -> (строка)
МаксимальноеЗначение -> (строка)
2^1023, представленным в виде строки длиной 131072 символов или меньше.ОграниченияСтроковыхАтрибутов -> (структура)
Указывает ограничения для атрибута строкового типа.
МинимальнаяДлина -> (строка)
МаксимальнаяДлина -> (строка)
2^1023, представленным в виде строки длиной 131072 символов или меньше.АвтоПроверяемыеАтрибуты -> (список)
Атрибуты, которые автоматически проверяются в пуле пользователей.
(строка)
АтрибутыПсевдонима -> (список)
Атрибуты, поддерживаемые в качестве псевдонима для этого пула пользователей. Псевдоним — это атрибут, который пользователи могут ввести в качестве альтернативного имени пользователя. Возможные значения: номер_телефона , электронная_почта или предпочтительное_имя_пользователя .
(строка)
АтрибутыИмениПользователя -> (список)
Указывает, может ли пользователь использовать адрес электронной почты или номер телефона в качестве имени пользователя при регистрации.
(строка)
СообщениеSMSверификации -> (строка)
СообщениеЭлектроннойПочтыверификации -> (строка)
ТемаЭлектроннойПочтыверификации -> (строка)
ШаблонСообщенияверификации -> (структура)
Шаблон сообщения проверки, которое ваш пул пользователей отправляет пользователям, установившим атрибуты адреса электронной почты или номера телефона.
СообщениеSMS -> (строка)
СообщениеЭлектроннойПочты -> (строка)
EmailMessage только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда ваш EmailSendingAccount равен DEVELOPER, ваш пул пользователей отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.ТемаЭлектроннойПочты -> (строка)
EmailSubject только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда ваш EmailSendingAccount равен DEVELOPER, ваш пул пользователей отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.СообщениеЭлектроннойПочтыСсылка -> (строка)
EmailMessageByLink только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда ваш EmailSendingAccount равен DEVELOPER, ваш пул пользователей отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.ТемаЭлектроннойПочтыСсылка -> (строка)
EmailSubjectByLink только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда ваш EmailSendingAccount равен DEVELOPER, ваш пул пользователей отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.По умолчаниюОпцияЭлектроннойПочты -> (строка)
Настройка сообщений электронной почты проверки, которые будут содержать нажимаемую ссылку или код проверки.
Для ссылки, тело вашего шаблона должно содержать текст ссылки в формате {##Click here##}. «Нажмите здесь» в примере — это настраиваемая строка. Для кода, тело вашего шаблона должно содержать заполнитель кода в формате {####}.
СообщениеАвторизацииSMS -> (строка)
НастройкиОбновленияАтрибутовПользователя -> (структура)
Настройки обновлений атрибутов пользователей. Эти настройки включают свойство AttributesRequireVerificationBeforeUpdate, настройка пула пользователей, которая сообщает Amazon Cognito, как обрабатывать изменения значения атрибутов электронной почты и номера телефона ваших пользователей. Для получения дополнительной информации см. Проверка обновлений адресов электронной почты и номеров телефонов.
АтрибутыТребуютПроверкиПередОбновлением -> (список)
Требует, чтобы ваш пользователь подтвердил свой адрес электронной почты, номер телефона или оба перед тем, как Amazon Cognito обновит значение этого атрибута. При обновлении атрибута пользователя с активированной этой опцией Amazon Cognito отправляет сообщение проверки на новый номер телефона или адрес электронной почты. Amazon Cognito не изменяет значение атрибута до тех пор, пока ваш пользователь не ответит на сообщение проверки и не подтвердит новое значение.
Когда AttributesRequireVerificationBeforeUpdate равно false, ваш пул пользователей не требует, чтобы пользователи проверяли изменения атрибутов перед обновлением их Amazon Cognito. В пуле пользователей, где AttributesRequireVerificationBeforeUpdate равно false, операции API, изменяющие значения атрибутов, могут немедленно обновить атрибут пользователя email или phone_number.
(строка)
НастройкаMFA -> (строка)
Может принимать одно из следующих значений:
-
OFF- Токены MFA не требуются и не могут быть указаны во время регистрации пользователя. -
ON- Токены MFA требуются для всех регистраций пользователей. Вы можете указать только требуемый, когда вы впервые создаете пул пользователей. -
OPTIONAL- Пользователи имеют возможность при регистрации создать токен MFA.
НастройкаУстройства -> (структура)
Настройка запоминания устройства для пула пользователей. Значение null указывает, что запоминание устройства в вашем пуле пользователей отключено.
Примечание
Когда вы предоставляете значение для любого поляDeviceConfiguration, вы активируете функцию запоминания устройства Amazon Cognito.ТребованиеПроверкиПриНовомУстройстве -> (булево)
При значении true, запомненное устройство может войти с помощью аутентификации устройства вместо SMS и одноразового пароля (TOTP) для многофакторной аутентификации (MFA).
Примечание
Вне зависимости от того, является лиChallengeRequiredOnNewDevice true или false, пользователи, которые входят с устройствами, которые не были подтверждены или запомнены, должны всё ещё предоставить второй фактор в пуле пользователей, требующем MFA.ЗапоминаниеУстройстваТолькоПриЗапросеПользователя -> (булево)
Если значение true, Amazon Cognito не запоминает устройство пользователя автоматически, когда ваше приложение отправляет запрос API ConfirmDevice. В приложении создайте запрос для пользователя, чтобы он выбрал, хочет ли он запомнить своё устройство. Возвратите выбор пользователя в запросе API UpdateDeviceStatus.
Если DeviceOnlyRememberedOnUserPrompt равно false, Amazon Cognito сразу запоминает устройства, которые вы регистрируете в запросе API ConfirmDevice.
ПриблизительноеЧислоПользователей -> (целое)
НастройкаЭлектроннойПочты -> (структура)
Настройка электронной почты для вашего пула пользователей. Тип настройки электронной почты определяет предпочитаемый метод отправки, регион Amazon Web Services и отправителя для сообщений из вашего пула пользователей.
SourceArn -> (строка)
ARN проверенного адреса электронной почты или адреса из проверенного домена в Amazon SES. Вы можете установить SourceArn электронную почту из проверенного домена только с помощью запроса API. Вы можете установить проверенный адрес электронной почты, но не адрес в проверенном домене, в консоли Amazon Cognito. Amazon Cognito использует адрес электронной почты, который вы предоставили, следующим образом, в зависимости от значения параметра EmailSendingAccount:
- Если вы укажете
COGNITO_DEFAULT, Amazon Cognito будет использовать этот адрес в качестве пользовательского адреса ОТПРАВЛЕНО от при отправке электронных писем вашим пользователям с помощью встроенной учетной записи электронной почты. - Если вы укажете
DEVELOPER, Amazon Cognito отправит электронные письма вашим пользователям, вызвав Amazon SES от вашего имени.
Значение параметра SourceArn должно указывать поддерживаемый регион Amazon Web Services для вашего пула пользователей. Обычно регион в параметре SourceArn и регион пула пользователей совпадают. Дополнительную информацию см. в руководстве разработчика Amazon Cognito в разделе Amazon SES email configuration regions.
ReplyToEmailAddress -> (строка)
EmailSendingAccount -> (строка)
Указывает, будет ли Amazon Cognito использовать встроенную функциональность для отправки электронных писем вашим пользователям или использовать вашу конфигурацию электронной почты Amazon Simple Email Service. Укажите одно из следующих значений:
Когда Amazon Cognito отправляет электронные письма вашим пользователям, он использует встроенную функциональность электронной почты. При использовании параметра по умолчанию Amazon Cognito разрешает только ограниченное количество электронных писем в день для вашего пула пользователей. Для типичных производственных сред предел по умолчанию для отправки электронных писем меньше требуемого объема доставки. Чтобы достичь более высокого объема доставки, укажите DEVELOPER, чтобы использовать вашу конфигурацию электронной почты Amazon SES.
Чтобы узнать предел доставки электронных писем для параметра по умолчанию, см. раздел Limits в руководстве разработчика Amazon Cognito.
Адрес ОТПРАВЛЕНО по умолчанию - no-reply@verificationemail.com. Чтобы настроить адрес ОТПРАВЛЕНО, укажите Amazon Resource Name (ARN) проверенного адреса электронной почты Amazon SES для параметра SourceArn.
При отправке электронных писем вашим пользователям Amazon Cognito использует вашу конфигурацию Amazon SES. Amazon Cognito вызывает Amazon SES от вашего имени для отправки электронной почты с вашего проверенного адреса электронной почты. При использовании этого параметра пределы доставки электронных писем совпадают с пределами, которые применяются к вашему проверенному адресу электронной почты Amazon SES в вашей учетной записи Amazon Web Services.
Если вы используете этот параметр, укажите ARN проверенного адреса электронной почты Amazon SES для параметра SourceArn.
Перед тем, как Amazon Cognito сможет отправить электронные письма вашим пользователям, ему потребуются дополнительные разрешения для вызова Amazon SES от вашего имени. При обновлении вашего пула пользователей с этим параметром Amazon Cognito создает связанную службу роль, которая является типом роли в вашей учетной записи Amazon Web Services. Эта роль содержит разрешения, которые позволяют вам получить доступ к Amazon SES и отправлять электронные письма с вашего адреса электронной почты. Дополнительную информацию о связанной службой роли, созданной Amazon Cognito, см. в руководстве разработчика Amazon Cognito в разделе Using Service-Linked Roles for Amazon Cognito.
From -> (строка)
testuser@example.com или Test User <testuser@example.com>. Этот адрес отображается перед телом электронного письма.ConfigurationSet -> (строка)
Набор правил конфигурации, которые могут применяться к электронным письмам, отправленным с помощью Amazon Simple Email Service. Набор конфигурации применяется к электронному письму путем включения ссылки на набор конфигурации в заголовки электронного письма. После применения все правила в этом наборе конфигурации применяются к электронному письму. Наборы конфигурации могут использоваться для применения следующих типов правил к электронным письмам:
Amazon Simple Email Service может отслеживать количество событий отправки, доставки, открытия, перехода по ссылкам, возврата и жалоб для каждого отправленного электронного письма. Используйте публикацию событий для отправки информации об этих событиях в другие службы Amazon Web Services, такие как Amazon CloudWatch.
При аренде выделенных IP-адресов с Amazon Simple Email Service вы можете создавать группы IP-адресов, называемые выделенными пулами IP-адресов. Затем вы можете назначить выделенные пулы IP-адресов наборам конфигурации.
SmsConfiguration -> (структура)
Настройка пула пользователей для доставки SMS-сообщений с помощью Amazon Simple Notification Service. Для отправки SMS-сообщений с Amazon SNS в нужном вам регионе Amazon Web Services пул пользователей Amazon Cognito использует роль Identity and Access Management (IAM) в вашей учетной записи Amazon Web Services.
SnsCallerArn -> (строка)
ExternalId -> (строка)
Внешний идентификатор обеспечивает дополнительную безопасность для вашей роли IAM. Вы можете использовать ExternalId с ролью IAM, которую вы используете с Amazon SNS для отправки SMS-сообщений для вашего пула пользователей. Если вы предоставите ExternalId, ваш пул пользователей Amazon Cognito включит его в запрос для принятия вашей роли IAM. Вы можете настроить политику доверия роли так, чтобы требовать, чтобы Amazon Cognito и любой субъект предоставляли ExternalID. Если вы используете консоль управления Amazon Cognito для создания роли для многофакторной аутентификации (MFA) по SMS, Amazon Cognito создаст роль с необходимыми разрешениями и политикой доверия, которая демонстрирует использование ExternalId.
Дополнительную информацию о ExternalId роли см. в разделе How to use an external ID when granting access to your Amazon Web Services resources to a third party.
SnsRegion -> (строка)
Регион Amazon Web Services для использования с интеграцией Amazon SNS. Вы можете выбрать тот же регион, что и ваш пул пользователей, или поддерживаемый альтернативный регион Amazon SNS Legacy.
Ресурсы Amazon Cognito в регионе Amazon Web Services Азия-Тихий океан (Сеул) должны использовать вашу конфигурацию Amazon SNS в регионе Азия-Тихий океан (Токио). Дополнительную информацию см. в разделе SMS message settings for Amazon Cognito user pools.
UserPoolTags -> (карта)
Теги, назначенные пулу пользователей. Тег — это метка, которую вы можете присвоить пулам пользователей для их категоризации и управления различными способами, например, по назначению, владельцу, среде или другим критериям.
key -> (строка)
value -> (строка)
SmsConfigurationFailure -> (строка)
Причина, по которой конфигурация SMS не может отправлять сообщения вашим пользователям.
Это сообщение может содержать значения, разделенные запятыми, чтобы описать причины, по которым ваша конфигурация SMS не может отправлять сообщения конечным пользователям пула пользователей.
Роль Identity and Access Management, которую Amazon Cognito использует для отправки SMS-сообщений, не настроена должным образом. Дополнительную информацию см. в разделе SmsConfigurationType.
Учетная запись Amazon Web Services находится в песочнице SMS SNS, и сообщения будут достигать только проверенных конечных пользователей. Этот параметр не будет заполнен SNSSandbox, если пользователь, создающий пул пользователей, не имеет разрешений SNS. Узнайте, как вывести свою учетную запись Amazon Web Services из песочницы, в разделе Moving out of the SMS sandbox.
EmailConfigurationFailure -> (строка)
EventSource:cognito-idp.amazonaws.com в CloudTrail, чтобы получить информацию о проблемах с настройкой электронной почты пула пользователей.Domain -> (строка)
CustomDomain -> (строка)
Пользовательский домен, который вы предоставляете Amazon Cognito. Этот параметр применяется только в том случае, если вы используете пользовательский домен для размещения страниц регистрации и входа в свой приложения. Пример пользовательского доменного имени может быть auth.example.com.
Дополнительную информацию о добавлении пользовательского домена в ваш пул пользователей см. в разделе Using Your Own Domain for the Hosted UI.
AdminCreateUserConfig -> (структура)
Конфигурация запросов AdminCreateUser.
AllowAdminCreateUserOnly -> (логическое значение)
true, только администраторы могут создавать новые профили пользователей. При значении false пользователи могут регистрироваться сами и создавать новый профиль пользователя с помощью операции SignUp.UnusedAccountValidityDays -> (целое число)
Этот параметр больше не используется.
Срок действия пароля в днях для пользователей, созданных администратором. После истечения этого срока пользователь не сможет войти в систему с временным паролем. Чтобы сбросить учетную запись после истечения этого срока, необходимо снова вызвать AdminCreateUser, указав RESEND для параметра MessageAction.
Значение параметра по умолчанию — 7.
InviteMessageTemplate -> (структура)
Шаблон приветственного сообщения для новых пользователей. Этот шаблон должен включать заполнитель временного пароля {####}, если вы создаете пользователей с паролями. Если у ваших пользователей нет паролей, вы можете опустить этот заполнитель.
См. также Customizing User Invitation Messages.
SMSMessage -> (строка)
EmailMessage -> (строка)
EmailSubject -> (строка)
UserPoolAddOns -> (структура)
Содержит настройки для активации защиты от угроз, включая режим работы и дополнительные типы аутентификации. Чтобы регистрировать информацию о безопасности пользователя, но не предпринимать никаких действий, установите значение AUDIT. Чтобы настроить автоматические ответы системы безопасности на потенциально нежелательный трафик для вашего пула пользователей, установите значение ENFORCED.
Дополнительную информацию см. в разделе Adding advanced security to a user pool. Для активации этой настройки ваш пул пользователей должен быть на уровне Plus.
AdvancedSecurityMode -> (строка)
AdvancedSecurityAdditionalFlows -> (структура)
Параметры конфигурации защиты от угроз для дополнительных типов аутентификации в вашем пуле пользователей, включая пользовательскую аутентификацию.
CustomAuthMode -> (строка)
UsernameConfiguration -> (структура)
Чувствительность к регистру имени пользователя для выбранного варианта входа. Если чувствительность к регистру установлена в значение False (не учитывается регистр), пользователи могут войти в систему, используя любую комбинацию заглавных и строчных букв. Например, username , USERNAME , или UserName , или для почты, email@example.com или EMaiL@eXamplE.Com . Для большинства случаев рекомендуется установить чувствительность к регистру в значение False (не учитывается регистр). Когда имена пользователей и адреса электронной почты нечувствительны к регистру, Amazon Cognito рассматривает любые вариации регистра как одного и того же пользователя и предотвращает присвоение варианта регистра одному и тому же атрибуту для разных пользователей.
CaseSensitive -> (boolean)
Указывает, будет ли применяться чувствительность к регистру имени пользователя для всех пользователей в пользовательском пуле через Amazon Cognito API. Для большинства случаев рекомендуется установить чувствительность к регистру в значение False (не учитывается регистр). Когда имена пользователей и адреса электронной почты нечувствительны к регистру, пользователи могут войти в систему как один и тот же пользователь, если они введут имя пользователя с другой прописностью.
Допустимые значения включают:
Включает чувствительность к регистру для всех вводимых имен пользователей. При установке этого параметра в значение true пользователи должны войти в систему, используя точное написание своего имени пользователя, например, «UserName». Это значение по умолчанию.
Включает нечувствительность к регистру для всех вводимых имен пользователей. Например, при установке этого параметра в значение false пользователи могут войти в систему, используя username , USERNAME , или UserName . Этот параметр также делает нечувствительными к регистру алиасы preferred_username и email, а также атрибут username.
Arn -> (string)
AccountRecoverySetting -> (structure)
Доступные проверенные методы, которые пользователь может использовать для восстановления пароля, когда он выполняет ForgotPassword. Вы можете использовать эту настройку для определения предпочтительного метода, когда у пользователя доступно более одного метода. При этой настройке SMS не подходит для действительного механизма восстановления пароля, если у пользователя также активирована двухфакторная аутентификация (MFA) по SMS. В отсутствие этой настройки Amazon Cognito использует устаревшее поведение, в котором SMS предпочтительнее электронной почты.
RecoveryMechanisms -> (list)
Список вариантов и приоритетов для доставки сообщений пользователям в операциях сброса пароля. Устанавливает или отображает предпочтения пользовательского пула для приоритета сообщений по электронной почте или SMS, должно ли пользователям быть предоставлен резервный способ доставки, и должны ли пароли сбрасываться только администраторами.
(structure)
Вариант восстановления для пользователя. Данные типа AccountRecoverySettingType представляют собой массив этого объекта. Каждый RecoveryOptionType имеет свойство priority, которое определяет, является ли это основной или дополнительной опцией.
Например, если у verified_email приоритет 1, а у verified_phone_number приоритет 2, ваш пользовательский пул отправляет сообщения о восстановлении учетной записи на подтвержденный адрес электронной почты, но переходит на SMS-сообщение, если у пользователя есть подтвержденный номер телефона. Вариант admin_only предотвращает самообслуживание при восстановлении учетной записи.
Priority -> (integer)
1 .Name -> (string)
UserPoolTier -> (string)
ESSENTIALS .
© Copyright 2025, Amazon Web Services. Created using Sphinx.
