confirmSignUp method
Confirms the account of a new user. This public API operation submits a code that Amazon Cognito sent to your user when they signed up in your user pool. After your user enters their code, they confirm ownership of the email address or phone number that they provided, and their user account becomes active. Depending on your user pool configuration, your users will receive their confirmation code in an email or SMS message.
Local users who signed up in your user pool are the only type of user who can confirm sign-up with a code. Users who federate through an external identity provider (IdP) have already been confirmed by their IdP.
May throw AliasExistsException.
May throw CodeMismatchException.
May throw ExpiredCodeException.
May throw ForbiddenException.
May throw InternalErrorException.
May throw InvalidLambdaResponseException.
May throw InvalidParameterException.
May throw LimitExceededException.
May throw NotAuthorizedException.
May throw OperationNotEnabledException.
May throw ResourceNotFoundException.
May throw TooManyFailedAttemptsException.
May throw TooManyRequestsException.
May throw UnexpectedLambdaException.
May throw UserLambdaValidationException.
May throw UserNotFoundException.
Parameter clientId :
The ID of the app client associated with the user pool.
Parameter confirmationCode :
The confirmation code that your user pool sent in response to the
SignUp request.
Parameter username :
The name of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their
alias attributes. If username isn't an alias attribute in
your user pool, this value must be the sub of a local user or
the username of a user from a third-party IdP.
Parameter analyticsMetadata :
Information that supports analytics outcomes with Amazon Pinpoint,
including the user's endpoint ID. The endpoint ID is a destination for
Amazon Pinpoint push notifications, for example a device identifier, email
address, or phone number.
Parameter 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 Amazon Cognito invokes any of these functions, it passes a JSON
payload, which the function receives as input. This payload contains a
clientMetadata attribute that provides the data that you
assigned to the ClientMetadata parameter in your request. In your function
code, you can process the clientMetadata value to enhance
your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
-
Store the
ClientMetadatavalue. 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, theClientMetadataparameter serves no purpose. -
Validate the
ClientMetadatavalue. -
Encrypt the
ClientMetadatavalue. Don't send sensitive information in this parameter.
Parameter forceAliasCreation :
When true, forces user confirmation despite any existing
aliases. Defaults to false. A value of true
migrates the alias from an existing user to the new user if an existing
user already has the phone number or email address as an alias.
Say, for example, that an existing user has an email
attribute of bob@example.com and email is an alias in your
user pool. If the new user also has an email of
bob@example.com and your ConfirmSignUp response
sets ForceAliasCreation to true, the new user
can sign in with a username of bob@example.com and the
existing user can no longer do so.
If false and an attribute belongs to an existing alias, this
request returns an AliasExistsException error.
For more information about sign-in aliases, see Customizing sign-in attributes.
Parameter secretHash :
A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message. For more information about SecretHash, see Computing
secret hash values.
Parameter session :
The optional session ID from a SignUp API request. You can
sign in a user directly from the sign-up process with the
USER_AUTH authentication flow.
Parameter userContextData :
Contextual data about your user session like the device fingerprint, IP
address, or location. Amazon Cognito threat protection evaluates the risk
of an authentication event based on the context that your app generates
and passes to Amazon Cognito when it makes API requests.
For more information, see Collecting data for threat protection in applications.
Implementation
Future<ConfirmSignUpResponse> confirmSignUp({
required String clientId,
required String confirmationCode,
required String username,
AnalyticsMetadataType? analyticsMetadata,
Map<String, String>? clientMetadata,
bool? forceAliasCreation,
String? secretHash,
String? session,
UserContextDataType? userContextData,
}) async {
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.1',
'X-Amz-Target': 'AWSCognitoIdentityProviderService.ConfirmSignUp'
};
final jsonResponse = await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
signed: false,
// TODO queryParams
headers: headers,
payload: {
'ClientId': clientId,
'ConfirmationCode': confirmationCode,
'Username': username,
if (analyticsMetadata != null) 'AnalyticsMetadata': analyticsMetadata,
if (clientMetadata != null) 'ClientMetadata': clientMetadata,
if (forceAliasCreation != null)
'ForceAliasCreation': forceAliasCreation,
if (secretHash != null) 'SecretHash': secretHash,
if (session != null) 'Session': session,
if (userContextData != null) 'UserContextData': userContextData,
},
);
return ConfirmSignUpResponse.fromJson(jsonResponse.body);
}