Class AdminCreateUserRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AdminCreateUserRequest.Builder,
AdminCreateUserRequest>
Creates a new user in the specified user pool.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.final List
<DeliveryMediumType> SpecifyEMAIL
if email will be used to send the welcome message.SpecifyEMAIL
if email will be used to send the welcome message.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
This parameter is used only if thephone_number_verified
oremail_verified
attribute is set toTrue
.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the ClientMetadata property.final boolean
For responses, this returns true if the service returned a value for the DesiredDeliveryMediums property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the UserAttributes property.final boolean
For responses, this returns true if the service returned a value for the ValidationData property.final MessageActionType
Set toRESEND
to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password.final String
Set toRESEND
to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password.static Class
<? extends AdminCreateUserRequest.Builder> final String
The user's temporary password.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<AttributeType> An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.final String
username()
The value that you want to set as the username sign-in attribute.final String
The ID of the user pool where you want to create a user.final List
<AttributeType> Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
userPoolId
The ID of the user pool where you want to create a user.
- Returns:
- The ID of the user pool where you want to create a user.
-
username
The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.
-
The username can't be a duplicate of another username in the same user pool.
-
You can't change the value of a username after you create it.
-
You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.
- Returns:
- The value that you want to set as the username sign-in attribute. The following conditions apply to the
username parameter.
-
The username can't be a duplicate of another username in the same user pool.
-
You can't change the value of a username after you create it.
-
You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.
-
-
-
hasUserAttributes
public final boolean hasUserAttributes()For responses, this returns true if the service returned a value for the UserAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 toAdminCreateUser
) 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 theemail_verified
andphone_number_verified
attributes totrue
. 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 setemail_verified
totrue
, or if you setEMAIL
in theDesiredDeliveryMediums
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 setphone_number_verified
totrue
, or if you setSMS
in theDesiredDeliveryMediums
parameter.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUserAttributes()
method.- Returns:
- 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 toAdminCreateUser
) 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 theemail_verified
andphone_number_verified
attributes totrue
. 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 setemail_verified
totrue
, or if you setEMAIL
in theDesiredDeliveryMediums
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 setphone_number_verified
totrue
, or if you setSMS
in theDesiredDeliveryMediums
parameter.
-
hasValidationData
public final boolean hasValidationData()For responses, this returns true if the service returned a value for the ValidationData property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.
For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasValidationData()
method.- Returns:
- 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 can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.
For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
-
temporaryPassword
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The exception to the requirement for a password is when your user pool supports passwordless sign-in with email or SMS OTPs. To create a user with no password, omit this parameter or submit a blank value. You can only create a passwordless user when passwordless sign-in is available.
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.
If you don't specify a value, Amazon Cognito generates one for you unless you have passwordless options active for your user pool.
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
AdminCreateUser
again and specifyRESEND
for theMessageAction
parameter.- Returns:
- The user's temporary password. This password must conform to the password policy that you specified when
you created the user pool.
The exception to the requirement for a password is when your user pool supports passwordless sign-in with email or SMS OTPs. To create a user with no password, omit this parameter or submit a blank value. You can only create a passwordless user when passwordless sign-in is available.
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.
If you don't specify a value, Amazon Cognito generates one for you unless you have passwordless options active for your user pool.
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
AdminCreateUser
again and specifyRESEND
for theMessageAction
parameter.
-
forceAliasCreation
This parameter is used only if the
phone_number_verified
oremail_verified
attribute is set toTrue
. Otherwise, it is ignored.If this parameter is set to
True
and the phone number or email address specified in theUserAttributes
parameter already exists as an alias with a different user, this request migrates 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 anAliasExistsException
error if the alias already exists. The default value isFalse
.- Returns:
- This parameter is used only if the
phone_number_verified
oremail_verified
attribute is set toTrue
. Otherwise, it is ignored.If this parameter is set to
True
and the phone number or email address specified in theUserAttributes
parameter already exists as an alias with a different user, this request migrates 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 anAliasExistsException
error if the alias already exists. The default value isFalse
.
-
messageAction
Set to
RESEND
to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set toSUPPRESS
to suppress sending the message. You can specify only one value.If the service returns an enum value that is not available in the current SDK version,
messageAction
will returnMessageActionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageActionAsString()
.- Returns:
- Set to
RESEND
to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set toSUPPRESS
to suppress sending the message. You can specify only one value. - See Also:
-
messageActionAsString
Set to
RESEND
to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set toSUPPRESS
to suppress sending the message. You can specify only one value.If the service returns an enum value that is not available in the current SDK version,
messageAction
will returnMessageActionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageActionAsString()
.- Returns:
- Set to
RESEND
to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set toSUPPRESS
to suppress sending the message. You can specify only one value. - See Also:
-
desiredDeliveryMediums
Specify
EMAIL
if email will be used to send the welcome message. SpecifySMS
if the phone number will be used. The default value isSMS
. You can specify more than one value.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDesiredDeliveryMediums()
method.- Returns:
- Specify
EMAIL
if email will be used to send the welcome message. SpecifySMS
if the phone number will be used. The default value isSMS
. You can specify more than one value.
-
hasDesiredDeliveryMediums
public final boolean hasDesiredDeliveryMediums()For responses, this returns true if the service returned a value for the DesiredDeliveryMediums property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
desiredDeliveryMediumsAsStrings
Specify
EMAIL
if email will be used to send the welcome message. SpecifySMS
if the phone number will be used. The default value isSMS
. You can specify more than one value.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDesiredDeliveryMediums()
method.- Returns:
- Specify
EMAIL
if email will be used to send the welcome message. SpecifySMS
if the phone number will be used. The default value isSMS
. You can specify more than one value.
-
hasClientMetadata
public final boolean hasClientMetadata()For responses, this returns true if the service returned a value for the ClientMetadata property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 theclientMetadata
value to enhance your workflow for your specific needs.For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.
When you use the
ClientMetadata
parameter, note 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, theClientMetadata
parameter serves no purpose. -
Validate the
ClientMetadata
value. -
Encrypt the
ClientMetadata
value. Don't send sensitive information in this parameter.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasClientMetadata()
method.- Returns:
- 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 theclientMetadata
value to enhance your workflow for your specific needs.For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.
When you use the
ClientMetadata
parameter, note 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, theClientMetadata
parameter serves no purpose. -
Validate the
ClientMetadata
value. -
Encrypt the
ClientMetadata
value. Don't send sensitive information in this parameter.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AdminCreateUserRequest.Builder,
AdminCreateUserRequest> - Specified by:
toBuilder
in classCognitoIdentityProviderRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-