Generate Company Report
securityscorecard.generate_company_report
ActionBusiness appsconnection required
Calls the SecurityScorecard API with the connection's credentials.
Queue a company summary report and return the report id it was given.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- SecurityScorecard
- Secret shape
- the API token, or {"api_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
scorecard_identifier The company's primary domain, which is how SecurityScorecard identifies a scorecard. | string | Yes | — | — | example.com |
branding Whose logo the report carries; anything but the default needs white-labelling enabled on your account. | string | No | — | one of "securityscorecard", "company_and_securityscorecard", "company" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"scorecard_identifier": "example.com"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The report id SecurityScorecard queued the job under. | string | — |
report_type Always 'summary' for this node. | string | — |
scorecard_identifier The company the report is about. | string | — |
{
"id": "",
"report_type": "",
"scorecard_identifier": ""
}Notes
- Generation is asynchronous: this returns an id, and the download URL appears in securityscorecard.list_recent_reports once it completes.
- SecurityScorecard refuses the call for a company that is not yet in one of your portfolios.
See Generate Company Report run in a workflow.
In a technical demo we add the SecurityScorecard connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.