organisation_path_roots - bruno-beloff/scs_analysis GitHub Wiki

docs > software repositories > scs_analysis > commands > security relationships


DESCRIPTION

The organisation_path_roots utility is used to find, create or delete organisation path roots. Organisation path roots are the leftmost part of a topic path. For example, in:

south-coast-science-demo/brighton-urban/loc/1/climate

the organisation path root is south-coast-science-demo/. In the security system, organisation path roots are used to maintain a mapping between topics and organisations.

The members of an organisation path root are the organisation user paths (OUPs) that restrict access to specific users. See the organisation_user_paths 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_path_roots.py [-c CREDENTIALS] { -F [-l ORG_LABEL [-m]] | -C -l ORG_LABEL -r PATH_ROOT | -D -l ORG_LABEL -r PATH_ROOT } [-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 the path roots for the given organisation
-C, --Create create a path root for the given organisation and path
-D, --Delete delete the path root with the given organisation and path
-l ORG_LABEL, --org-label=ORG_LABEL the organisation label
-r PATH_ROOT, --path-root=PATH_ROOT the organisation path root
-m, --memberships show path root's user path memberships
-i INDENT, --indent=INDENT pretty-print the output with INDENT
-v, --verbose report narrative to stderr

EXAMPLES

organisation_path_roots.py -vi4 -c super -Fl "South Coast Science (Demo)" -m

DOCUMENT EXAMPLE

[
    {
        "opr": {
            "OPRID": 75,
            "OrgID": 68,
            "PathRoot": "south-coast-science-demo/"
        },
        "memberships": []
    }
]

DOCUMENT EXAMPLE - MEMBERSHIPS

[
    {
        "opr": {
            "OPRID": 75,
            "OrgID": 68,
            "PathRoot": "south-coast-science-demo/"
        },
        "memberships": [
            {
                "Username": "506cd055-1978-4984-9f17-2fad77797fa1",
                "OPRID": 75,
                "PathExtension": "brighton-urban/"
            }
        ]
    }
]

SEE ALSO

scs_analysis/cognito_user_credentials
scs_analysis/organisation_user_paths

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