Add documentation for SecurityScorecard node

This commit is contained in:
Harshil 2021-02-04 10:51:58 +05:30
parent c7a0462fdc
commit cecc2e2835
6 changed files with 141 additions and 0 deletions

View File

@ -0,0 +1,31 @@
---
permalink: /credentials/securityScorecard
description: Learn to configure credentials for the SecurityScorecard node in n8n
---
# SecurityScorecard
You can use these credentials to authenticate the following nodes with SecurityScorecard.
- [SecurityScorecard](../../nodes-library/nodes/SecurityScorecard/README.md)
## Prerequisites
Create a [SecurityScorecard](https://securityscorecard.com/) account.
## Using API
1. Open your SecurityScorecard [dashboard](https://platform.securityscorecard.io/#/home).
2. Click on ***Integratoins*** and select 'Get an API Key'.
3. Click on ***Generate new API token***.
4. Click on the ***Confirm*** button.
5. Copy the generated API key.
6. Enter a name for your credentials in the ***Credentials Name*** field in the 'SecurityScorecard API' credentials in n8n.
7. Paste the API key in the ***API Key*** field in the 'Security Scorecard API' credentials in n8n.
8. Click on the ***Create*** button to create your credentials.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/0g1YLkNBfnM" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

View File

@ -0,0 +1,110 @@
---
permalink: /nodes/n8n-nodes-base.securityScorecard
description: Learn how to use the SecurityScorecard node in n8n
---
# SecurityScorecard
[SecurityScorecard](https://securityscorecard.com) enables organizations to prove and maintain compliance with leading regulation and standards mandates that include PCI, NIST, SOX, GDPR, and many others.
::: tip 🔑 Credentials
You can find authentication information for this node [here](../../../credentials/SecurityScorecard/README.md).
:::
## Basic Operations
::: details Company
- Get company factor scores and issue counts
- Get a company's historical factor scores
- Get a company's historical scores
- Get company information and a summary of their scorecard
- Get a company's score improvement plan
:::
::: details Industry
- Get factor scores
- Get historical factor scores
- Get score
:::
::: details Invite
- Crean an invite for a company/user
:::
::: details Portfolio
- Create a portfolio
- Delete a portfolio
- Get all portfolios
- Update a portfolio
:::
::: details Portfolio Company
- Add a company to a portfolio
- Get all companies in a portfolio
- Remove a company from a portfolio
:::
::: details Report
- Download a generated report
- Generate a report
- Get a list of the recently generated report
:::
## Example Usage
This workflow allows you to generate, retrieve and download a report using the SecurityScorecard node. You can also find the [workflow](https://n8n.io/workflows/920) on n8n.io. This example usage workflow uses the following nodes.
- [Start](../../core-nodes/Start/README.md)
- [SecurityScorecard]()
The final workflow should look like the following image.
![A workflow with the SecurityScorecard node](./workflow.png)
### 1. Start node
The Start node exists by default when you create a new workflow.
### 2. SecurityScorecard node (generate: report)
This node will generate a full scorecard report for a company that we specify.
1. First of all, you'll have to enter credentials for the SecurityScorecard node. You can find out how to do that [here](../../../credentials/SecurityScorecard/README.md).
2. Select 'Report' from the ***Resource*** dropdown list.
3. Select 'Generate' from the ***Operation*** dropdown list.
4. Select 'Full Scorecard' from the ***Report*** dropdown list.
5. Enter the domain of the company in the ***Scorecard Identifier*** field.
6. Click on ***Execute Node*** to run the node.
In the screenshot below, you will notice that the node generates a full scorecard report of `n8n.io`.
![Using the SecurityScorecard node to create full scorecard report](./SecurityScorecard_node.png)
### 3. SecurityScorecard1 node (getAll: report)
This node will return a report from SecurityScorecard.
1. Select the credentials that you entered in the previous node.
2. Select 'Report' from the ***Resource*** dropdown list.
3. Select 'Get All' from the ***Operation*** dropdown list.
4. Enter `1` in the ***Limit*** field. By setting it to one, the node will return a single report.
5. Click on ***Execute Node*** to run the node.
In the screenshot below, you will notice that the node returns a report from SecurityScroecard.
![Using the SecurityScorecard node to get a report](./SecurityScorecard1_node.png)
### 4. SecurityScorecard2 node (download: report)
This node will download the report that got returned by the previous node.
::: v-pre
1. Select the credentials that you entered in the previous node.
2. Select 'Report' from the ***Resource*** dropdown list.
3. Select 'Download' from the ***Operation*** dropdown list.
4. Click on the gears icon next to the ***Report URL*** field and click on ***Add Expression***.
5. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > download_url. You can also add the following expression: `{{$json["download_url"]}}`.
6. Click on ***Execute Node*** to run the node.
:::
In the screenshot below, you will notice that the node downloads the report that got returned by the previous node.
![Using the SecurityScorecard node to download a report](./SecurityScorecard2_node.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 146 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 149 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB