Interface SubmitVulnerabilitiesResponse

SubmitVulnerabilitiesResponse

The result of a successful submitVulnerabilities request.

interface SubmitVulnerabilitiesResponse {
    acceptedVulnerabilities?: string[];
    failedVulnerabilities?: {
        [key: string]: unknown[];
    };
    unknownAssociations?: ({
        associationType: "issueIdOrKeys";
        values: string[];
    } & {
        [key: string]: unknown;
    })[];
}

Hierarchy

  • Record<string, unknown>
    • SubmitVulnerabilitiesResponse

Properties

acceptedVulnerabilities? failedVulnerabilities? unknownAssociations?

Properties

OptionalacceptedVulnerabilities

acceptedVulnerabilities?: string[]

The IDs of Vulnerabilities that have been accepted for submission.

A Vulnerability may be rejected if it was only associated with unknown project keys.

Note that a Vulnerability that isn't updated due to it's updateSequenceNumber being out of order is not considered a failed submission.

Example

[
  "111-222-333",
  "444-555-666"
]

OptionalfailedVulnerabilities

failedVulnerabilities?: {
    [key: string]: unknown[];
}

Details of Vulnerabilities that have not been accepted for submission, usually due to a problem with the request data.

The object (if present) will be keyed by Vulnerability ID and include any errors associated with that Vulnerability that have prevented it being submitted.

OptionalunknownAssociations

unknownAssociations?: ({
    associationType: "issueIdOrKeys";
    values: string[];
} & {
    [key: string]: unknown;
})[]

Associations (e.g. Service IDs) that are not known on this Jira instance (if any).

If a Vulnerability has been associated with any other association other than those in this array it will still be stored against those valid associations. If a Vulnerability was only associated with the associations in this array, it is deemed to be invalid and it won't be persisted.

Settings

Member Visibility

On This Page

Properties