cognito_user_identity - bruno-beloff/scs_analysis GitHub Wiki

docs > software repositories > scs_analysis > commands > authentication


DESCRIPTION

The cognito_user_identity utility is used to create, read or update an AWS Cognito identity for the user.

Note that the chosen password must include lower and upper case, numeric and punctuation characters.

If the --Create function is used, an email is sent to the new user. The verification link in the email must be exercised in order for the account to gain a CONFIRMED status.

The --credentials flag is only required where the user wishes to store multiple identities. Setting the credentials is done interactively using the command line interface.

SYNOPSIS

cognito_user_identity.py [-c CREDENTIALS] | -C | -R | -U } [-i INDENT] [-v]

Options
--version show program's version number and exit
-h, --help show this help message and exit
-c CREDENTIALS_NAME, --credentials=CREDENTIALS_NAME the stored credentials to be presented
-C, --Create create my identity
-R, --Retrieve retrieve my identity
-U, --Update update my identity
-i INDENT, --indent=INDENT pretty-print the output with INDENT
-v, --verbose report narrative to stderr

EXAMPLES

cognito_user_identity.py -R -c super

DOCUMENT EXAMPLE

{
    "username": "dc4cc7c2-e591-4619-b6eb-c4700daf6dff",
    "email": "[email protected]",
    "given-name": "Production",
    "family-name": "User",
    "confirmation-status": "CONFIRMED",
    "enabled": true,
    "email-verified": true,
    "is-super": true,
    "created": "2023-03-31T10:18:54Z",
    "last-updated": "2023-03-31T10:34:58Z"
}

SEE ALSO

scs_analysis/cognito_email
scs_analysis/cognito_user_credentials

RESOURCES

2: Security

AWS: Signing up and confirming user accounts
AWS: Adding user pool password requirements

⚠️ **GitHub.com Fallback** ⚠️