AdminCreateUserConfigType
The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
Contents
- AllowAdminCreateUserOnly
-
The setting for allowing self-service sign-up. When
true, only administrators can create new user profiles. Whenfalse, users can register themselves and create a new user profile with the SignUp operation.Type: Boolean
Required: No
- InviteMessageTemplate
-
The template for the welcome message to new users. This template must include the
{####}temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.See also Customizing User Invitation Messages.
Type: MessageTemplateType object
Required: No
- UnusedAccountValidityDays
-
This parameter is no longer in use. Configure the duration of temporary passwords with the
TemporaryPasswordValidityDaysparameter of PasswordPolicyType. For older user pools that have aUnusedAccountValidityDaysconfiguration, that value is effective until you set a value forTemporaryPasswordValidityDays.The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. To reset the account after that time limit, you must call
AdminCreateUseragain, specifyingRESENDfor theMessageActionparameter.The default value for this parameter is 7.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 365.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
