cognito_devices - bruno-beloff/scs_analysis GitHub Wiki

docs > software repositories > scs_analysis > commands > authentication


DESCRIPTION

The cognito_devices utility is used to find, update or delete the Cognito identity records of SCS devices.

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_devices.py [-c CREDENTIALS] { -F [{ -t DEVICE_TAG | -n INVOICE }] [-m] | -U DEVICE_TAG INVOICE | -D DEVICE_TAG } [-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 devices visible to me
-U UPDATE, --Update=UPDATE update the device
-D DELETE, --Delete=DELETE delete the device (superuser only)
-t TAG, --tag=TAG filter by device tag
-n INVOICE_NUMBER, --invoice=INVOICE_NUMBER filter by invoice
-m, --memberships show device's organisation memberships
-i INDENT, --indent=INDENT pretty-print the output with INDENT
-v, --verbose report narrative to stderr

EXAMPLES

cognito_devices.py -vi4 -c super -F -m

DOCUMENT EXAMPLE

[
    {
        "username": "scs-ph1-8",
        "invoice": "INV-0000",
        "created": "2023-04-20T12:25:47Z",
        "last-updated": "2024-01-29T15:37:21Z"
    }
]

DOCUMENT EXAMPLE - WITH MEMBERSHIPS

[
    {
        "account": {
            "username": "scs-ph1-8",
            "invoice": "INV-0000",
            "created": "2023-04-20T12:25:47Z",
            "last-updated": "2024-01-29T15:37:21Z"
        },
        "memberships": [
            {
                "DeviceTag": "scs-ph1-8",
                "OrgID": 69,
                "DeploymentLabel": "SCS Dev / Mobile 8",
                "DevicePath": "south-coast-science-dev/mobile/device/praxis-handheld-000008/",
                "LocationPath": "south-coast-science-dev/mobile/loc/8/",
                "StartDatetime": "1970-01-01T00:00:00Z",
                "EndDatetime": null
            }
        ]
    }
]

SEE ALSO

scs_analysis/cognito_users
scs_analysis/cognito_user_credentials
scs_analysis/organisation_devices

RESOURCES

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

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