A simple Python wrapper for the KnowBe4 API
Project description
kb4.py: A Python wrapper for the KnowBe4 API
kb4.py is a simple Python wrapper for the KnowBe4 reporting API.
For more information on the API, please visit the KnowBe4 API documentation.
Installation
pip install kb4.py
Usage
from kb4 import KnowBe4
KB4_API_KEY='<Secret key obtained from KnowBe4 website.>'
kb4 = KnowBe4(KB4_API_KEY)
kb4.account()
kb4.users()
kb4.user(USER_ID)
kb4.groups()
kb4.group(GROUP_ID)
kb4.group_members(GROUP_ID)
kb4.phishing_campaigns()
kb4.phishing_campaign(CAMPAIGN_ID)
kb4.phishing_security_tests()
kb4.phishing_campaign_security_tests(CAMPAIGN_ID)
kb4.phishing_campaign_security_test(PST_ID)
kb4.phishing_campaign_security_test_recipients(PST_ID)
kb4.phishing_campaign_security_test_recipient(PST_ID, USER_ID)
kb4.store_purchases()
kb4.store_purchase(STORE_PURCHASE_ID)
kb4.policies()
kb4.policy(POLICY_ID)
kb4.training_campaigns()
kb4.training_campaign(CAMPAIGN_ID)
kb4.training_enrollments()
kb4.training_enrollment(ENROLLMENT_ID)
Contributing
All contributions are welcome and appreciated.
- Fork
- Feature branch
- Pull request
Meta
Josh Thomas - josh@joshuadavidthomas.com
Distributed under the MIT license. See LICENSE for more information.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kb4.py-0.1.2.tar.gz.
File metadata
- Download URL: kb4.py-0.1.2.tar.gz
- Upload date:
- Size: 2.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
af8195074ea9c7ee11da1719350971826afb7bd1ce653386cc6ee92acdda5852
|
|
| MD5 |
d67b69755658ac1c3e57ce95221ca3be
|
|
| BLAKE2b-256 |
7fadf89b4436a6a56ed97d29b98ad357ec2fd534af96f7f7e525547ee4cb6579
|
File details
Details for the file kb4.py-0.1.2-py3-none-any.whl.
File metadata
- Download URL: kb4.py-0.1.2-py3-none-any.whl
- Upload date:
- Size: 4.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6cc5f3392dcb1fda4a04ab597298000b2d3c089dc4a1de8a0a269cd53c73cc09
|
|
| MD5 |
0cb6c2f26c814669df9fd50cd7d044ce
|
|
| BLAKE2b-256 |
d877942df73a6e570a973359e141c3eb5cd4258f0189266765be5d3f3cd19512
|