ibm-cloud-security-advisor-findingsapi-sdk 2.0.1

Findings API Client SDK

ibm_security_advisor_findings_api_sdk

Python client library to use the ibm_security_advisor_findings_api_sdk.

Overview

The ibm_security_advisor_findings_api_sdk Python SDK allows developers to programmatically interact with the ibm_security_advisor_findings_api_sdk services, in the following ways:

• ibm_security_advisor_findings_api_sdk subclasses

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_security_advisor_findings_api_sdk>=2.0.0"

or

easy_install --upgrade " ibm_security_advisor_findings_api_sdk>=2.0.0"

Authentication

ibm_security_advisor_findings_api_sdk 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 Authenticating with IAM tokens.

Supplying the IAM API key:

from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
authenticator = IAMAuthenticator('apikey')
ibm_security_advisor_findings_api_sdk_service =  ibm_security_advisor_findings_api_sdk(authenticator=authenticator)

Generating bearer tokens using the IAM API key:

from  ibm_security_advisor_findings_api_sdk 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:

from ibm_security_advisor_findings_api_sdk import FindingsApiV1 
from ibm_cloud_sdk_core.authenticators import BearerTokenAuthenticator
# in the constructor, assuming control of managing the token
authenticator = BearerTokenAuthenticator('your token')
ibm_security_advisor_findings_api_sdk_service =  FindingsApiV1(authenticator=authenticator)

Using the SDK

The ibm_security_advisor_findings_api_sdk 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_security_advisor_findings_api_sdk creation operation as follows, with the installation and initialization instructions from above:

from ibm_security_advisor_findings_api_sdk import FindingsApiV1 
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
authenticator = IAMAuthenticator('your apikey')
ibm_security_advisor_findings_api_sdk_data =  FindingsApiV1(authenticator=authenticator)
response =  ibm_security_advisor_findings_api_sdk_data.<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_security_advisor_findings_api_sdk 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_security_advisor_findings_api_sdk 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.

Sample Code

Example	http method
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_providers	GET /v1/{account_id}/providers

Documentation

See Findings API doc.

License

The ibm_security_advisor_findings_api_sdk Python SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.