{ "info": { "author": "IBM Cloud", "author_email": "vkalangu@in.ibm.com, skairali@in.ibm.com, ashishth@in.ibm.com", "bugtrack_url": null, "classifiers": [], "description": "IBM Cloud Security Advisor Findings API Python SDK \n==================\n\nThis repository contains the released Python client SDK for IBM Cloud ecurity Advisor Findings API . Check out our [API\ndocumentation](https://cloud.ibm.com/apidocs/security-advisor/findings) for more details.\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nyou can install latest version by\n\n```sh\npip install ibm-cloud-security-advisor-findingsapi-sdk\n```\n\nSince the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python.git`)\n\nThen import the package:\n```python\nimport ibm_security_advisor_findings_api_client \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport ibm_security_advisor_findings_api_client\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n \nfrom __future__ import print_function\nimport time\nimport ibm_security_advisor_findings_api_client \nfrom ibm_security_advisor_findings_api_client.rest import ApiException\nfrom pprint import pprint\n\nnote = {\n \"kind\": \"FINDING\",\n \"short_description\": \"Test Finding\",\n \"long_description\": \"Test Finding\",\n \"provider_id\": \"TEST\",\n \"id\": \"test-finding\",\n \"reported_by\": {\n \"id\": \"test-finding\",\n \"title\": \"Test findings\"\n },\n \"finding\": {\n \"severity\": \"LOW\",\n \"next_steps\": [{\n \"title\": \"Verify open issues in link \"\n }]\n }\n}\n\n\n# Configure API key authorization: UserMin\nconfiguration = ibm_security_advisor_findings_api_client.Configuration()\n#Change this to point to London endpoint\nconfiguration.host= \"https://us-south.secadvisor.cloud.ibm.com/findings\"\n\napi_instance = ibm_security_advisor_findings_api_client.FindingsNotesApi(ibm_security_advisor_findings_api_client.ApiClient(configuration))\nbody = note # ApiNote | Body for Note creation\n\nauthorization = 'Bearer <>`\naccount_id = 'Your account ID' # str | Account ID\nprovider_id = 'TEST' # str | Part of `parent`. This field contains the provider_id for example: providers/{provider_id}\n\n\ntry:\n # Creates a new `Note`.\n api_response = api_instance.create_note(body, authorization, account_id, provider_id)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling FindingsNotesApi->create_note: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to */findings*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*FindingsGraphApi* | [**post_graph**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsGraphApi.md#post_graph) | **POST** /v1/{account_id}/graph | query findings\n*FindingsNotesApi* | [**create_note**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsNotesApi.md#create_note) | **POST** /v1/{account_id}/providers/{provider_id}/notes | Creates a new `Note`.\n*FindingsNotesApi* | [**delete_note**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsNotesApi.md#delete_note) | **DELETE** /v1/{account_id}/providers/{provider_id}/notes/{note_id} | Deletes the given `Note` from the system.\n*FindingsNotesApi* | [**get_note**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsNotesApi.md#get_note) | **GET** /v1/{account_id}/providers/{provider_id}/notes/{note_id} | Returns the requested `Note`.\n*FindingsNotesApi* | [**get_occurrence_note**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsNotesApi.md#get_occurrence_note) | **GET** /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id}/note | Gets the `Note` attached to the given `Occurrence`.\n*FindingsNotesApi* | [**list_notes**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsNotesApi.md#list_notes) | **GET** /v1/{account_id}/providers/{provider_id}/notes | Lists all `Notes` for a given provider.\n*FindingsNotesApi* | [**update_note**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsNotesApi.md#update_note) | **PUT** /v1/{account_id}/providers/{provider_id}/notes/{note_id} | Updates an existing `Note`.\n*FindingsOccurrencesApi* | [**create_occurrence**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsOccurrencesApi.md#create_occurrence) | **POST** /v1/{account_id}/providers/{provider_id}/occurrences | Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource.\n*FindingsOccurrencesApi* | [**delete_occurrence**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsOccurrencesApi.md#delete_occurrence) | **DELETE** /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id} | Deletes the given `Occurrence` from the system.\n*FindingsOccurrencesApi* | [**get_occurrence**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsOccurrencesApi.md#get_occurrence) | **GET** /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id} | Returns the requested `Occurrence`.\n*FindingsOccurrencesApi* | [**list_note_occurrences**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsOccurrencesApi.md#list_note_occurrences) | **GET** /v1/{account_id}/providers/{provider_id}/notes/{note_id}/occurrences | Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer providers.\n*FindingsOccurrencesApi* | [**list_occurrences**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsOccurrencesApi.md#list_occurrences) | **GET** /v1/{account_id}/providers/{provider_id}/occurrences | Lists active `Occurrences` for a given provider matching the filters.\n*FindingsOccurrencesApi* | [**update_occurrence**](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingsOccurrencesApi.md#update_occurrence) | **PUT** /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id} | Updates an existing `Occurrence`.\n\n## Documentation For Models\n\n - [ApiEmpty](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/ApiEmpty.md)\n - [ApiListNoteOccurrencesResponse](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/ApiListNoteOccurrencesResponse.md)\n - [ApiListNotesResponse](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/ApiListNotesResponse.md)\n - [ApiListOccurrencesResponse](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/ApiListOccurrencesResponse.md)\n - [ApiListProvidersResponse](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/ApiListProvidersResponse.md)\n - [ApiNote](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/ApiNote.md)\n - [ApiNoteKind](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/ApiNoteKind.md)\n - [ApiNoteRelatedUrl](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/ApiNoteRelatedUrl.md)\n - [ApiOccurrence](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/ApiOccurrence.md)\n - [ApiProvider](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/ApiProvider.md)\n - [BreakdownCardElement](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/BreakdownCardElement.md)\n - [Card](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/Card.md)\n - [CardElement](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/CardElement.md)\n - [Certainty](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/Certainty.md)\n - [Context](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/Context.md)\n - [DataTransferred](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/DataTransferred.md)\n - [Finding](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/Finding.md)\n - [FindingCountValueType](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingCountValueType.md)\n - [FindingType](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/FindingType.md)\n - [Kpi](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/Kpi.md)\n - [KpiType](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/KpiType.md)\n - [KpiValueType](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/KpiValueType.md)\n - [NetworkConnection](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/NetworkConnection.md)\n - [NumericCardElement](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/NumericCardElement.md)\n - [RemediationStep](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/RemediationStep.md)\n - [Reporter](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/Reporter.md)\n - [Section](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/Section.md)\n - [Severity](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/Severity.md)\n - [SocketAddress](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/SocketAddress.md)\n - [TimeSeriesCardElement](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/TimeSeriesCardElement.md)\n - [ValueType](https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python/blob/master/docs/ValueType.md)\n\n## Documentation For Authorization\n\nUse \"Bearer \" + IAM TOKEN in api calls. Refer [Getting Started](#getting-started)", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python", "keywords": "Swagger,Findings API", "license": "Apache 2.0", "maintainer": "", "maintainer_email": "", "name": "ibm-cloud-security-advisor-findingsapi-sdk", "package_url": "https://pypi.org/project/ibm-cloud-security-advisor-findingsapi-sdk/", "platform": "", "project_url": "https://pypi.org/project/ibm-cloud-security-advisor-findingsapi-sdk/", "project_urls": { "Homepage": "https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python" }, "release_url": "https://pypi.org/project/ibm-cloud-security-advisor-findingsapi-sdk/1.0.4/", "requires_dist": null, "requires_python": "", "summary": "Findings API Client SDK", "version": "1.0.4" }, "last_serial": 5656211, "releases": { "1.0.1": [ { "comment_text": "", "digests": { "md5": "7feddb10cce55cdb17ea9dfe775f9b56", "sha256": "c647da8909d4e2b6fdbea03460a093ab462e0ce409100df63c29d0dcc2a86ef8" }, "downloads": -1, "filename": "ibm-cloud-security-advisor-findingsapi-sdk-1.0.1.tar.gz", "has_sig": false, "md5_digest": "7feddb10cce55cdb17ea9dfe775f9b56", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 37130, "upload_time": "2019-08-07T07:56:52", "url": "https://files.pythonhosted.org/packages/d5/aa/2f225f1e090b190caf452f6e907f29342e9055378cc25ce89875e8ec258f/ibm-cloud-security-advisor-findingsapi-sdk-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "b1cdb4e6f8b1704127d9598966807447", "sha256": "4dbcbf118df043d0ff4be7b96c0407f876dd54d4c1198f100c22a98eba43acec" }, "downloads": -1, "filename": "ibm-cloud-security-advisor-findingsapi-sdk-1.0.2.tar.gz", "has_sig": false, "md5_digest": "b1cdb4e6f8b1704127d9598966807447", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 37200, "upload_time": "2019-08-07T08:11:53", "url": "https://files.pythonhosted.org/packages/0a/23/e462ba06823d6acdefb2de09fb8282ba23074bfeab3e9a530c95a19b4cbf/ibm-cloud-security-advisor-findingsapi-sdk-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "4905c40604734e682ddbaafa19dd2099", "sha256": "921bc65ce855c1da1a507bc3c9e47effdbce651e5b164edf8a575af757743ae8" }, "downloads": -1, "filename": "ibm-cloud-security-advisor-findingsapi-sdk-1.0.3.tar.gz", "has_sig": false, "md5_digest": "4905c40604734e682ddbaafa19dd2099", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39875, "upload_time": "2019-08-08T17:09:02", "url": "https://files.pythonhosted.org/packages/63/64/6131ffcf627b028b0f910ddc2db90a3475feee101ffdf2007dda3b61a35f/ibm-cloud-security-advisor-findingsapi-sdk-1.0.3.tar.gz" } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "b9e87005c4dc9f3bc49542131c80c4e6", "sha256": "276b0c84bc19ea0c775f3bae032bad312ed8de8148ae77dba143dfda73a393db" }, "downloads": -1, "filename": "ibm-cloud-security-advisor-findingsapi-sdk-1.0.4.tar.gz", "has_sig": false, "md5_digest": "b9e87005c4dc9f3bc49542131c80c4e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 40432, "upload_time": "2019-08-09T14:50:42", "url": "https://files.pythonhosted.org/packages/bf/b3/427cabfd273538df03f577880b6108b24bfada18ea6655df4b55bf976fba/ibm-cloud-security-advisor-findingsapi-sdk-1.0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b9e87005c4dc9f3bc49542131c80c4e6", "sha256": "276b0c84bc19ea0c775f3bae032bad312ed8de8148ae77dba143dfda73a393db" }, "downloads": -1, "filename": "ibm-cloud-security-advisor-findingsapi-sdk-1.0.4.tar.gz", "has_sig": false, "md5_digest": "b9e87005c4dc9f3bc49542131c80c4e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 40432, "upload_time": "2019-08-09T14:50:42", "url": "https://files.pythonhosted.org/packages/bf/b3/427cabfd273538df03f577880b6108b24bfada18ea6655df4b55bf976fba/ibm-cloud-security-advisor-findingsapi-sdk-1.0.4.tar.gz" } ] }