View as Markdown
Security Reporter icon

Security Reporter ACTION

Create Security Finding

Creates a new security finding. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Security Reporter account once, then configure and run Create Security Finding from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "security_reporter-create-finding",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    security_reporter: { authProvisionId: "apn_xxxxxxx" },
    assessmentId: "Assessment ID",
    title: "Title",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Security Finding inputs
Property Type Description
assessmentId Assessment ID string
The ID of the assessment
Required Dynamic
title Title string
Title of the finding. Must not be greater than 191 characters.
Required
targets Targets string[]
The IDs of targets the finding applies to. Each target must belong to the assessment.
Required Dynamic
assessmentSectionId Assessment Section ID string
The ID of the assessment section to put the finding in. The section must belong to the assessment, and its can_have_findings must be true.
Required Dynamic
isVulnerability Is Vulnerability boolean
Whether the finding is for a vulnerability (and has associated severity metrics).
Required
foundAt Found At string
The date when the finding was found. Format: YYYY-MM-DDTHH:MM:SS.
Optional
priority Priority string
How urgent resolving this finding is. Must be a valid priority.
Optional
complexity Complexity string
How complex resolving this finding is. Must be a valid complexity.
Optional
action Action string
The recommended action (under 500 characters) to resolve this finding. Example: Update ...
Optional
description Description string
The description of the finding. Example: There is ...
Required
risk Risk string
The risk associated with the finding. Example: A hacker could ...
Optional
recommendation Recommendation string
The recommendation for the finding. Example: Update ...
Optional
proof Proof string
The proof for the finding. Example: See attached ...
Optional
references References string

The references for the finding. **Example: - https://owasp.org/Top10/A03_2021-Injection/`

  • https://owasp.org/Top10/A07_2021-Identification_and_Authentication_Failures/**
Optional
draftDocuments Draft Documents string[]
Document IDs of uploaded draft documents.
Optional
draftDocumentsFile Draft Document File Paths or URLs string[]
One or more files to upload. For each entry, provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.txt)
Optional
resolvers Resolvers string[]
User IDs of users assigned to resolve the finding.
Optional Dynamic
userGroups User Groups string[]
The user groups for the finding
Optional Dynamic
classifications Classifications string[]
An array with classifications by classification system. You can use any combination of CWE, CAPEC or VRT classifications. Note that classifications are ignored if their system is not set in the assessment.
Optional
SMScoringSystem Severity Metrics Scoring System string
The scoring system you want to use. See the documentation for further information.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
security_reporter-create-finding
Version
0.1.1
App
Security Reporter
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes