# IBM Cloud Security Advisor Findings API Node SDK Findings API is supported in the following regions: * [Dallas](https://us-south.secadvisor.cloud.ibm.com/findings/v1/docs) * [London](https://eu-gb.secadvisor.cloud.ibm.com/findings/v1/docs) ## Requirements Node.js 6.4.0 or later ## Installation ### For [Node.js](https://nodejs.org/) To install the SDK: ```shell npm install ibmcloud-security-advisor-findings --save ``` Install from a tagged release, for example, v1.0.0 ```shell npm install ibm-cloud-security/security-advisor-findings-sdk-nodejs#v1.0.0 ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript var findings = require('ibmcloud-security-advisor-findings'); var defaultClient = findings.ApiClient.instance; defaultClient.basePath = "https://us-south.secadvisor.cloud.ibm.com/findings" let apiInstance = new findings.FindingsNotesApi(); let accountId = "accountId_example"; let authorization = "authorization_example"; let providerId = "providerId_example"; apiInstance.listNotes(accountId, authorization, providerId).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { console.error(error); }); ``` To target different regions set the `basePath` on the client instance accordingly: * Dallas - `https://us-south.secadvisor.cloud.ibm.com/findings` * London - `https://eu-gb.secadvisor.cloud.ibm.com/findings` ## Generating Authorization token `Authorization token` to be passed as second paramters in all the function calls is obtained by calling [IBM Cloud IAM API](https://cloud.ibm.com/apidocs/iam-identity-token-api). It is a bearer token in JWT format. Find a sample [here](https://cloud.ibm.com/apidocs/security-advisor/findings#authentication). Read more about the access [here](https://cloud.ibm.com/docs/security-advisor?topic=security-advisor-service-access) ## Documentation for API Endpoints All URIs are relative to: * https://us-south.secadvisor.cloud.ibm.com/findings * https://eu-gb.secadvisor.cloud.ibm.com/findings Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *findings.FindingsGraphApi* | [**postGraph**](docs/FindingsGraphApi.md#postGraph) | **POST** /v1/{account_id}/graph | query findings *findings.FindingsNotesApi* | [**createNote**](docs/FindingsNotesApi.md#createNote) | **POST** /v1/{account_id}/providers/{provider_id}/notes | Creates a new `Note`. *findings.FindingsNotesApi* | [**deleteNote**](docs/FindingsNotesApi.md#deleteNote) | **DELETE** /v1/{account_id}/providers/{provider_id}/notes/{note_id} | Deletes the given `Note` from the system. *findings.FindingsNotesApi* | [**getNote**](docs/FindingsNotesApi.md#getNote) | **GET** /v1/{account_id}/providers/{provider_id}/notes/{note_id} | Returns the requested `Note`. *findings.FindingsNotesApi* | [**getOccurrenceNote**](docs/FindingsNotesApi.md#getOccurrenceNote) | **GET** /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id}/note | Gets the `Note` attached to the given `Occurrence`. *findings.FindingsNotesApi* | [**listNotes**](docs/FindingsNotesApi.md#listNotes) | **GET** /v1/{account_id}/providers/{provider_id}/notes | Lists all `Notes` for a given provider. *findings.FindingsNotesApi* | [**updateNote**](docs/FindingsNotesApi.md#updateNote) | **PUT** /v1/{account_id}/providers/{provider_id}/notes/{note_id} | Updates an existing `Note`. *findings.FindingsOccurrencesApi* | [**createOccurrence**](docs/FindingsOccurrencesApi.md#createOccurrence) | **POST** /v1/{account_id}/providers/{provider_id}/occurrences | Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource. *findings.FindingsOccurrencesApi* | [**deleteOccurrence**](docs/FindingsOccurrencesApi.md#deleteOccurrence) | **DELETE** /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id} | Deletes the given `Occurrence` from the system. *findings.FindingsOccurrencesApi* | [**getOccurrence**](docs/FindingsOccurrencesApi.md#getOccurrence) | **GET** /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id} | Returns the requested `Occurrence`. *findings.FindingsOccurrencesApi* | [**listNoteOccurrences**](docs/FindingsOccurrencesApi.md#listNoteOccurrences) | **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. *findings.FindingsOccurrencesApi* | [**listOccurrences**](docs/FindingsOccurrencesApi.md#listOccurrences) | **GET** /v1/{account_id}/providers/{provider_id}/occurrences | Lists active `Occurrences` for a given provider matching the filters. *findings.FindingsOccurrencesApi* | [**updateOccurrence**](docs/FindingsOccurrencesApi.md#updateOccurrence) | **PUT** /v1/{account_id}/providers/{provider_id}/occurrences/{occurrence_id} | Updates an existing `Occurrence`. ## Documentation for Models - [findings.ApiEmpty](docs/ApiEmpty.md) - [findings.ApiListNoteOccurrencesResponse](docs/ApiListNoteOccurrencesResponse.md) - [findings.ApiListNotesResponse](docs/ApiListNotesResponse.md) - [findings.ApiListOccurrencesResponse](docs/ApiListOccurrencesResponse.md) - [findings.ApiListProvidersResponse](docs/ApiListProvidersResponse.md) - [findings.ApiListProvidersResponseInner](docs/ApiListProvidersResponseInner.md) - [findings.ApiNote](docs/ApiNote.md) - [findings.ApiNoteKind](docs/ApiNoteKind.md) - [findings.ApiNoteRelatedUrl](docs/ApiNoteRelatedUrl.md) - [findings.ApiOccurrence](docs/ApiOccurrence.md) - [findings.ApiProvider](docs/ApiProvider.md) - [findings.Body](docs/Body.md) - [findings.Body1](docs/Body1.md) - [findings.Body2](docs/Body2.md) - [findings.Body3](docs/Body3.md) - [findings.BreakdownCardElement](docs/BreakdownCardElement.md) - [findings.Card](docs/Card.md) - [findings.CardElement](docs/CardElement.md) - [findings.Certainty](docs/Certainty.md) - [findings.Context](docs/Context.md) - [findings.DataTransferred](docs/DataTransferred.md) - [findings.Finding](docs/Finding.md) - [findings.FindingCountValueType](docs/FindingCountValueType.md) - [findings.FindingType](docs/FindingType.md) - [findings.InlineResponse200](docs/InlineResponse200.md) - [findings.InlineResponse2001](docs/InlineResponse2001.md) - [findings.InlineResponse2001Context](docs/InlineResponse2001Context.md) - [findings.InlineResponse2001Finding](docs/InlineResponse2001Finding.md) - [findings.InlineResponse2001FindingDataTransferred](docs/InlineResponse2001FindingDataTransferred.md) - [findings.InlineResponse2001FindingNetworkConnection](docs/InlineResponse2001FindingNetworkConnection.md) - [findings.InlineResponse2001FindingNetworkConnectionClient](docs/InlineResponse2001FindingNetworkConnectionClient.md) - [findings.InlineResponse2001Kpi](docs/InlineResponse2001Kpi.md) - [findings.InlineResponse2001Occurrences](docs/InlineResponse2001Occurrences.md) - [findings.InlineResponse2002](docs/InlineResponse2002.md) - [findings.InlineResponse200Card](docs/InlineResponse200Card.md) - [findings.InlineResponse200CardElements](docs/InlineResponse200CardElements.md) - [findings.InlineResponse200Finding](docs/InlineResponse200Finding.md) - [findings.InlineResponse200FindingNextSteps](docs/InlineResponse200FindingNextSteps.md) - [findings.InlineResponse200Kpi](docs/InlineResponse200Kpi.md) - [findings.InlineResponse200Notes](docs/InlineResponse200Notes.md) - [findings.InlineResponse200RelatedUrl](docs/InlineResponse200RelatedUrl.md) - [findings.InlineResponse200ReportedBy](docs/InlineResponse200ReportedBy.md) - [findings.InlineResponse200Section](docs/InlineResponse200Section.md) - [findings.Kpi](docs/Kpi.md) - [findings.KpiType](docs/KpiType.md) - [findings.KpiValueType](docs/KpiValueType.md) - [findings.NetworkConnection](docs/NetworkConnection.md) - [findings.NumericCardElement](docs/NumericCardElement.md) - [findings.NumericCardElementValueType](docs/NumericCardElementValueType.md) - [findings.RemediationStep](docs/RemediationStep.md) - [findings.Reporter](docs/Reporter.md) - [findings.Section](docs/Section.md) - [findings.Severity](docs/Severity.md) - [findings.SocketAddress](docs/SocketAddress.md) - [findings.TimeSeriesCardElement](docs/TimeSeriesCardElement.md) - [findings.ValueType](docs/ValueType.md) ## Examples Try out the [examples](examples). Go to [Security Advisor dashboard](https://cloud.ibm.com/security-advisor#/dashboard) for visualizing it. The examples require you to export the following variables: ```sh export account_id= export authorization=> export region=eu-gb node create_notes.js node create_occurrences.js ``` `us-south` will target the Dallas endpoint. Use `eu-gb` to target London by exporting `region`. Default region in the example is `us-south` [Obtain authorization token](#generating-authorization-token) for filling in the token value. We have used async/await to simplify the examples. Make sure your Node version supports it natively. You can check [here](https://node.green/#ES2017-features-async-functions)