adminCreateUser

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).

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 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, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.

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

Samples

import aws.sdk.kotlin.services.cognitoidentityprovider.model.AttributeType
import aws.sdk.kotlin.services.cognitoidentityprovider.model.DeliveryMediumType
fun main() { 
   //sampleStart 
   // This request submits a value for all possible parameters for AdminCreateUser.
val resp = cognitoIdentityProviderClient.adminCreateUser {
    userPoolId = "us-east-1_EXAMPLE"
    username = "testuser"
    desiredDeliveryMediums = listOf<DeliveryMediumType>(
        DeliveryMediumType.fromValue("SMS")
    )
    messageAction = MessageActionType.fromValue("SUPPRESS")
    temporaryPassword = "This-is-my-test-99!"
    userAttributes = listOf<AttributeType>(
        AttributeType {
            name = "name"
            value = "John"
        },
        AttributeType {
            name = "phone_number"
            value = "+12065551212"
        },
        AttributeType {
            name = "email"
            value = "testuser@example.com"
        }            
    )
} 
   //sampleEnd
}