SecurityApi class

Constructors

SecurityApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getSecurityFindings({String? scanId, String? minSeverity, int? limit}) → Future<FindingList?>
Is the org's findings — rule, severity, path, line, masked preview and fingerprint — newest first, across scans or within one.
getSecurityFindingsById(String id) → Future<FindingView?>
Returns a single finding: which rule fired, where (path and line), the masked preview and the SHA-256 fingerprint of the secret — the raw secret is not stored and cannot be read back.
getSecurityFindingsByIdWithHttpInfo(String id) → Future<Response>
Returns a single finding: which rule fired, where (path and line), the masked preview and the SHA-256 fingerprint of the secret — the raw secret is not stored and cannot be read back.
getSecurityFindingsWithHttpInfo({String? scanId, String? minSeverity, int? limit}) → Future<Response>
Is the org's findings — rule, severity, path, line, masked preview and fingerprint — newest first, across scans or within one.
getSecurityHealth() → Future<Ruleset?>
Reports that the scanning subsystem is serving and how many secret-detection rules the engine holds.
getSecurityHealthWithHttpInfo() → Future<Response>
Reports that the scanning subsystem is serving and how many secret-detection rules the engine holds.
getSecurityRules() → Future<RuleList?>
Is the secret-detection catalog the engine scans with.
getSecurityRulesWithHttpInfo() → Future<Response>
Is the secret-detection catalog the engine scans with.
getSecurityScans({int? limit}) → Future<ScanList?>
Is the org's scan history, newest first, each as the same summary the submission answered — files read, findings fired, tally by severity.
getSecurityScansById(String id) → Future<ScanDetail?>
Returns one scan together with every finding on it, so the detail view is one round-trip rather than a list call per scan.
getSecurityScansByIdWithHttpInfo(String id) → Future<Response>
Returns one scan together with every finding on it, so the detail view is one round-trip rather than a list call per scan.
getSecurityScansWithHttpInfo({int? limit}) → Future<Response>
Is the org's scan history, newest first, each as the same summary the submission answered — files read, findings fired, tally by severity.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
postSecurityScans(SubmitReq submitReq) → Future<ScanView?>
Runs the detection engine over a batch of files and answers 201 with the scan summary: how many files were read, how many findings fired, and the tally by severity.
postSecurityScansWithHttpInfo(SubmitReq submitReq) → Future<Response>
Runs the detection engine over a batch of files and answers 201 with the scan summary: how many files were read, how many findings fired, and the tally by severity.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited