/ - Amazon Cognito Identity Provider

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

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Represents the request to register a user.

ClientId

string <password>

required

The ID of the 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 you want to register.

>= 1 characters<= 128 characters

Match pattern:

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

Password

string <password>

required

The password of the user you want to register.

<= 256 characters

Match pattern:

[\S]+

UserAttributes

array[object (AttributeType) {2}]

optional

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Name

string

required

The name of the attribute.

>= 1 characters<= 32 characters

Match pattern:

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

Value

string <password>

optional

The value of the attribute.

<= 2048 characters

ValidationData

array[object (AttributeType) {2}]

optional

The validation data in the request to register a user.

Name

string

required

The name of the attribute.

>= 1 characters<= 32 characters

Match pattern:

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

Value

string <password>

optional

The value of the attribute.

<= 2048 characters

AnalyticsMetadata

object

optional

The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp 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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. 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, which provides the data that you assigned to the ClientMetadata parameter in your SignUp 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

The response from the server for a registration request.

UserConfirmed

boolean

required

A response from the server indicating that a user registration has been confirmed.

CodeDeliveryDetails

object

optional

The code delivery details returned by the server response to the user registration request.

Destination

string

optional

The email address or phone number destination where Amazon Cognito sent the code.

DeliveryMedium

enum<string>

optional

The method that Amazon Cognito used to send the code.

Allowed values:

SMSEMAIL

AttributeName

string

optional

The name of the attribute that Amazon Cognito verifies with the code.

>= 1 characters<= 32 characters

Match pattern:

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

UserSub

string

required

The UUID of the authenticated user. This isn't the same as username.

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482UnexpectedLambdaException

🟠483UserLambdaValidationException

🟠484NotAuthorizedException

🟠485InvalidPasswordException

🟠486InvalidLambdaResponseException

🟠487UsernameExistsException

🟠488TooManyRequestsException

🟠489InternalErrorException

🟠490InvalidSmsRoleAccessPolicyException

🟠491InvalidSmsRoleTrustRelationshipException

🟠492InvalidEmailRoleAccessPolicyException

🟠493CodeDeliveryFailureException

🟠494ForbiddenException