Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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 <https:docs.aws.amazon.comsnslatestdgsns-sms-sandbox.html 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.
AdminCreateUser
requires developer credentials.
Synopsis
- data AdminCreateUser = AdminCreateUser' {
- clientMetadata :: Maybe (HashMap Text Text)
- desiredDeliveryMediums :: Maybe [DeliveryMediumType]
- forceAliasCreation :: Maybe Bool
- messageAction :: Maybe MessageActionType
- temporaryPassword :: Maybe (Sensitive Text)
- userAttributes :: Maybe [AttributeType]
- validationData :: Maybe [AttributeType]
- userPoolId :: Text
- username :: Sensitive Text
- newAdminCreateUser :: Text -> Text -> AdminCreateUser
- adminCreateUser_clientMetadata :: Lens' AdminCreateUser (Maybe (HashMap Text Text))
- adminCreateUser_desiredDeliveryMediums :: Lens' AdminCreateUser (Maybe [DeliveryMediumType])
- adminCreateUser_forceAliasCreation :: Lens' AdminCreateUser (Maybe Bool)
- adminCreateUser_messageAction :: Lens' AdminCreateUser (Maybe MessageActionType)
- adminCreateUser_temporaryPassword :: Lens' AdminCreateUser (Maybe Text)
- adminCreateUser_userAttributes :: Lens' AdminCreateUser (Maybe [AttributeType])
- adminCreateUser_validationData :: Lens' AdminCreateUser (Maybe [AttributeType])
- adminCreateUser_userPoolId :: Lens' AdminCreateUser Text
- adminCreateUser_username :: Lens' AdminCreateUser Text
- data AdminCreateUserResponse = AdminCreateUserResponse' {
- user :: Maybe UserType
- httpStatus :: Int
- newAdminCreateUserResponse :: Int -> AdminCreateUserResponse
- adminCreateUserResponse_user :: Lens' AdminCreateUserResponse (Maybe UserType)
- adminCreateUserResponse_httpStatus :: Lens' AdminCreateUserResponse Int
Creating a Request
data AdminCreateUser Source #
Represents the request to create a user in the specified user pool.
See: newAdminCreateUser
smart constructor.
AdminCreateUser' | |
|
Instances
Create a value of AdminCreateUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:AdminCreateUser'
, adminCreateUser_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 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.
When you use the ClientMetadata parameter, remember 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 use Amazon Cognito to provide sensitive information.
$sel:desiredDeliveryMediums:AdminCreateUser'
, adminCreateUser_desiredDeliveryMediums
- 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.
$sel:forceAliasCreation:AdminCreateUser'
, adminCreateUser_forceAliasCreation
- 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, the API call will migrate 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
.
$sel:messageAction:AdminCreateUser'
, adminCreateUser_messageAction
- Set to RESEND
to resend the invitation message to a user that already
exists and reset the expiration limit on the user's account. Set to
SUPPRESS
to suppress sending the message. You can specify only one
value.
$sel:temporaryPassword:AdminCreateUser'
, adminCreateUser_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 specified when you created the user pool. To
reset the account after that time limit, you must call AdminCreateUser
again, specifying "RESEND"
for the MessageAction
parameter.
$sel:userAttributes:AdminCreateUser'
, adminCreateUser_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.
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 toTrue
, or if"EMAIL"
is specified in theDesiredDeliveryMediums
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 toTrue
, or if"SMS"
is specified in theDesiredDeliveryMediums
parameter.
$sel:validationData:AdminCreateUser'
, adminCreateUser_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 isn't persisted.
AdminCreateUser
, adminCreateUser_userPoolId
- The user pool ID for the user pool where the user will be created.
AdminCreateUser
, adminCreateUser_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 can't be changed.
Request Lenses
adminCreateUser_clientMetadata :: Lens' AdminCreateUser (Maybe (HashMap Text Text)) Source #
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.
When you use the ClientMetadata parameter, remember 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 use Amazon Cognito to provide sensitive information.
adminCreateUser_desiredDeliveryMediums :: Lens' AdminCreateUser (Maybe [DeliveryMediumType]) Source #
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.
adminCreateUser_forceAliasCreation :: Lens' AdminCreateUser (Maybe Bool) Source #
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, the API call will migrate 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
.
adminCreateUser_messageAction :: Lens' AdminCreateUser (Maybe MessageActionType) Source #
Set to RESEND
to resend the invitation message to a user that already
exists and reset the expiration limit on the user's account. Set to
SUPPRESS
to suppress sending the message. You can specify only one
value.
adminCreateUser_temporaryPassword :: Lens' AdminCreateUser (Maybe Text) Source #
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 specified when you created the user pool. To
reset the account after that time limit, you must call AdminCreateUser
again, specifying "RESEND"
for the MessageAction
parameter.
adminCreateUser_userAttributes :: Lens' AdminCreateUser (Maybe [AttributeType]) Source #
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.
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 toTrue
, or if"EMAIL"
is specified in theDesiredDeliveryMediums
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 toTrue
, or if"SMS"
is specified in theDesiredDeliveryMediums
parameter.
adminCreateUser_validationData :: Lens' AdminCreateUser (Maybe [AttributeType]) Source #
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 isn't persisted.
adminCreateUser_userPoolId :: Lens' AdminCreateUser Text Source #
The user pool ID for the user pool where the user will be created.
adminCreateUser_username :: Lens' AdminCreateUser Text Source #
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 can't be changed.
Destructuring the Response
data AdminCreateUserResponse Source #
Represents the response from the server to the request to create the user.
See: newAdminCreateUserResponse
smart constructor.
AdminCreateUserResponse' | |
|
Instances
newAdminCreateUserResponse Source #
Create a value of AdminCreateUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:user:AdminCreateUserResponse'
, adminCreateUserResponse_user
- The newly created user.
$sel:httpStatus:AdminCreateUserResponse'
, adminCreateUserResponse_httpStatus
- The response's http status code.
Response Lenses
adminCreateUserResponse_user :: Lens' AdminCreateUserResponse (Maybe UserType) Source #
The newly created user.
adminCreateUserResponse_httpStatus :: Lens' AdminCreateUserResponse Int Source #
The response's http status code.