AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the AdminCreateUser operation. Creates a new user in the specified user pool.
MessageAction is not set, the default is to send a welcome message
via email or phone (SMS).
This message is based on a template that you configured in your call to or . 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
parameter, and Amazon Cognito will not send any email.
In either case, the user will be in the
FORCE_CHANGE_PASSWORD state until
they sign in and change their password.
AdminCreateUser requires developer credentials.
public class AdminCreateUserRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AdminCreateUserRequest type exposes the following members
Gets and sets the property DesiredDeliveryMediums.
Gets and sets the property ForceAliasCreation.
This parameter is only used if the
If this parameter is set to
If this parameter is set to
Gets and sets the property MessageAction.
Gets and sets the property TemporaryPassword.
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
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.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that
you specified when you created the user pool. To reset the account after that time
limit, you must call
Gets and sets the property 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
For custom attributes, you must prepend the
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to
Gets and sets the property Username.
The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
Gets and sets the property UserPoolId.
The user pool ID for the user pool where the user will be created.
Gets and sets the property ValidationData.
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
Supported in: 1.3
Supported in: 4.5, 4.0, 3.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms