CognitoIdentityProvider / Client / admin_create_user

admin_create_user

CognitoIdentityProvider.Client.admin_create_user(**kwargs)

Creates a new user in the specified user pool.

If MessageAction isn’t set, the default is to send a welcome message via email or phone (SMS).

Note

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won’t send any email.

In either case, if the user has a password, they will be in the FORCE_CHANGE_PASSWORD state until they sign in and set their password. Your invitation message template must have the {####} password placeholder if your users have passwords. If your template doesn’t have this placeholder, Amazon Cognito doesn’t deliver the invitation message. In this case, you must update your message template and resend the password with a new AdminCreateUser request with a MessageAction value of RESEND.

Note

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

See also: AWS API Documentation

Request Syntax

response = client.admin_create_user(
    UserPoolId='string',
    Username='string',
    UserAttributes=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ValidationData=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    TemporaryPassword='string',
    ForceAliasCreation=True|False,
    MessageAction='RESEND'|'SUPPRESS',
    DesiredDeliveryMediums=[
        'SMS'|'EMAIL',
    ],
    ClientMetadata={
        'string': 'string'
    }
)

Parameters:

• UserPoolId (string) –

  [REQUIRED]

  The ID of the user pool where you want to create a user.

• Username (string) –

  [REQUIRED]

  The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.

  • The username can’t be a duplicate of another username in the same user pool.

  • You can’t change the value of a username after you create it.

  • You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.

• UserAttributes (list) –

  An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign up in response to your welcome message).

  For custom attributes, you must prepend the custom: prefix to the attribute name.

  To send a message inviting the user to sign up, you must specify the user’s email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

  You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don’t submit a TemporaryPassword.

  In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. You can also do this by calling AdminUpdateUserAttributes.

  • email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.

  • phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.

  • (dict) –

    The name and value of a user attribute.

    This data type is a request parameter of AdminUpdateUserAttributes and UpdateUserAttributes.

    • Name (string) – [REQUIRED]

      The name of the attribute.

    • Value (string) –

      The value of the attribute.

• ValidationData (list) –

  Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don’t need to retain.

  Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.

  For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

  • (dict) –

    The name and value of a user attribute.

    This data type is a request parameter of AdminUpdateUserAttributes and UpdateUserAttributes.

    • Name (string) – [REQUIRED]

      The name of the attribute.

    • Value (string) –

      The value of the attribute.

• TemporaryPassword (string) –

  The user’s temporary password. This password must conform to the password policy that you specified when you created the user pool.

  The exception to the requirement for a password is when your user pool supports passwordless sign-in with email or SMS OTPs. To create a user with no password, omit this parameter or submit a blank value. You can only create a passwordless user when passwordless sign-in is available. See the SignInPolicyType property of CreateUserPool and UpdateUserPool.

  The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.

  If you don’t specify a value, Amazon Cognito generates one for you unless you have passwordless options active for your user pool.

  The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify RESEND for the MessageAction parameter.

• ForceAliasCreation (boolean) –

  This parameter is used only if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.

  If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias.

  If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.

• MessageAction (string) – Set to RESEND to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to SUPPRESS to suppress sending the message. You can specify only one value.

• DesiredDeliveryMediums (list) –

  Specify EMAIL if email will be used to send the welcome message. Specify SMS if the phone number will be used. The default value is SMS. You can specify more than one value.

  • (string) –

• ClientMetadata (dict) –

  A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

  You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a ClientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

  For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

  Note

  When you use the ClientMetadata parameter, note that Amazon Cognito won’t do the following:

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn’t include triggers, the ClientMetadata parameter serves no purpose.

  • Validate the ClientMetadata value.

  • Encrypt the ClientMetadata value. Don’t send sensitive information in this parameter.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'User': {
        'Username': 'string',
        'Attributes': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'UserCreateDate': datetime(2015, 1, 1),
        'UserLastModifiedDate': datetime(2015, 1, 1),
        'Enabled': True|False,
        'UserStatus': 'UNCONFIRMED'|'CONFIRMED'|'ARCHIVED'|'COMPROMISED'|'UNKNOWN'|'RESET_REQUIRED'|'FORCE_CHANGE_PASSWORD'|'EXTERNAL_PROVIDER',
        'MFAOptions': [
            {
                'DeliveryMedium': 'SMS'|'EMAIL',
                'AttributeName': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  Represents the response from the server to the request to create the user.

  • User (dict) –

    The new user’s profile details.

    • Username (string) –

      The user’s username.

    • Attributes (list) –

      Names and values of a user’s attributes, for example email.

      • (dict) –

        The name and value of a user attribute.

        This data type is a request parameter of AdminUpdateUserAttributes and UpdateUserAttributes.

        • Name (string) –

          The name of the attribute.

        • Value (string) –

          The value of the attribute.

    • UserCreateDate (datetime) –

      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

    • UserLastModifiedDate (datetime) –

      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

    • Enabled (boolean) –

      Indicates whether the user’s account is enabled or disabled.

    • UserStatus (string) –

      The user status. This can be one of the following:

      • UNCONFIRMED - User has been created but not confirmed.

      • CONFIRMED - User has been confirmed.

      • EXTERNAL_PROVIDER - User signed in with a third-party IdP.

      • UNKNOWN - User status isn’t known.

      • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

      • FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

    • MFAOptions (list) –

      The user’s MFA configuration.

      • (dict) –

        This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.

        • DeliveryMedium (string) –

          The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

        • AttributeName (string) –

          The attribute name of the MFA option type. The only valid value is phone_number.

Exceptions

• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

• CognitoIdentityProvider.Client.exceptions.InvalidParameterException

• CognitoIdentityProvider.Client.exceptions.UserNotFoundException

• CognitoIdentityProvider.Client.exceptions.UsernameExistsException

• CognitoIdentityProvider.Client.exceptions.InvalidPasswordException

• CognitoIdentityProvider.Client.exceptions.CodeDeliveryFailureException

• CognitoIdentityProvider.Client.exceptions.UnexpectedLambdaException

• CognitoIdentityProvider.Client.exceptions.UserLambdaValidationException

• CognitoIdentityProvider.Client.exceptions.InvalidLambdaResponseException

• CognitoIdentityProvider.Client.exceptions.PreconditionNotMetException

• CognitoIdentityProvider.Client.exceptions.InvalidSmsRoleAccessPolicyException

• CognitoIdentityProvider.Client.exceptions.InvalidSmsRoleTrustRelationshipException

• CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

• CognitoIdentityProvider.Client.exceptions.UnsupportedUserStateException

• CognitoIdentityProvider.Client.exceptions.InternalErrorException