CmdID / aws / aws cognito-idp

aws cognito-idp sign-up

Registers a user with an app client and requests a user name, password, and user attributes in the user pool. AWS CLI reference

1 example 9 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To sign up a user

The following sign-up example signs up jane@example.com.

aws cognito-idp sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username jane@example.com --password PASSWORD --user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane"

Identify

--client-idThe ID of the app client where the user wants to sign up.

--usernameThe username of the user that you want to sign up.

--passwordThe user's proposed password.

--user-attributesAn array of name-value pairs representing user attributes.

Its output

{
    "UserConfirmed": false,
    "UserSub": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

For more information, see Signing up and confirming user accounts in the Amazon Cognito Developer Guide.

Options

9 in the AWS CLI reference

--analytics-metadataInformation that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID.

--client-idThe ID of the app client where the user wants to sign up.

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

--passwordThe user's proposed password.

--secret-hashA 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.

--user-attributesAn array of name-value pairs representing user attributes.

--user-context-dataContextual data about your user session like the device fingerprint, IP address, or location.

--usernameThe username of the user that you want to sign up.

--validation-dataTemporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.