organisation_users - bruno-beloff/scs_analysis GitHub Wiki
docs > software repositories > scs_analysis > commands > security relationships
The organisation_users utility is used to manage the relationship between organisations and Cognito users. The utility can find, create, update and delete organisation user records.
Users may belong to more than one organisation. (Additionally, superusers typically belong to no organisation.) Organisation administrators and superusers can use this utility to add or remove membership of an organisation for individual users.
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.
organisation_users.py [-c CREDENTIALS] { -F [{ -e EMAIL | -l ORG_LABEL }] | -R -e EMAIL -l ORG_LABEL | -C -e EMAIL -l ORG_LABEL -o { 0 | 1 } -d { 0 | 1 } | -U -e EMAIL -l ORG_LABEL [-o { 0 | 1 }] [-d { 0 | 1 }] [-s { 0 | 1 }] | -D -e EMAIL -l ORG_LABEL } [-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 | Find users for the given username or organisation |
| -R, --Retrieve | Retrieve the user for the given username and organisation |
| -C, --Create | Create a user |
| -U, --Update | Update the user |
| -D, --Delete | Delete the user for the given username and organisation |
| -e EMAIL, --email=EMAIL | the user's email address (exact match) |
| -l ORG_LABEL, --org-label=ORG_LABEL | the organisation label |
| -o ORG_ADMIN, --org-admin=ORG_ADMIN | the organisation administrator status |
| -d DEVICE_ADMIN, --device-admin=DEVICE_ADMIN | the device administrator status |
| -s SUSPENDED, --suspended=SUSPENDED | the suspended status |
| -i INDENT, --indent=INDENT | pretty-print the output with INDENT |
| -v, --verbose | report narrative to stderr |
organisation_users.py -vi4 -c super -Fe [email protected]
[
{
"Username": "506cd055-1978-4984-9f17-2fad77797fa1",
"OrgID": 68,
"IsOrgAdmin": true,
"IsDeviceAdmin": false,
"IsSuspended": false
},
{
"Username": "506cd055-1978-4984-9f17-2fad77797fa1",
"OrgID": 69,
"IsOrgAdmin": true,
"IsDeviceAdmin": false,
"IsSuspended": false
}
]
scs_analysis/cognito_user_credentials
scs_analysis/cognito_users