organisation_user_paths - bruno-beloff/scs_analysis GitHub Wiki

docs > software repositories > scs_analysis > commands > security relationships

DESCRIPTION

The organisation_user_paths utility is used to find, create or delete organisation user paths (OUPs). OUPs are used to restrict user access:

  • If no OUPs are associated with a user, then the user may view all of topics associated with the organisation(s) that the user is a member of

  • If one or more OUP is associated with a user, then the the user may only view the projects identified by the OUPs within an organisation path root

See the organisation_path_roots utility for more information.

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

organisation_user_paths.py [-c CREDENTIALS] { -F -e EMAIL [-r PATH_ROOT] | -C -e EMAIL -r PATH_ROOT -x PATH_EXTENSION | -D -e EMAIL -r PATH_ROOT -x PATH_EXTENSION } [-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 for email (and path root)
-C, --Create create an OUP
-D, --Delete delete for email, path root and extension
-e EMAIL, --email=EMAIL the user's email address
-r PATH_ROOT, --path-root=PATH_ROOT the organisation path root
-x PATH_EXTENSION, --path-extension=PATH_EXTENSION the path extension
-i INDENT, --indent=INDENT pretty-print the output with INDENT
-v, --verbose report narrative to stderr

EXAMPLES

organisation_user_paths.py -i4 -c super -F -e [email protected] -r south-coast-science-demo/

DOCUMENT EXAMPLE

{
    "Username": "506cd055-1978-4984-9f17-2fad77797fa1",
    "OPRID": 75,
    "PathExtension": "brighton-urban/"
}

SEE ALSO

scs_analysis/cognito_user_credentials
scs_analysis/organisation_path_roots

restored from https://github.com/south-coast-science

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