Example Code for Python 3.x to push and pull data from OpenRMF^® Professional

The examples here assume you have OpenRMF^® Professional installed, the external API setup and turned on, and you have at least one Application Integration record setup on the Administration --> External API Integration page. Your user account in Keycloak also must be setup to match the API integration with proper roles and permissions, including the ExternalAPI role to allow interaction from outside the OpenRMF^® Professional UI.

Some of the APIs for patch vulnerabilities and the other technology vulnerabilities are version 2.8 or higher. Evidence Management was added in v2.9. If you have questions please see your customer representative or email Soteria Software Support. You can also contact us on our https://www.soteriasoft.com/ company website as well.

Install Requests Python Package

You will need to run pip3 install requests in order to load that library into your folder. Then you can start with the authentication.py script.

Install prettytable Python Package

You will need to run pip3 install prettytable in order to load that library into your folder. Then you can start with the authentication.py script.

Install the Python Keycloak library

You will need to run pip install python-keycloak to add the proper library into your folder to call Keycloak with the scripts. See https://pypi.org/project/python-keycloak/ for more great information. Those specific examples are under python/keycloak/python-keycloak-lib/ specifically.

Testing Authentication

To ensure your authentication is valid using the simple script for testauthentication.sh in the scripts folder and make sure it prints back 200 as the request status. If so then your API call, structure, API Key, Token and user/pwd combination for that API are all valid.

API Calls

The API calls here follow the OpenRMF^® Professional Developer's Guide. Please contact Soteria Software for more information.

Example bulk add Python script

This would load up workstations named SOTWKS2000001 to 00581 with 6 checklists per workstation. These are based on the image we push out for Windows desktops, so a good starting point to see where we are when deployed. Then scans are updated and uploaded to track from there forward.

python3 windowsdesktopstackbulk.py http://192.168.13.100:8080/ company-desktop-infra myapiaccountname hvs.87587659786LKGJKHGLJKHJK "652fcdccde4e9aef5c32545b,652fcdeede4e9aef5c32545e,652fcdfdde4e9aef5c32545f,652fcdc1de4e9aef5c32545a,652fcdd7de4e9aef5c32545c,652fcde1de4e9aef5c32545d" SOTWKS200 1 581

Notes

• for the Download XLSX scripts, there needs to be a ./download/ directory created where you run it. Or modify as appropriate.
• we tried to put the applicable scripts into the appropriate folders for organization
• titles (hopefully) are self explanatory
• there is an example call in each .py file