/ - Amazon Cognito Identity Provider

Confirms user registration as an admin without using a confirmation code. Works on any user.

Calling this action requires developer credentials.

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "UserPoolId": "string", "Username": "string", "ClientMetadata": { "property1": "string", "property2": "string" } }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Represents the request to confirm user registration.

UserPoolId

string

required

The user pool ID for which you want to confirm user registration.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

Username

string <password>

required

The user name for which you want to confirm user registration.

>= 1 characters<= 128 characters

Match pattern:

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

ClientMetadata

object

optional

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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

🟠486InvalidLambdaResponseException

🟠487TooManyRequestsException

🟠488LimitExceededException

🟠489UserNotFoundException

🟠490InternalErrorException