Test SDK
Project description
ibm_cloud_security_advisor-test
This repository contains the released python client SDK for IBM Cloud Security Advisor Findings and Notifications APIs . Check out below for more details.
- Findings API : https://cloud.ibm.com/apidocs/security-advisor/findings
- Notifications API : https://cloud.ibm.com/apidocs/security-advisor/notifications
Notice
Support for Python versions 2.x and versions <= 3.4 is deprecated and will be officially dropped in the next major release, which is expected to be end of December, 2019. Refer https://github.com/IBM/python-sdk-core
Overview
The ibm_cloud_security_advisor allows developers to programmatically interact with the ibm cloud security advisor findings and notifications api
Prerequisites
- An IBM Cloud account.
- An IAM API key to allow the SDK to access your account. Create one here.
- An installation of Python >=3.5 on your local machine.
Installation
To install, use pip
or easy_install
:
pip install --upgrade "ibm_cloud_security_advisor>=1.0.0"
or
easy_install --upgrade " ibm_cloud_security_advisor>=1.0.0"
Authentication
ibm_cloud_security_advisor uses token-based Identity and Access Management (IAM) authentication.
IAM authentication uses a service API key to get an access token that is passed with the call. Access tokens are valid for a limited amount of time and must be regenerated.
To provide credentials to the SDK, you supply either an IAM service API key or an access token:
- Use the API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, and refreshes it if necessary.
- Use the access token if you want to manage the lifecycle yourself. For details, see
Generating bearer tokens using the IAM API key
andSupplying the access token
section
Supplying the IAM API key:
from ibm_cloud_security_advisor import FindingsApiV1
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
authenticator = IAMAuthenticator('apikey')
findings_service = FindingsApiV1(authenticator=authenticator)
Generating bearer tokens using the IAM API key:
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
# In your API endpoint use this to generate new bearer tokens
iam_token_manager = IAMAuthenticator('<apikey>')
token = iam_token_manager.get_token()
Supplying the access token:
#FINDINGS
from ibm_cloud_security_advisor import FindingsApiV1
from ibm_cloud_sdk_core.authenticators import BearerTokenAuthenticator
# in the constructor, assuming control of managing the token
authenticator = BearerTokenAuthenticator('your token')
findings_service = FindingsApiV1(authenticator=authenticator)
#NOTIFICATIONS
from ibm_cloud_security_advisor import NotificationsApiV1
from ibm_cloud_sdk_core.authenticators import BearerTokenAuthenticator
# in the constructor, assuming control of managing the token
authenticator = BearerTokenAuthenticator('your token')
notifications_service = NotificationsApiV1(authenticator=authenticator)
Using the SDK
The ibm_cloud_security_advisor Python SDK supports only synchronous (blocking) execution of service methods. The return value from all service methods is a DetailedResponse object. Use this SDK to perform the basic ibm_cloud_security_advisor creation operation as follows, with the installation and initialization instructions from above:
#Findings
from ibm_cloud_security_advisor import FindingsApiV1
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
authenticator = IAMAuthenticator('your apikey')
ibm_cloud_security_advisor_findings_service = FindingsApiV1(authenticator=authenticator)
response = ibm_cloud_security_advisor_findings_service.<Method here<>>
print(response)
#Notifications
from ibm_cloud_security_advisor import NotificationsApiV1
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
authenticator = IAMAuthenticator('your apikey')
ibm_cloud_security_advisor_notifications_service = NotificationsApiV1(authenticator=authenticator)
response = ibm_cloud_security_advisor_notifications_service.<Method here<>>
print(response)
This would give an output of DetailedResponse
from which you can use the get_result()
, get_headers()
, and get_status_code()
to return the result, headers, and status code respectively.
Sending request headers
Custom headers can be passed in any request in the form of a dict
as:
headers = {
'Custom-Header': 'custom_value'
}
For example, to send a header called Custom-Header
to a call in ibm_security_advisor_findings_api_sdk, pass the headers parameter as:
from ibm_cloud_security_advisor import FindingsApiV1
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
authenticator = IAMAuthenticator('your apikey')
ibm_security_advisor_findings_api_sdk_service = FindingsApiV1(authenticator=authenticator)
response = ibm_security_advisor_findings_api_sdk_service.<<METHOD HERE>>(headers={'Custom-Header': 'custom_value'}).get_result()
Error Handling
The ibm_cloud_security_advisor Python SDK generates an exception for any unsuccessful method invocation.
If the method receives an error response from an API call to the service, it will generate an
ApiException
with the following fields.
NAME | DESCRIPTION |
---|---|
code | The HTTP response code that is returned. |
message | A message that describes the error. |
info | A dictionary of additional information about the error. |
ApiException
can be handled this way.
from ibm_cloud_sdk_core.api_exception import ApiException
try:
response = ibm_cloud_security_advisor_findings_service.create_note(
account_id="<<Account ID here>>",
**data
)
except ApiException as err:
try:
# err.code gives status code
excep_resp = err.http_response.json()
print(excep_resp)
except:
print(err)
excep_resp would be-
{
"detail": "Document already exists: abc/providers/sdktest/notes/sdk_note_id1",
"instance": "abc/providers/sdktest/notes/sdk_note_id1",
"status": 409,
"title": "Conflict",
"type": "about:blank"
}
Error log level
By default, error log level is disabled, so user will not see any error/exception logged by logger.error
and logger.exception
but will see other error/exception.
To enable it, user can pass enable_error_log=True
.
ibm_cloud_security_advisor_findings_service =FindingsApiV1(authenticator=authenticator,enable_error_log=True)
Sample Code
Findings API
Example | http method |
---|---|
post_graph | POST /v1/{account_id}/graph |
list_providers | GET /v1/{account_id}/providers |
create_finding | POST /v1/{account_id}/providers/{provider_id}/notes |
create_card | POST /v1/{account_id}/providers/{provider_id}/notes |
create_note_with_kpi | POST /v1/{account_id}/providers/{provider_id}/notes |
create_note_with_reporter | POST /v1/{account_id}/providers/{provider_id}/notes |
create_note_with_section | POST /v1/{account_id}/providers/{provider_id}/notes |
list_notes | GET /v1/{account_id}/providers/{provider_id}/notes |
delete_note | DELETE /v1/{account_id}/providers/{provider_id}/notes/{note_id} |
create_occurrence | POST /v1/{account_id}/providers/{provider_id}/occurrences |
create_occurrence_with_context | POST /v1/{account_id}/providers/{provider_id}/occurrences |
create_occurrence_with_kpi | POST /v1/{account_id}/providers/{provider_id}/occurrences |
list_occurrences | GET /v1/{account_id}/providers/{provider_id}/occurrences |
delete_occurrence | DELETE /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id} |
list_note_occurrences | GET /v1/{account_id}/providers/{provider_id}/notes/{note_id}/occurrences |
Notifications API
Example | http method |
---|---|
create channel | POST /v1/{account_id}/notifications/channels |
list channels | GET /v1/{account_id}/notifications/channels |
get channel | GET /v1/{account_id}/notifications/channels/{channel_id} |
delete bulk channels | DELETE /v1/{account_id}/notifications/channels |
delete channel | DELETE /v1/{account_id}/notifications/channels/{channel_id} |
update channel | PUT /v1/{account_id}/notifications/channels/{channel_id} |
test channel | GET /v1/{account_id}/notifications/channels/{channel_id}/test |
get public key | GET /v1/{account_id}/notifications/public_key |
Documentation
See Findings API doc.
See Notifications API doc.
Integration test
To run pytest, create virtual env and then run. Otherwise you might see below error
issue - https://github.com/pytest-dev/pytest/issues/2287
Traceback:
test/integration/test_note.py:26: in <module>
from ibm_cloud_security_advisor import FindingsApiV1
ModuleNotFoundError: No module named 'ibm_cloud_security_advisor'
- Install dev modules.
python3 -m venv env #(for python3) source env/bin/activate cd ibm-coud-security-advisor-sdk-python pip install -r requirements-dev.txt
- Prereq variables, either by exporting all the variables directly or provide in file-
Make sure
API_KEY
has enough permission to perform findings api operations.- export env vars
export API_KEY=<YOUR_API_KEY> export ACCOUNT_ID=<YOUR_ACCOUNT_ID> export FINDING_API_ENDPOINT=<FINDING_API_ENDPOINT> export NOTIFICATION_API_ENDPOINT=<NOTIFICATION_API_ENDPOINT> #optional. Use it for dev/preprod iam endpoint export IAM_ENDPOINT= <IAM_ENDPOINT>
- provide in
/integration/input/cred/ibm-credentials.env
file or export your own.env
credential file with full path including filename.
export IBM_CREDENTIALS_FILE= <file_path>
- To run test-
python -m pytest test/integration --html=report.html --json-report --json-report-summary
Once run is completed, html report and .report.json will be generated in the same directory and it will look like this
License
The ibm_cloud_security_advisor Python SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.
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
File details
Details for the file ibm_cloud_security_advisor_test-1.1.1.tar.gz
.
File metadata
- Download URL: ibm_cloud_security_advisor_test-1.1.1.tar.gz
- Upload date:
- Size: 31.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6a93d817df2555abe644d24a5305524a9cc3442e8b69e604c742a6dfe1bf1b5 |
|
MD5 | 13506be79add70a03141738a77368918 |
|
BLAKE2b-256 | 5cd861176defaf178989ae195554c187b72110fa42ad77ef52f555b2a7f381f1 |