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.
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
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class AdminCreateUserRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AdminCreateUserRequest type exposes the following members
Name | Description | |
---|---|---|
AdminCreateUserRequest() |
Name | Type | Description | |
---|---|---|---|
ClientMetadata | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property ClientMetadata. 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 For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
|
|
DesiredDeliveryMediums | System.Collections.Generic.List<System.String> |
Gets and sets the property DesiredDeliveryMediums.
Specify |
|
ForceAliasCreation | System.Boolean |
Gets and sets the property ForceAliasCreation.
This parameter is used only if the
If this parameter is set to
If this parameter is set to |
|
MessageAction | Amazon.CognitoIdentityProvider.MessageActionType |
Gets and sets the property MessageAction.
Set to |
|
TemporaryPassword | System.String |
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 isn't required. If you don't specify a value, Amazon Cognito generates one for you.
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
|
|
UserAttributes | System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.AttributeType> |
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
other than
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. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to
|
|
Username | System.String |
Gets and sets the property Username. The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The user pool ID for the user pool where the user will be created. |
|
ValidationData | System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.AttributeType> |
Gets and sets the property ValidationData. 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. |
This request submits a value for all possible parameters for AdminCreateUser.
var client = new AmazonCognitoIdentityProviderClient(); var response = client.AdminCreateUser(new AdminCreateUserRequest { DesiredDeliveryMediums = new List<string> { "SMS" }, MessageAction = "SUPPRESS", TemporaryPassword = "This-is-my-test-99!", UserAttributes = new List<AttributeType> { new AttributeType { Name = "name", Value = "John" }, new AttributeType { Name = "phone_number", Value = "+12065551212" }, new AttributeType { Name = "email", Value = "testuser@example.com" } }, UserPoolId = "us-east-1_EXAMPLE", Username = "testuser" }); UserType user = response.User;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5