cognito_users - bruno-beloff/scs_analysis GitHub Wiki

docs > software repositories > scs_analysis > commands > authentication


DESCRIPTION

The cognito_users utility is used to create, update and retrieve AWS Cognito identities on behalf of other users. The utility can only be used by organisation administrators and superusers.

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_users.py [-c CREDENTIALS] { -F [{ -e EMAIL_ADDR | -l ORG_LABEL | -o CONFIRMATION | -s { 0 | 1 } } }] [-m] | -C -g GIVEN_NAME -f FAMILY_NAME -e EMAIL_ADDR | -U EMAIL_ADDR [-g GIVEN_NAME] [-f FAMILY_NAME] [-e EMAIL_ADDR] [-s { 0 | 1 }] | -D EMAIL_ADDR } [-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
-F, --Find list the users visible to me
-C, --Create create a user
-U UPDATE, --Update=UPDATE update the user
-D DELETE, --Delete=DELETE delete the user (superuser only)
-g GIVEN_NAME, --given-name=GIVEN_NAME given name
-f FAMILY_NAME, --family-name=FAMILY_NAME family name
-e EMAIL, --email=EMAIL email address
-l ORG_LABEL, --org-label=ORG_LABEL the organisation label
-o CONFIRMATION_STATUS, --confirmation-status=CONFIRMATION_STATUS filter list by confirmation status { U | C | P | F | D }
-s ENABLED, --enabled-status=ENABLED filter list by enabled status { 0 | 1 }
-m, --memberships show user's organisation memberships
-i INDENT, --indent=INDENT pretty-print the output with INDENT
-v, --verbose report narrative to stderr

EXAMPLES

cognito_users.py -Fe [email protected]

DOCUMENT EXAMPLE

[
    {
        "username": "506cd055-1978-4984-9f17-2fad77797fa1",
        "email": "[email protected]",
        "given-name": "Bruno",
        "family-name": "Beloff",
        "confirmation-status": "CONFIRMED",
        "enabled": true,
        "email-verified": true,
        "created": "2023-04-20T11:45:21Z",
        "last-updated": "2024-04-18T13:15:23Z"
    }
]

SEE ALSO

scs_analysis/cognito_devices
scs_analysis/cognito_email
scs_analysis/cognito_user_credentials
scs_analysis/organisation_users

RESOURCES

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

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