Skip to content

AdminCreateUserConfigType

Used by
Source code in docs_src/capo_cognito_identity_provider/types/admin_create_user_config_type.py 
13
14
15
16
17
18
19
20
21
22
23
class AdminCreateUserConfigType(TypedDict, closed=True):
    allow_admin_create_user_only: (
        "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    )
    """<p>The setting for allowing self-service sign-up. When <code>true</code>, only administrators can create new user profiles. When <code>false</code>, users can register themselves and create a new user profile with the <code>SignUp</code> operation.</p>"""
    unused_account_validity_days: "capo_cognito_identity_provider.types.admin_create_user_unused_account_validity_days_type.AdminCreateUserUnusedAccountValidityDaysType"
    """<p>This parameter is no longer in use.</p> <p>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 <code>AdminCreateUser</code> again, specifying <code>RESEND</code> for the <code>MessageAction</code> parameter. </p> <p>The default value for this parameter is 7.</p>"""
    invite_message_template: NotRequired[
        "capo_cognito_identity_provider.types.message_template_type.MessageTemplateType"
    ]
    """<p>The template for the welcome message to new users. This template must include the <code>{####}</code> temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.</p> <p>See also <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization">Customizing User Invitation Messages</a>.</p>"""

allow_admin_create_user_only instance-attribute 

allow_admin_create_user_only: BooleanType

The setting for allowing self-service sign-up. When true, only administrators can create new user profiles. When false, users can register themselves and create a new user profile with the SignUp operation.

invite_message_template instance-attribute 

invite_message_template: NotRequired[MessageTemplateType]

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.

unused_account_validity_days instance-attribute 

unused_account_validity_days: AdminCreateUserUnusedAccountValidityDaysType

This parameter is no longer in use.

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 AdminCreateUser again, specifying RESEND for the MessageAction parameter.

The default value for this parameter is 7.