/

POST

Confirms registration of a new user.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ClientId": "string",
    "SecretHash": "string",
    "Username": "string",
    "ConfirmationCode": "string",
    "ForceAliasCreation": true,
    "AnalyticsMetadata": {},
    "UserContextData": {
        "IpAddress": "string",
        "EncodedData": "string"
    },
    "ClientMetadata": {
        "property1": "string",
        "property2": "string"
    }
}'

Response Example

200 - Example 1

{}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Represents the request to confirm registration of a user.

ClientId

string <password>

required

The ID of the app client associated with the user pool.

>= 1 characters<= 128 characters

Match pattern:

[\w+]+

SecretHash

string <password>

optional

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.

>= 1 characters<= 128 characters

Match pattern:

[\w+=/]+

Username

string <password>

required

The user name of the user whose registration you want to confirm.

>= 1 characters<= 128 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}]+

ConfirmationCode

string

required

The confirmation code sent by a user's request to confirm registration.

>= 1 characters<= 2048 characters

Match pattern:

[\S]+

ForceAliasCreation

boolean

optional

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation 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 being confirmed. If set to False, the API will throw an AliasExistsException error.

AnalyticsMetadata

object

optional

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

UserContextData

object

optional

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security 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.

IpAddress

string

optional

The source IP address of your user's device.

EncodedData

string

optional

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

ClientMetadata

object

optional

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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation 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 ConfirmSignUp 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.

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482UnexpectedLambdaException

🟠483UserLambdaValidationException

🟠484NotAuthorizedException

🟠485TooManyFailedAttemptsException

🟠486CodeMismatchException

🟠487ExpiredCodeException

🟠488InvalidLambdaResponseException

🟠489AliasExistsException

🟠490TooManyRequestsException

🟠491LimitExceededException

🟠492UserNotFoundException

🟠493InternalErrorException

🟠494ForbiddenException

Modified at 2023-08-15 07:11:06