发现API客户端sdk
ibm-cloud-security-advisor-findingsapi-sdk的Python项目详细描述
ibm云安全顾问发现api python sdk
此存储库包含已发布的用于ibmcloudecurityadvisor发现api的python客户端sdk。查看我们的API documentation了解更多详细信息。
要求。
python 2.7和3.4+
安装和使用
pip安装
您可以通过以下方式安装最新版本
pip install ibm-cloud-security-advisor-findingsapi-sdk
由于python包托管在github上，因此可以直接从github安装
pip install git+https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python.git
（您可能需要使用根权限运行pip：sudo pip install git+https://github.com/ibm-cloud-security/security-advisor-findings-sdk-python.git）
然后导入包：
importibm_security_advisor_findings_api_client
设置工具
通过Setuptools安装。
python setup.py install --user
（或sudo python setup.py install为所有用户安装软件包）
然后导入包：
importibm_security_advisor_findings_api_client
开始
请按照installation procedure操作，然后运行以下命令：
from__future__importprint_functionimporttimeimportibm_security_advisor_findings_api_clientfromibm_security_advisor_findings_api_client.restimportApiExceptionfrompprintimportpprintnote={"kind":"FINDING","short_description":"Test Finding","long_description":"Test Finding","provider_id":"TEST","id":"test-finding","reported_by":{"id":"test-finding","title":"Test findings"},"finding":{"severity":"LOW","next_steps":[{"title":"Verify open issues in link "}]}}# Configure API key authorization: UserMinconfiguration=ibm_security_advisor_findings_api_client.Configuration()#Change this to point to London endpointconfiguration.host="https://us-south.secadvisor.cloud.ibm.com/findings"api_instance=ibm_security_advisor_findings_api_client.FindingsNotesApi(ibm_security_advisor_findings_api_client.ApiClient(configuration))body=note# ApiNote | Body for Note creationauthorization='Bearer <<YOUR IAM TOKEN>>`account_id='Your account ID'# str | Account IDprovider_id='TEST'# str | Part of `parent`. This field contains the provider_id for example: providers/{provider_id}try:# Creates a new `Note`.api_response=api_instance.create_note(body,authorization,account_id,provider_id)pprint(api_response)exceptApiExceptionase:print("Exception when calling FindingsNotesApi->create_note: %s\n"%e)
API端点文档
所有uri都与/发现相关
| Class | Method | HTTP request | Description |
|---|---|---|---|
| FindingsGraphApi | post_graph | POST /v1/{account_id}/graph | query findings |
| FindingsNotesApi | create_note | POST /v1/{account_id}/providers/{provider_id}/notes | Creates a new `Note`. |
| FindingsNotesApi | delete_note | DELETE /v1/{account_id}/providers/{provider_id}/notes/{note_id} | Deletes the given `Note` from the system. |
| FindingsNotesApi | get_note | GET /v1/{account_id}/providers/{provider_id}/notes/{note_id} | Returns the requested `Note`. |
| FindingsNotesApi | get_occurrence_note | GET /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id}/note | Gets the `Note` attached to the given `Occurrence`. |
| FindingsNotesApi | list_notes | GET /v1/{account_id}/providers/{provider_id}/notes | Lists all `Notes` for a given provider. |
| FindingsNotesApi | update_note | PUT /v1/{account_id}/providers/{provider_id}/notes/{note_id} | Updates an existing `Note`. |
| FindingsOccurrencesApi | create_occurrence | POST /v1/{account_id}/providers/{provider_id}/occurrences | Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource. |
| FindingsOccurrencesApi | delete_occurrence | DELETE /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id} | Deletes the given `Occurrence` from the system. |
| FindingsOccurrencesApi | get_occurrence | GET /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id} | Returns the requested `Occurrence`. |
| FindingsOccurrencesApi | 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. |
| FindingsOccurrencesApi | list_occurrences | GET /v1/{account_id}/providers/{provider_id}/occurrences | Lists active `Occurrences` for a given provider matching the filters. |
| FindingsOccurrencesApi | update_occurrence | PUT /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id} | Updates an existing `Occurrence`. |
型号文档
- ApiEmpty
- ApiListNoteOccurrencesResponse
- ApiListNotesResponse
- ApiListOccurrencesResponse
- ApiListProvidersResponse
- ApiNote
- ApiNoteKind
- ApiNoteRelatedUrl
- ApiOccurrence
- ApiProvider
- BreakdownCardElement
- Card
- CardElement
- Certainty
- Context
- DataTransferred
- Finding
- FindingCountValueType
- FindingType
- Kpi
- KpiType
- KpiValueType
- NetworkConnection
- NumericCardElement
- RemediationStep
- Reporter
- Section
- Severity
- SocketAddress
- TimeSeriesCardElement
- ValueType
授权文件
在api调用中使用“bearer”+iam令牌。请参阅Getting Started
欢迎加入QQ群-->： 979659372
