Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a new user in the specified user pool.
If MessageAction
is not set, the default is to send a welcome message via email or phone (SMS).
Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction
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.
Synopsis
- adminCreateUser :: Text -> Text -> AdminCreateUser
- data AdminCreateUser
- acuTemporaryPassword :: Lens' AdminCreateUser (Maybe Text)
- acuForceAliasCreation :: Lens' AdminCreateUser (Maybe Bool)
- acuDesiredDeliveryMediums :: Lens' AdminCreateUser [DeliveryMediumType]
- acuMessageAction :: Lens' AdminCreateUser (Maybe MessageActionType)
- acuUserAttributes :: Lens' AdminCreateUser [AttributeType]
- acuValidationData :: Lens' AdminCreateUser [AttributeType]
- acuUserPoolId :: Lens' AdminCreateUser Text
- acuUsername :: Lens' AdminCreateUser Text
- adminCreateUserResponse :: Int -> AdminCreateUserResponse
- data AdminCreateUserResponse
- acursUser :: Lens' AdminCreateUserResponse (Maybe UserType)
- acursResponseStatus :: Lens' AdminCreateUserResponse Int
Creating a Request
Creates a value of AdminCreateUser
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acuTemporaryPassword
- 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 callAdminCreateUser
again, specifyingRESEND
for theMessageAction
parameter.acuForceAliasCreation
- This parameter is only used if thephone_number_verified
oremail_verified
attribute is set toTrue
. Otherwise, it is ignored. If this parameter is set toTrue
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 toFalse
, the API throws anAliasExistsException
error if the alias already exists. The default value isFalse
.acuDesiredDeliveryMediums
- SpecifyEMAIL
if email will be used to send the welcome message. SpecifySMS
if the phone number will be used. The default value isSMS
. More than one value can be specified.acuMessageAction
- Set toRESEND
to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set toSUPPRESS
to suppress sending the message. Only one value can be specified.acuUserAttributes
- 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 thanUsername
. However, any attributes that you specify as required (in or in the Attributes tab of the console) must be supplied either by you (in your call toAdminCreateUser
) or by the user (when he or she signs up in response to your welcome message). For custom attributes, you must prepend thecustom:
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. 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 toAdminCreateUser
, you can set theemail_verified
attribute toTrue
, and you can set thephone_number_verified
attribute toTrue
. (You can also do this by calling .) * email : The email address of the user to whom the message that contains the code and username will be sent. Required if theemail_verified
attribute is set toTrue
, or ifEMAIL
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 thephone_number_verified
attribute is set toTrue
, or ifSMS
is specified in theDesiredDeliveryMediums
parameter.acuValidationData
- 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.acuUserPoolId
- The user pool ID for the user pool where the user will be created.acuUsername
- 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.
data AdminCreateUser Source #
Represents the request to create a user in the specified user pool.
See: adminCreateUser
smart constructor.
Instances
Request Lenses
acuTemporaryPassword :: 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 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 AdminCreateUser
again, specifying RESEND
for the MessageAction
parameter.
acuForceAliasCreation :: Lens' AdminCreateUser (Maybe Bool) Source #
This parameter is only used 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
.
acuUserAttributes :: Lens' AdminCreateUser [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 (in or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser
) or by the user (when he or she signs 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. 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 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 .) * 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 to True
, or if EMAIL
is specified in the DesiredDeliveryMediums
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 to True
, or if SMS
is specified in the DesiredDeliveryMediums
parameter.
acuValidationData :: Lens' AdminCreateUser [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 is not persisted.
acuUserPoolId :: Lens' AdminCreateUser Text Source #
The user pool ID for the user pool where the user will be created.
acuUsername :: 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 cannot be changed.
Destructuring the Response
adminCreateUserResponse Source #
Creates a value of AdminCreateUserResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acursUser
- The newly created user.acursResponseStatus
- -- | The response status code.
data AdminCreateUserResponse Source #
Represents the response from the server to the request to create the user.
See: adminCreateUserResponse
smart constructor.
Instances
Response Lenses
acursResponseStatus :: Lens' AdminCreateUserResponse Int Source #
- - | The response status code.