cognito_email - bruno-beloff/scs_analysis GitHub Wiki
docs > software repositories > scs_analysis > commands > authentication
DESCRIPTION
The cognito_email utility is used to set or reset the user's password, or to request an email to permit password operations. Which email message is sent depends on the state of the state of the user's account:
- UNCONFIRMED - the account creation email is re-sent
- CONFIRMED - a password reset code is sent and the user account enters the PASSWORD_RESET_REQUIRED state
- PASSWORD_RESET_REQUIRED - a password reset code is re-sent
- FORCE_CHANGE_PASSWORD - the temporary password is re-sent
Emails cannot be sent to users in the DISABLED state.
When an email is received, the cognito_email utility should be used to process the response, which is one of:
- Confirm account - using the emailed confirmation code
- Set password - using the emailed temporary password
- Reset password - using the emailed reset code
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_email.py { -e | -c | -s | -r } [-v] EMAIL
| Options | |
|---|---|
| --version | show program's version number and exit |
| -h, --help | show this help message and exit |
| -e, --send-email | send access email |
| -c, --confirm | confirm account (using confirmation code) |
| -s, --set-password | set password (using temporary password) |
| -r, --reset-password | reset password (using reset code) |
| -v, --verbose | report narrative to stderr |
EXAMPLES
cognito_email.py -r [email protected]
SEE ALSO
scs_analysis/cognito_user_credentials
scs_analysis/cognito_user_identity
scs_analysis/cognito_users