Security Scorecard
App Vendor: Security Scorecard
App Category: Metrics & Dashboards
Connector Version: 1.1.0
API Version: v1.0
About App
SecurityScorecard's API offers real-time access to cybersecurity ratings and insights, enabling users to integrate continuous risk monitoring and security posture assessment into their own applications and workflows effortlessly.
The SecurityScorecard app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Generate Issues Report | This action generates a company issues report. |
Get Alerts | This action retrieves the alerts from the last 7 days. |
Get All Companies in Portfolio | This action retrieves all companies in a portfolio. |
Get Company Detailed Report | This action generates a company's detailed report. |
Get Company Factor Score | This action retrieves company factor scores and issue counts. |
Get Company Information | This action retrieves company information and scorecard summary. |
Get Company's Historical Factor Score | This action retrieves a company's historical factor scores. |
Get Company's Historical Scores | This action retrieves a company's historical scores. |
Get Company's History Breach Event | This action retrieves a company's historical breach events. |
Get Company Summary Report | This action generates a company's summary report. |
Get Event Logs | This action retrieves company's historical events. |
Get Industry Factor Score | This action retrieves factor scores for the industry. |
Get Industry's Historical Factor Scores | This action retrieves historical factor scores for the industry. |
Get IP Asset Details | This action retrieves the details of an IP asset. |
Get Metadata for Factors | This action retrieves metadata for the factors used when scoring companies |
Get Metadata for Issue | This action retrieves metadata for issue types that can be detected in a company |
Get Portfolios | This action retrieves all portfolios user has access to. |
Get Recently Generated Report | This action retrieves reports you have generated recently. |
Get Score Context for Issue Type | This action retrieves the score context for an issue type. |
Get Score for Industry | This action retrieves the score for the industry. |
Generic Action | This is a generic action used to make requests to any SecurityScorecard endpoint. |
Configuration Parameters
The following configuration parameters are required for the SecurityScorecard app to communicate with the SecurityScorecard enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
API Key | Enter the API key to access SecurityScorecard. | Password | Required | |
Timeout | Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with SecurityScorecard. | Integer | Optional | Allowed Range: 15-120 Default value: 15 |
Verify | Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection. | Boolean | Optional | Default value: false |
Action: Generate Issues Report
This action generates a company issues report.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Scorecard Identifier | Enter the primary identifier of a company or scorecard in SecurityScorecard. Example: examplecompany.com | Text | Required | |
Output Format | Enter the output format. Example: | Text | Optional | Allowed values:
|
Score Type | Enter the scoring version. | Text | Optional | Allowed values:
|
Example Request
[
{
"scorecard_identifier": "examplecompany.com"
}
]Action: Get Alerts
This action retrieves alerts from the last 7 days.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Username | Enter the username. | Text | Required | |
Portfolio | Enter the portfolio ID to filter alerts. | Text | Optional | You can retrieve this using the action Get Portfolios. |
Sort | Enter the value by which you want to sort the results. | Text | Optional | Allowed values:
|
Order | Enter the order in which the alerts will be listed. | Text | Optional | Allowed values:
|
Page Size | Enter the page size. | Text | Optional |
Example Request
[
{
"username": "johndoe@example.com"
}
]Action: Get All Companies in Portfolio
This action retrieves all companies in a portfolio.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Portfolio ID | Enter the ID of the portfolio to fetch results. Example: be5a505e-d42c-5a46-8a3b-f683ca024ab2 | Text | Required | You can retrieve this using the action Get Portfolios. |
Extra Params | Add the filters to filter the results. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"extra_params": {},
"portfolio_id": "be5a505e-d42c-5a46-8a3b-f683ca024ab2"
}
]Action: Get Company's Historical Factor Score
This action retrieves a company's historical factor scores.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Scorecard Identifier | Enter the primary identifier of a company or scorecard in SecurityScorecard. Example: examplecompany.com | Text | Required | |
Date From | Enter the history start date. Example: 2018-01-20 | Text | Optional | |
Date To | Enter the history end date. Example: 2020-01-20 | Text | Optional | |
Timing | Enter date granularity. | Text | Optional | Allowed values:
Default value: daily |
Score Type | Enter the scoring version. | Text | Optional | Allowed values:
|
Example Request
[
{
"scorecard_identifier": "examplecompany.com"
}
]Action: Get Company's Historical Scores
This action retrieves a company's historical scores.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Scorecard Identifier | Enter the primary identifier of a company or scorecard in SecurityScorecard. Example: examplecompany.com | Text | Required | |
Date From | Enter the history start date. Example: 2018-01-20 | Text | Optional | |
Date To | Enter the history end date. Example: 2020-01-20 | Text | Optional | |
Timing | Enter date granularity. | Text | Optional | Allowed values:
Default value: daily |
Score Type | Enter the scoring version. | Text | Optional | Allowed values:
|
Example Request
[
{
"scorecard_identifier": "examplecompany.com"
}
]Action: Get Company's History Breach Event
This action retrieves a company's historical breaches events.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the primary domain identifying a company. Example: samplecompany.com | Text | Required | |
Date From | Enter the history start date. Example: 2018-01-14 | Text | Optional | |
Date To | Enter the history end date. Example: 2020-01-20 | Text | Optional |
Example Request
[
{
"domain": "samplecompany.com"
}
]Action: Get Company Detailed Report
This action generates a company's detailed report.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Scorecard Identifier | Enter the primary identifier of a company or scorecard in SecurityScorecard. Example: examplecompany.com | Text | Required | |
Branding | Enter the branding. | Text | Optional | NoteWhite-labeling has to be enabled for your account. Allowed values:
Default value:
|
Score Type | Enter the scoring version. | Text | Optional | Allowed values:
|
Example Request
[
{
"scorecard_identifier": "examplecompany.com"
}
]Action: Get Company Factor Score
This action retrieves company factor scores and issue counts.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Scorecard Identifier | Enter the primary identifier of a company or scorecard in SecurityScorecard. Example: examplecompany.com | Text | Required | |
Severity | Enter comma-separated values to filter issues by severity. Example: high, medium | Text | Optional | Allowed values:
|
Score Type | Enter the scoring version. | Text | Optional | Allowed values:
|
Example Request
[
{
"scorecard_identifier": "examplecompany.com"
}
]Action: Get Company Information
This action retrieves company information and scorecard summary.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Scorecard Identifier | Enter the primary identifier of a company or scorecard in SecurityScorecard. Example: examplecompany.com | Text | Required | |
Score Type | Enter the scoring version. | Text | Optional | Allowed values:
|
Example Request
[
{
"scorecard_identifier": "examplecompany.com"
}
]Action: Get Company Summary Report
This action generates a company's summary report.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Scorecard Identifier | Enter the primary identifier of a company or scorecard in SecurityScorecard. Example: examplecompany.com | Text | Required | |
Branding | Enter the branding. | Text | Optional | NoteWhite-labeling has to be enabled for your account. Allowed values:
Default value: securityscorecard |
Score Type | Enter the scoring version. | Text | Optional | Allowed values:
|
Example Request
[
{
"scorecard_identifier": "examplecompany.com"
}
]Action: Get Event Logs
This action retrieves company's historical events.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Scorecard Identifier | Enter the primary identifier of a company or scorecard. Example: examplecompany.com | Text | Required | |
Date From | Enter the date to fetch events that occurred after the given date and time. Example: 2024-09-12T00:00:00Z | Text | Optional | Provide the timestamp in ISO 8601 format. |
Date To | Enter to fetch events that occurred till the given date and time. Example: 2024-10-12T00:81:00Z | Text | Optional | Provide the timestamp in ISO 8601 format. |
Example Request
[
{
"scorecard_identifier": "examplecompany.com"
}
]Action: Get Industry's Historical Factor Scores
This action retrieves historical factor scores for the industry.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Industry | Enter the industry name. Example: industry | Text | Required | Allowed values:
|
Date From | Enter the history start date. Example: 2018-01-14 | Text | Optional | |
Date To | Enter the history end date. Example: 2020-01-20 | Text | Optional | |
Score Type | Enter the scoring version. | Text | Optional | Allowed values:
|
Example Request
[
{
"industry": "technology"
}
]Action: Get Industry Factor Score
This action retrieves factor scores for the industry.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Industry | Enter the industry name. Example: technology | Text | Required | Allowed values:
|
Score Type | Enter the scoring version. | Text | Optional | Allowed values:
|
Example Request
[
{
"industry": "technology"
}
]Action: Get IP Asset Details
This action retrieves the details of an IP asset.
Parameter | Description | Field Type | Required/Optional | Comments |
IP Address | Enter the IP address to get the asset details. | Text | Required |
Example Request
[
{
"ip": "1.1.1.1"
}
]Action: Get Metadata for Factors
This action retrieves metadata for the factors used when scoring companies.
Action Input Parameters
No input parameters are required for this action.
Action: Get Metadata for Issue
This action retrieves metadata for issue types that can be detected in a company.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Issue Type | Enter the type of the issue. | Text | Optional | You can leave this blank to get a summary for all possible issue-types. |
Action: Get Portfolios
This action retrieves all portfolios the user has access to.
Action Input Parameters
No input parameters are required for this action.
Action: Get Recently Generated Report
This action retrieves reports you have generated recently.
Action Input Parameters
No input parameters are required for this action.
Action: Get Score Context for Issue Type
This action retrieves the score context for an issue type.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the primary domain identifying a company. Example: samplecompany.com | Text | Required | |
Issue Type | Enter the issue type to get context. Example: unsafe_sri | Text | Required |
Example Request
[
{
"domain": "samplecompany.com",
"issue_type": "unsafe_sri"
}
]Action: Get Score for Industry
This action retrieves score for the industry.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Industry | Enter the industry name. Example: technology | Text | Required | Allowed values:
|
Score Type | Enter the scoring version. | Text | Optional | Allowed values:
|
Example Request
[
{
"industry": "technology"
}
]Action: Generic Action
This is a generic action used to make requests to any SecurityScorecard endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Method | Enter the HTTP method to make the request. Example: GET | Text | Required | |
Endpoint | Enter the endpoint to make the request. Example: /schedules/{schedule_id} | Text | Required | |
Query Params | Enter the query parameters to pass to the API. | Key Value | Optional | |
Payload | Enter the payload to pass to the API. | Any | Optional | |
Extra Fields | Enter the extra fields to pass to the API. | Key Value | Optional |
Example Request
[
{
"method": "GET",
"endpoint": "/schedules/{schedule_id}"
}
]