---
title: Security Scorecard
slug: connectors/security-scorecard
docTags: 
createdAt: 2026-06-09T16:29:46.648Z
---

The Security Scorecard connector allows for automated interactions with Security Scorecard's platform, enabling users to manage portfolios, analyze company scorecards, and generate security reports.

Security Scorecard offers a comprehensive platform for monitoring and managing enterprise security posture and third-party risk. By integrating with Swimlane Turbine, users can automate the process of adding companies to portfolios, generating detailed security reports, and retrieving company scores and issue counts. This connector streamlines the risk assessment process, enabling users to make informed security decisions quickly and efficiently. The integration enhances Swimlane's low-code automation capabilities, allowing users to leverage Security Scorecard's powerful analytics without manual intervention.

### Limitations

None to date.

### Supported Versions

This Security Scorecard connector uses the Version 1 API.

### Additional Docs

- [API Documentation](https://securityscorecard.readme.io/reference/introduction)
- [Authentication](https://platform.securityscorecard.io/#/my-settings/api)

## Configuration

### Prerequisites

To effectively utilize the Security Scorecard connector with Swimlane Turbine, ensure you have the following:

- API Key Authentication:
  - URL: The endpoint URL for Security Scorecard's API.
  - API Key: Your unique identifier to authenticate with Security Scorecard's API.

## Authentication Methods

### API Key Authentication with the following parameters:

- URL: The base endpoint for Security Scorecard's API.
- API Key: Your unique identifier to authenticate with Security Scorecard's API.

## Capabilities

This Connector provides the following capabilities:

- Add Company to Portfolio
- Download a Generated Report
- Generate a Company Detailed Report
- Generate a Company Issues Report
- Generate a Company Summary Report
- Get a Company Factor Scores and Issue Counts
- Get a Company Information and Scorecard Summary
- Get All Companies in a Portfolio
- Get All Portfolios
- Get Factor Scores for the Industry
- Get Score for the Industry
- Remove Company from Portfolio

### Add Company to Portfolio

- Adds a specified company to a portfolio on Security Scorecard using the portfolio ID and domain as required parameters [Link](https://securityscorecard.readme.io/reference/put_portfolios-portfolio-id-companies-domain).

### Download a Generated Report

- Retrieve a previously generated report from Security Scorecard using the specified file path [Link](https://securityscorecard.readme.io/reference/get_reports-files-file-path-1).

### Generate a Company Detailed Report

- Generates a comprehensive report for a company using its scorecard identifier in Security Scorecard [Link](https://securityscorecard.readme.io/reference/post_reports-detailed-1).

### Generate a Company Issues Report

- Generates a detailed report on company issues using the Security Scorecard, requiring a scorecard identifier [Link](https://securityscorecard.readme.io/reference/post_reports-issues-1).

### Generate a Company Summary Report

- Generates a comprehensive summary report for a company using the scorecard identifier provided [Link](https://securityscorecard.readme.io/reference/post_reports-summary-1).

### Get a Company Factor Scores and Issue Counts

- Retrieve factor scores and issue counts for a specified company using its scorecard identifier in Security Scorecard [Link](https://securityscorecard.readme.io/reference/get_companies-scorecard-identifier-factors).

### Get a Company Information and Scorecard Summary

- Retrieve a company's information and scorecard summary using the specified scorecard identifier[Link](https://securityscorecard.readme.io/reference/get_companies-scorecard-identifier).

### Get All Companies in Portfolio

- Retrieve all companies within a specified portfolio on Security Scorecard using the portfolio id [Link](https://securityscorecard.readme.io/reference/get_companies-scorecard-identifier).

### Get All Portfolios

- Fetches all accessible portfolios from Security Scorecard, providing a comprehensive overview [Link](https://securityscorecard.readme.io/reference/get_portfolios).

### Get Factor Scores for the Industry

- Retrieve Security Scorecard factor scores for a specified industry using the 'industry' path parameter[Link](https://securityscorecard.readme.io/reference/get_industries-industry-factors).

### Get Score for the Industry

- Retrieve the security score for a specified industry using Security Scorecard, requiring an 'industry' path parameter [Link](https://securityscorecard.readme.io/reference/get_industries-industry-score).

### Remove Company from Portfolio

- Removes a specified company from a portfolio on Security Scorecard using the portfolio ID and domain[Link](https://securityscorecard.readme.io/reference/delete_portfolios-portfolio-id-companies-domain).

# Configurations

## Security Scorecard API Key Authentication

Authenticates using an API Key

### Configuration Parameters

| **Parameter** | **Description**                    | **Type** | **Required** |
| ------------- | ---------------------------------- | -------- | ------------ |
| url           | A URL to the target host.          | string   | Required     |
| x-apikey      | API key                            | string   | Required     |
| verify\_ssl   | Verify SSL certificate             | boolean  | Optional     |
| http\_proxy   | A proxy to route requests through. | string   | Optional     |

# Actions

## Add Company to Portfolio

Adds a company to a specified portfolio in Security Scorecard using the portfolio ID and domain.

### Endpoint

- **URL:** `portfolios/{{portfolio_id}}/companies/{{domain}}`
- **Method:** `PUT`

### Input

| **Argument Name**              | **Type** | **Required** | **Description**                                                                |
| ------------------------------ | -------- | ------------ | ------------------------------------------------------------------------------ |
| `path_parameters.portfolio_id` | string   | Required     | A portfolio unique ID.                                                         |
| `path_parameters.domain`       | string   | Required     | A company's internet domain. this parameter accepts any valid internet domain. |

### Input Example

`{"path_parameters":{"portfolio_id":"3f401492-6a8d-5443-9448-4436ff619210","domain":"swimlane.com"}}`

### Output

| **Parameter**             | **Type** | **Description**                         |
| ------------------------- | -------- | --------------------------------------- |
| `status_code`             | number   | HTTP status code of the response        |
| `reason`                  | string   | Response reason phrase                  |
| `name`                    | string   | Name of the resource                    |
| `domain`                  | string   | Output field: domain                    |
| `grade`                   | string   | Output field: grade                     |
| `grade_url`               | string   | URL endpoint for the request            |
| `score`                   | number   | Score value                             |
| `industry`                | string   | Output field: industry                  |
| `size`                    | string   | Output field: size                      |
| `last30days_score_change` | number   | Output field: last30days\_score\_change |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Content-Length":"223","Connection":"keep-alive","Date":"Fri, 08 Nov 2024 15:02:26 GMT","ETag":"W/\"df-w72g/OyevToautRsJi/RpUNJotQ\"","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"DENY","X-XSS-Protection":"1; mode=block","Vary":"Origin, Accept-Encoding","Access-Control-Expose-Headers":"x-csrf-token,ratelimit-limit,ratelimit-remaining,ratelimit-reset","X-Cache":"Miss from...`

## Download a Generated Report

Retrieve a previously generated report from Security Scorecard by specifying the file path.

### Endpoint

- **URL:** `reports/files/{{file_path}}`
- **Method:** `GET`

### Input

| **Argument Name**           | **Type** | **Required** | **Description**                                              |
| --------------------------- | -------- | ------------ | ------------------------------------------------------------ |
| `parameters.lng`            | string   | Optional     | Language in which you want to download the generated report. |
| `path_parameters.file_path` | string   | Required     | A path to the file.                                          |

### Input Example

`{"parameters":{"lng":"en-US"},"path_parameters":{"file_path":"u_1bebe650-38ff-5f7f-8589-7f2f84c095e3/9bf84240-e6b8-42c6-a9fd-fdc8c60b7333/Swimlane-Issues-Report-2024-11-09.json.pdf"}}`

### Output

| **Parameter**    | **Type** | **Description**                  |
| ---------------- | -------- | -------------------------------- |
| `status_code`    | number   | HTTP status code of the response |
| `reason`         | string   | Response reason phrase           |
| `file`           | object   | Output field: file               |
| `file.file`      | string   | Output field: file.file          |
| `file.file_name` | string   | Name of the resource             |

### Output Example

`{"file":{"file":"string","file_name":"Example Name"}}`

## Generate a Company Detailed Report

Generates a comprehensive report for a company using its scorecard identifier in Security Scorecard.

### Endpoint

- **URL:** `reports/detailed`
- **Method:** `POST`

### Input

| **Argument Name**      | **Type** | **Required** | **Description**                                                                                                                                                                                                                                                                                |
| ---------------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `scorecard_identifier` | string   | Optional     | Primary identifier of a company or scorecard.                                                                                                                                                                                                                                                  |
| `branding`             | string   | Optional     | Branding has valid values which are securityscorecard(default) - reports are only displaying SecurityScorecard's logo, company\_and\_securityscorecard - your company's logo will be used in conjunction with Security Scorecard's. company - reports are only displaying your company's logo. |
| `score-type`           | string   | Optional     | Scoring version.                                                                                                                                                                                                                                                                               |

### Input Example

`{"json_body":{"scorecard_identifier":"swimlane.com","branding":"securityscorecard","score-type":"scoring_v2"}}`

### Output

| **Parameter**       | **Type** | **Description**                  |
| ------------------- | -------- | -------------------------------- |
| `status_code`       | number   | HTTP status code of the response |
| `reason`            | string   | Response reason phrase           |
| `params`            | object   | Output field: params             |
| `params.domain`     | string   | Output field: params.domain      |
| `params.branding`   | string   | Output field: params.branding    |
| `params.score_type` | string   | Type of the resource             |
| `format`            | string   | Output field: format             |
| `title`             | string   | Output field: title              |
| `id`                | string   | Unique identifier                |
| `report_type`       | string   | Type of the resource             |
| `created_at`        | string   | Output field: created\_at        |
| `is_new`            | boolean  | Output field: is\_new            |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Content-Length":"268","Connection":"keep-alive","Date":"Sat, 09 Nov 2024 16:13:05 GMT","ETag":"W/\"10c-7JEOk4vw5DCwaZMB0FTwT1NwEfk\"","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"DENY","X-XSS-Protection":"1; mode=block","Vary":"Origin, Accept-Encoding","Access-Control-Expose-Headers":"x-csrf-token,ratelimit-limit,ratelimit-remaining,ratelimit-reset","X-Cache":"Miss fro...`

## Generate a Company Issues Report

Generates a detailed report on company issues from Security Scorecard using a unique scorecard identifier.

### Endpoint

- **URL:** `reports/issues`
- **Method:** `POST`

### Input

| **Argument Name**      | **Type** | **Required** | **Description**                               |
| ---------------------- | -------- | ------------ | --------------------------------------------- |
| `scorecard_identifier` | string   | Optional     | Primary identifier of a company or scorecard. |
| `format`               | string   | Optional     | Output format.                                |
| `score-type`           | string   | Optional     | Type of the resource                          |

### Input Example

`{"json_body":{"scorecard_identifier":"swimlane.com","branding":"securityscorecard","score-type":"scoring_v2"}}`

### Output

| **Parameter**       | **Type** | **Description**                  |
| ------------------- | -------- | -------------------------------- |
| `status_code`       | number   | HTTP status code of the response |
| `reason`            | string   | Response reason phrase           |
| `params`            | object   | Output field: params             |
| `params.domain`     | string   | Output field: params.domain      |
| `params.format`     | string   | Output field: params.format      |
| `params.branding`   | string   | Output field: params.branding    |
| `params.score_type` | string   | Type of the resource             |
| `format`            | string   | Output field: format             |
| `title`             | string   | Output field: title              |
| `id`                | string   | Unique identifier                |
| `report_type`       | string   | Type of the resource             |
| `created_at`        | string   | Output field: created\_at        |
| `is_new`            | boolean  | Output field: is\_new            |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Content-Length":"279","Connection":"keep-alive","Date":"Sat, 09 Nov 2024 16:25:07 GMT","ETag":"W/\"117-kMkTD/D5fGlhEHByn6LU8aew6vk\"","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"DENY","X-XSS-Protection":"1; mode=block","Vary":"Origin, Accept-Encoding","Access-Control-Expose-Headers":"x-csrf-token,ratelimit-limit,ratelimit-remaining,ratelimit-reset","X-Cache":"Miss fro...`

## Generate a Company Summary Report

Generates a comprehensive summary report for a company in Security Scorecard using the provided scorecard identifier.

### Endpoint

- **URL:** `reports/summary`
- **Method:** `POST`

### Input

| **Argument Name**      | **Type** | **Required** | **Description**                                                                                                                                                                                                                                                                                |
| ---------------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `scorecard_identifier` | string   | Optional     | Primary identifier of a company or scorecard.                                                                                                                                                                                                                                                  |
| `branding`             | string   | Optional     | Branding has valid values which are securityscorecard(default) - reports are only displaying SecurityScorecard's logo, company\_and\_securityscorecard - your company's logo will be used in conjunction with Security Scorecard's. company - reports are only displaying your company's logo. |
| `score-type`           | string   | Optional     | Scoring version.                                                                                                                                                                                                                                                                               |

### Input Example

`{"json_body":{"scorecard_identifier":"swimlane.com","branding":"securityscorecard","score-type":"scoring_v2"}}`

### Output

| **Parameter**       | **Type** | **Description**                  |
| ------------------- | -------- | -------------------------------- |
| `status_code`       | number   | HTTP status code of the response |
| `reason`            | string   | Response reason phrase           |
| `params`            | object   | Output field: params             |
| `params.domain`     | string   | Output field: params.domain      |
| `params.branding`   | string   | Output field: params.branding    |
| `params.score_type` | string   | Type of the resource             |
| `format`            | string   | Output field: format             |
| `title`             | string   | Output field: title              |
| `id`                | string   | Unique identifier                |
| `report_type`       | string   | Type of the resource             |
| `created_at`        | string   | Output field: created\_at        |
| `is_new`            | boolean  | Output field: is\_new            |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Content-Length":"261","Connection":"keep-alive","Date":"Sat, 09 Nov 2024 16:18:43 GMT","ETag":"W/\"105-bWvgwK2jnsctDrwfvaf8OhXCwMo\"","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"DENY","X-XSS-Protection":"1; mode=block","Vary":"Origin, Accept-Encoding","Access-Control-Expose-Headers":"x-csrf-token,ratelimit-limit,ratelimit-remaining,ratelimit-reset","X-Cache":"Miss fro...`

## Get a Company Factor Scores and Issue Counts

Retrieve a company's factor scores and issue counts using its scorecard identifier in Security Scorecard.

### Endpoint

- **URL:** `companies/{{scorecard_identifier}}/factors`
- **Method:** `GET`

### Input

| **Argument Name**                      | **Type** | **Required** | **Description**                                            |
| -------------------------------------- | -------- | ------------ | ---------------------------------------------------------- |
| `parameters.severity`                  | string   | Optional     | Optionally filter issues by severity.                      |
| `parameters.severity_in`               | string   | Optional     | Optionally filter issues by comma separated severity list. |
| `parameters.score-type`                | string   | Optional     | Scoring version.                                           |
| `path_parameters.scorecard_identifier` | string   | Required     | Primary identifier of a company or scorecard.              |

### Input Example

`{"parameters":{"severity":"high","severity_in":"high,medium","score-type":"scoring_v2"},"path_parameters":{"scorecard_identifier":"swimlane.com"}}`

### Output

| **Parameter**                     | **Type** | **Description**                           |
| --------------------------------- | -------- | ----------------------------------------- |
| `status_code`                     | number   | HTTP status code of the response          |
| `reason`                          | string   | Response reason phrase                    |
| `entries`                         | array    | Output field: entries                     |
| `entries.name`                    | string   | Name of the resource                      |
| `entries.score`                   | number   | Score value                               |
| `entries.grade`                   | string   | Output field: entries.grade               |
| `entries.grade_url`               | string   | URL endpoint for the request              |
| `entries.issue_summary`           | array    | Output field: entries.issue\_summary      |
| `entries.issue_summary.file_name` | string   | Name of the resource                      |
| `entries.issue_summary.file`      | string   | Output field: entries.issue\_summary.file |
| `total`                           | number   | Output field: total                       |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Fri, 08 Nov 2024 15:19:04 GMT","ETag":"W/\"973-1OVUdb5pZQ/Gim/i21PHACeRR+k\"","Content-Encoding":"gzip","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"DENY","X-XSS-Protection":"1; mode=block","Vary":"Origin, Accept-Encoding","Access-Control-Expose-Headers":"x-csrf-token,ratelimit-limit,ratelimit-remaining,rat...`

## Get a Company Information and Scorecard Summary

Retrieve a company's profile and scorecard summary by using the provided scorecard identifier.

### Endpoint

- **URL:** `companies/{{scorecard_identifier}}`
- **Method:** `GET`

### Input

| **Argument Name**                      | **Type** | **Required** | **Description**                                                                                                                         |
| -------------------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| `parameters.score-type`                | string   | Optional     | Scoring version.                                                                                                                        |
| `parameters.with_provisional_status`   | boolean  | Optional     | Return if score is provisional.                                                                                                         |
| `path_parameters.scorecard_identifier` | string   | Required     | Primary identifier of a company or scorecard in SecurityScorecard. To determine this value, company must be added to a portfolio first. |

### Input Example

`{"parameters":{"score-type":"scoring_v2","with_provisional_status":true},"path_parameters":{"scorecard_identifier":"swimlane.com"}}`

### Output

| **Parameter**            | **Type** | **Description**                        |
| ------------------------ | -------- | -------------------------------------- |
| `status_code`            | number   | HTTP status code of the response       |
| `reason`                 | string   | Response reason phrase                 |
| `name`                   | string   | Name of the resource                   |
| `domain`                 | string   | Output field: domain                   |
| `grade`                  | string   | Output field: grade                    |
| `grade_url`              | string   | URL endpoint for the request           |
| `score`                  | number   | Score value                            |
| `industry`               | string   | Output field: industry                 |
| `size`                   | string   | Output field: size                     |
| `uuid`                   | string   | Unique identifier                      |
| `last30day_score_change` | number   | Output field: last30day\_score\_change |
| `is_custom`              | boolean  | Output field: is\_custom               |
| `is_entity`              | boolean  | Output field: is\_entity               |
| `is_un_published`        | boolean  | Output field: is\_un\_published        |
| `created_at`             | string   | Output field: created\_at              |
| `disputed`               | boolean  | Output field: disputed                 |
| `description`            | string   | Output field: description              |
| `provisional`            | boolean  | Output field: provisional              |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Content-Length":"385","Connection":"keep-alive","Date":"Sat, 09 Nov 2024 15:42:24 GMT","ETag":"W/\"181-/Hl10Sn6bxXJGP2h11aOL/yQwRc\"","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"DENY","X-XSS-Protection":"1; mode=block","Vary":"Origin, Accept-Encoding","Access-Control-Expose-Headers":"x-csrf-token,ratelimit-limit,ratelimit-remaining,ratelimit-reset","X-Cache":"Miss fro...`

## Get All Companies in a Portfolio

Retrieve all companies in a given portfolio from Security Scorecard using the unique portfolio ID.

### Endpoint

- **URL:** `portfolios/{{portfolio_id}}/companies`
- **Method:** `GET`

### Input

| **Argument Name**                        | **Type** | **Required** | **Description**                         |
| ---------------------------------------- | -------- | ------------ | --------------------------------------- |
| `parameters.grade`                       | string   | Optional     | Company score grade filter.             |
| `parameters.industry`                    | string   | Optional     | Industry filter.                        |
| `parameters.vulnerability`               | string   | Optional     | CVE vulnerability filter.               |
| `parameters.issue_type`                  | string   | Optional     | Issue type filter.                      |
| `parameters.status`                      | string   | Optional     | Company status.                         |
| `parameters.had_breach_within_last_days` | number   | Optional     | Companies with breaches in last N days. |
| `parameters.score-type`                  | string   | Optional     | Scoring version.                        |
| `path_parameters.portfolio_id`           | string   | Required     | A portfolio unique ID.                  |

### Input Example

`{"parameters":{"grade":"A","industry":"retail","vulnerability":"CVE-2016-0800","issue_type":"service_vuln_host_medium","status":"active","had_breach_within_last_days":15,"score-type":"scoring_v2"},"path_parameters":{"portfolio_id":"d539810a-0e3d-55e0-aa98-68fbe02818d4"}}`

### Output

| **Parameter**                     | **Type** | **Description**                                 |
| --------------------------------- | -------- | ----------------------------------------------- |
| `status_code`                     | number   | HTTP status code of the response                |
| `reason`                          | string   | Response reason phrase                          |
| `entries`                         | array    | Output field: entries                           |
| `entries.domain`                  | string   | Output field: entries.domain                    |
| `entries.uuid`                    | string   | Unique identifier                               |
| `entries.name`                    | string   | Name of the resource                            |
| `entries.score`                   | number   | Score value                                     |
| `entries.added_date`              | string   | Date value                                      |
| `entries.grade`                   | string   | Output field: entries.grade                     |
| `entries.grade_url`               | string   | URL endpoint for the request                    |
| `entries.last30days_score_change` | number   | Output field: entries.last30days\_score\_change |
| `entries.industry`                | string   | Output field: entries.industry                  |
| `entries.size`                    | string   | Output field: entries.size                      |
| `entries.products`                | array    | Output field: entries.products                  |
| `entries.products_count`          | number   | Count value                                     |
| `total`                           | number   | Output field: total                             |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Fri, 08 Nov 2024 14:12:56 GMT","ETag":"W/\"86a7-3tL+dsRYd+2cH6OBi5CH+vBzjUQ\"","Content-Encoding":"gzip","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"DENY","X-XSS-Protection":"1; mode=block","Vary":"Origin, Accept-Encoding","Access-Control-Expose-Headers":"x-csrf-token,ratelimit-limit,ratelimit-remaining,ra...`

## Get All Portfolios

Retrieves all portfolios accessible in Security Scorecard, offering a complete overview.

### Endpoint

- **URL:** `portfolios`
- **Method:** `GET`

### Output

| **Parameter**                   | **Type** | **Description**                   |
| ------------------------------- | -------- | --------------------------------- |
| `status_code`                   | number   | HTTP status code of the response  |
| `reason`                        | string   | Response reason phrase            |
| `entries`                       | array    | Output field: entries             |
| `entries.id`                    | string   | Unique identifier                 |
| `entries.name`                  | string   | Name of the resource              |
| `entries.privacy`               | string   | Output field: entries.privacy     |
| `entries.read_only`             | boolean  | Output field: entries.read\_only  |
| `entries.created_at`            | string   | Output field: entries.created\_at |
| `entries.is_public`             | boolean  | Output field: entries.is\_public  |
| `entries.owner_organization_id` | string   | Unique identifier                 |
| `entries.owner_team_id`         | string   | Unique identifier                 |
| `entries.owner_user_id`         | string   | Unique identifier                 |
| `total`                         | number   | Output field: total               |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Content-Length":"559","Connection":"keep-alive","Date":"Fri, 08 Nov 2024 13:21:57 GMT","ETag":"W/\"bd63-7mNg3Cz4J8RSOkrOzOBFvD6Peok\"","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"DENY","X-XSS-Protection":"1; mode=block","Vary":"Origin, Accept-Encoding","Access-Control-Expose-Headers":"x-csrf-token,ratelimit-limit,ratelimit-remaining,ratelimit-reset","X-Cache":"Miss fr...`

## Get Factor Scores for the Industry

Retrieve factor scores from Security Scorecard for a given industry by specifying the 'industry' path parameter.

### Endpoint

- **URL:** `industries/{{industry}}/factors`
- **Method:** `GET`

### Input

| **Argument Name**          | **Type** | **Required** | **Description**                                              |
| -------------------------- | -------- | ------------ | ------------------------------------------------------------ |
| `parameters.score-type`    | string   | Optional     | Scoring version.                                             |
| `path_parameters.industry` | string   | Required     | Parameters for the Get Factor Scores for the Industry action |

### Input Example

`{"parameters":{"score-type":"scoring_v2"},"path_parameters":{"industry":"technology"}}`

### Output

| **Parameter**   | **Type** | **Description**                  |
| --------------- | -------- | -------------------------------- |
| `status_code`   | number   | HTTP status code of the response |
| `reason`        | string   | Response reason phrase           |
| `entries`       | array    | Output field: entries            |
| `entries.name`  | string   | Name of the resource             |
| `entries.score` | number   | Score value                      |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Content-Length":"399","Connection":"keep-alive","Date":"Sat, 09 Nov 2024 14:38:52 GMT","ETag":"W/\"18f-QrepKaXszI85Q2f+EJAVduZKwFA\"","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"DENY","X-XSS-Protection":"1; mode=block","Vary":"Origin, Accept-Encoding","Access-Control-Expose-Headers":"x-csrf-token,ratelimit-limit,ratelimit-remaining,ratelimit-reset","X-Cache":"Miss fro...`

## Get Score for the Industry

Retrieve a security score for a specified industry from Security Scorecard using the 'industry' path parameter.

### Endpoint

- **URL:** `industries/{{industry}}/score`
- **Method:** `GET`

### Input

| **Argument Name**          | **Type** | **Required** | **Description**                                      |
| -------------------------- | -------- | ------------ | ---------------------------------------------------- |
| `parameters.score-type`    | string   | Optional     | Scoring version.                                     |
| `path_parameters.industry` | string   | Required     | Parameters for the Get Score for the Industry action |

### Input Example

`{"parameters":{"score-type":"scoring_v2"},"path_parameters":{"industry":"technology"}}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |
| `industry`    | string   | Output field: industry           |
| `avg_score`   | number   | Score value                      |
| `avg_grade`   | string   | Output field: avg\_grade         |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Content-Length":"56","Connection":"keep-alive","Date":"Sat, 09 Nov 2024 15:59:25 GMT","ETag":"W/\"38-Z6zpZFW2UXOdAZkH5+s5XLKxUC4\"","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"DENY","X-XSS-Protection":"1; mode=block","Vary":"Origin, Accept-Encoding","Access-Control-Expose-Headers":"x-csrf-token,ratelimit-limit,ratelimit-remaining,ratelimit-reset","X-Cache":"Miss from ...`

## Remove Company from Portfolio

Removes a company from a specified portfolio in Security Scorecard by using the unique portfolio ID and domain.

### Endpoint

- **URL:** `portfolios/{{portfolio_id}}/companies/{{domain}}`
- **Method:** `DELETE`

### Input

| **Argument Name**              | **Type** | **Required** | **Description**                                                                |
| ------------------------------ | -------- | ------------ | ------------------------------------------------------------------------------ |
| `path_parameters.portfolio_id` | string   | Required     | A portfolio unique ID.                                                         |
| `path_parameters.domain`       | string   | Required     | A company's internet domain. this parameter accepts any valid internet domain. |

### Input Example

`{"path_parameters":{"portfolio_id":"3f401492-6a8d-5443-9448-4436ff619210","domain":"swimlane.com"}}`

### Output

| **Parameter**   | **Type** | **Description**                  |
| --------------- | -------- | -------------------------------- |
| `status_code`   | number   | HTTP status code of the response |
| `reason`        | string   | Response reason phrase           |
| `response_text` | string   | Output field: response\_text     |

### Output Example

`{"status_code":204,"response_headers":{"Connection":"keep-alive","Date":"Fri, 08 Nov 2024 15:08:24 GMT","Access-Control-Expose-Headers":"x-csrf-token,ratelimit-limit,ratelimit-remaining,ratelimit-reset","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"DENY","X-XSS-Protection":"1; mode=block","Vary":"Origin","X-Cache":"Miss from cloudfront","Via":"1.1 898e7abc0de61925c5e722b3d2dc3db4.cloudfront.net (CloudFront)","X-Amz-Cf-Pop":"HYD57-P6","X-Amz-Cf-Id":"VPI0ueGI...`

# Response Headers

| **Header**                    | **Description**                                       | **Example**                                                      |
| ----------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------- |
| Access-Control-Expose-Headers | HTTP response header: Access-Control-Expose-Headers   | x-csrf-token,ratelimit-limit,ratelimit-remaining,ratelimit-reset |
| Connection                    | HTTP response header: Connection                      | keep-alive                                                       |
| Content-Encoding              | HTTP response header: Content-Encoding                | gzip                                                             |
| Content-Length                | The length of the response body in bytes              | 385                                                              |
| Content-Type                  | The media type of the resource                        | application/json                                                 |
| Date                          | The date and time at which the message was originated | Fri, 08 Nov 2024 15:19:04 GMT                                    |
| ETag                          | An identifier for a specific version of a resource    | W/"117-kMkTD/D5fGlhEHByn6LU8aew6vk"                              |
| Strict-Transport-Security     | HTTP response header: Strict-Transport-Security       | max-age=31536000; includeSubDomains                              |
| Transfer-Encoding             | HTTP response header: Transfer-Encoding               | chunked                                                          |
| Vary                          | HTTP response header: Vary                            | Origin                                                           |
| Via                           | HTTP response header: Via                             | 1.1 84979832156646107bdbe881854d9eee.cloudfront.net (CloudFront) |
| X-Amz-Cf-Id                   | HTTP response header: X-Amz-Cf-Id                     | y6RQqIhoWumY9MxqPHOqyOw2hyOXT4ZjgVgQIFlYKgciaEAsm8lRGA==         |
| X-Amz-Cf-Pop                  | HTTP response header: X-Amz-Cf-Pop                    | HYD57-P6                                                         |
| X-Cache                       | HTTP response header: X-Cache                         | Miss from cloudfront                                             |
| X-Frame-Options               | HTTP response header: X-Frame-Options                 | DENY                                                             |
| X-XSS-Protection              | HTTP response header: X-XSS-Protection                | 1; mode=block                                                    |
