CognitoIdentityProvider / Client / sign_up

sign_up#

CognitoIdentityProvider.Client.sign_up(**kwargs)#

Registers the user in the specified user pool and creates a user name, password, and user attributes.

Note

Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Note

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

You might receive a LimitExceeded exception in response to this request if you have exceeded a rate quota for email or SMS messages, and if your user pool automatically verifies email addresses or phone numbers. When you get this exception in the response, the user is successfully created and is in an UNCONFIRMED state. You can send a new code with the ResendConfirmationCode request, or confirm the user as an administrator with an AdminConfirmSignUp request.

See also: AWS API Documentation

Request Syntax

response = client.sign_up(
    ClientId='string',
    SecretHash='string',
    Username='string',
    Password='string',
    UserAttributes=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ValidationData=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    AnalyticsMetadata={
        'AnalyticsEndpointId': 'string'
    },
    UserContextData={
        'IpAddress': 'string',
        'EncodedData': 'string'
    },
    ClientMetadata={
        'string': 'string'
    }
)
Parameters:

  • ClientId (string) –

    [REQUIRED]

    The ID of the client associated with the user pool.

  • SecretHash (string) – 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.

  • Username (string) –

    [REQUIRED]

    The username of the user that you want to sign up. The value of this parameter is typically a username, but can be any alias attribute in your user pool.

  • Password (string) –

    The password of the user you want to register.

    Users can sign up without a password 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. See the SignInPolicyType property of CreateUserPool and UpdateUserPool.

  • UserAttributes (list) –

    An array of name-value pairs representing user attributes.

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

    • (dict) –

      The name and value of a user attribute.

      This data type is a request parameter of AdminUpdateUserAttributes and UpdateUserAttributes.

      • Name (string) – [REQUIRED]

        The name of the attribute.

      • Value (string) –

        The value of the attribute.

  • ValidationData (list) –

    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 might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.

    For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

    • (dict) –

      The name and value of a user attribute.

      This data type is a request parameter of AdminUpdateUserAttributes and UpdateUserAttributes.

      • Name (string) – [REQUIRED]

        The name of the attribute.

      • Value (string) –

        The value of the attribute.

  • AnalyticsMetadata (dict) –

    The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.

    • AnalyticsEndpointId (string) –

      The endpoint ID. Information that you want to pass to Amazon Pinpoint about where to send notifications.

  • UserContextData (dict) –

    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.

    For more information, see Collecting data for threat protection in applications.

    • IpAddress (string) –

      The source IP address of your user’s device.

    • EncodedData (string) –

      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 (dict) –

    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.

    Note

    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, the ClientMetadata parameter serves no purpose.

    • Validate the ClientMetadata value.

    • Encrypt the ClientMetadata value. Don’t send sensitive information in this parameter.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'UserConfirmed': True|False,
    'CodeDeliveryDetails': {
        'Destination': 'string',
        'DeliveryMedium': 'SMS'|'EMAIL',
        'AttributeName': 'string'
    },
    'UserSub': 'string',
    'Session': 'string'
}

Response Structure

  • (dict) –

    The response from the server for a registration request.

    • UserConfirmed (boolean) –

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

    • CodeDeliveryDetails (dict) –

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

      • Destination (string) –

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

      • DeliveryMedium (string) –

        The method that Amazon Cognito used to send the code.

      • AttributeName (string) –

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

    • UserSub (string) –

      The 128-bit ID of the authenticated user. This isn’t the same as username.

    • Session (string) –

      A session Id that you can pass to ConfirmSignUp when you want to immediately sign in your user with the USER_AUTH flow after they complete sign-up.

Exceptions