userAttributes
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 AdminCreateUser
request, you can set the email_verified
and phone_number_verified
attributes to true
. The following conditions apply:
The email address where you want the user to receive their confirmation code and username. You must provide a value for email
when you want to set email_verified
to true
, or if you set EMAIL
in the DesiredDeliveryMediums
parameter.
phone_number
The phone number where you want the user to receive their confirmation code and username. You must provide a value for phone_number
when you want to set phone_number_verified
to true
, or if you set SMS
in the DesiredDeliveryMediums
parameter.