Files
sdk/api_security.go

883 lines
30 KiB
Go

/*
Hanzo Cloud API
The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
API version: v1
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package hanzoai
import (
"bytes"
"context"
"io"
"net/http"
"net/url"
"strings"
)
// SecurityAPIService SecurityAPI service
type SecurityAPIService service
type SecurityAPIGetSecurityFindingsRequest struct {
ctx context.Context
ApiService *SecurityAPIService
scanId *string
minSeverity *string
limit *int64
}
// ScanID narrows to a single scan.
func (r SecurityAPIGetSecurityFindingsRequest) ScanId(scanId string) SecurityAPIGetSecurityFindingsRequest {
r.scanId = &scanId
return r
}
// MinSeverity drops everything below that rank: critical, high, medium or low. A value outside that set is refused rather than quietly ignored, so a filter typo cannot read as \"no findings\".
func (r SecurityAPIGetSecurityFindingsRequest) MinSeverity(minSeverity string) SecurityAPIGetSecurityFindingsRequest {
r.minSeverity = &minSeverity
return r
}
// Limit caps the page.
func (r SecurityAPIGetSecurityFindingsRequest) Limit(limit int64) SecurityAPIGetSecurityFindingsRequest {
r.limit = &limit
return r
}
func (r SecurityAPIGetSecurityFindingsRequest) Execute() (*SecurityFindingList, *http.Response, error) {
return r.ApiService.GetSecurityFindingsExecute(r)
}
/*
GetSecurityFindings Is the org's findings — rule, severity, path, line, masked preview and fingerprint — newest first, across scans or within one.
Is the org's findings — rule, severity, path, line, masked preview
and fingerprint — newest first, across scans or within one.
A minSeverity outside critical|high|medium|low is refused rather than quietly
ignored, so a filter typo cannot read as "no findings". Strictly org-scoped, and
a caller with no validated org is refused.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return SecurityAPIGetSecurityFindingsRequest
*/
func (a *SecurityAPIService) GetSecurityFindings(ctx context.Context) SecurityAPIGetSecurityFindingsRequest {
return SecurityAPIGetSecurityFindingsRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return SecurityFindingList
func (a *SecurityAPIService) GetSecurityFindingsExecute(r SecurityAPIGetSecurityFindingsRequest) (*SecurityFindingList, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *SecurityFindingList
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "SecurityAPIService.GetSecurityFindings")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/security/findings"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.scanId != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "scanId", r.scanId, "form", "")
}
if r.minSeverity != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "minSeverity", r.minSeverity, "form", "")
}
if r.limit != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "limit", r.limit, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type SecurityAPIGetSecurityFindingsByIdRequest struct {
ctx context.Context
ApiService *SecurityAPIService
id string
}
func (r SecurityAPIGetSecurityFindingsByIdRequest) Execute() (*SecurityFindingView, *http.Response, error) {
return r.ApiService.GetSecurityFindingsByIdExecute(r)
}
/*
GetSecurityFindingsById 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.
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.
Scoped to the caller's org, and a finding belonging to another org is the same
404 as one that never existed.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id ID is the finding the URL names.
@return SecurityAPIGetSecurityFindingsByIdRequest
*/
func (a *SecurityAPIService) GetSecurityFindingsById(ctx context.Context, id string) SecurityAPIGetSecurityFindingsByIdRequest {
return SecurityAPIGetSecurityFindingsByIdRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return SecurityFindingView
func (a *SecurityAPIService) GetSecurityFindingsByIdExecute(r SecurityAPIGetSecurityFindingsByIdRequest) (*SecurityFindingView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *SecurityFindingView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "SecurityAPIService.GetSecurityFindingsById")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/security/findings/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type SecurityAPIGetSecurityHealthRequest struct {
ctx context.Context
ApiService *SecurityAPIService
}
func (r SecurityAPIGetSecurityHealthRequest) Execute() (*SecurityRuleset, *http.Response, error) {
return r.ApiService.GetSecurityHealthExecute(r)
}
/*
GetSecurityHealth Reports that the scanning subsystem is serving and how many secret-detection rules the engine holds.
Reports that the scanning subsystem is serving and how many
secret-detection rules the engine holds.
It has no external dependency — the answer is ok whenever the findings store
opened — so it measures this process rather than anything downstream. It reads
no tenant: a prober that sends no principal is answered, not refused.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return SecurityAPIGetSecurityHealthRequest
*/
func (a *SecurityAPIService) GetSecurityHealth(ctx context.Context) SecurityAPIGetSecurityHealthRequest {
return SecurityAPIGetSecurityHealthRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return SecurityRuleset
func (a *SecurityAPIService) GetSecurityHealthExecute(r SecurityAPIGetSecurityHealthRequest) (*SecurityRuleset, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *SecurityRuleset
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "SecurityAPIService.GetSecurityHealth")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/security/health"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type SecurityAPIGetSecurityRulesRequest struct {
ctx context.Context
ApiService *SecurityAPIService
}
func (r SecurityAPIGetSecurityRulesRequest) Execute() (*SecurityRuleList, *http.Response, error) {
return r.ApiService.GetSecurityRulesExecute(r)
}
/*
GetSecurityRules Is the secret-detection catalog the engine scans with.
Is the secret-detection catalog the engine scans with.
It returns every rule a scan can fire — the id, name and severity a finding
cites — so a caller can render or triage results without hard-coding the
catalog. It is the same for everyone and discloses nothing tenant-specific, so
it carries no org scope.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return SecurityAPIGetSecurityRulesRequest
*/
func (a *SecurityAPIService) GetSecurityRules(ctx context.Context) SecurityAPIGetSecurityRulesRequest {
return SecurityAPIGetSecurityRulesRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return SecurityRuleList
func (a *SecurityAPIService) GetSecurityRulesExecute(r SecurityAPIGetSecurityRulesRequest) (*SecurityRuleList, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *SecurityRuleList
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "SecurityAPIService.GetSecurityRules")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/security/rules"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type SecurityAPIGetSecurityScansRequest struct {
ctx context.Context
ApiService *SecurityAPIService
limit *int64
}
// Limit caps the page.
func (r SecurityAPIGetSecurityScansRequest) Limit(limit int64) SecurityAPIGetSecurityScansRequest {
r.limit = &limit
return r
}
func (r SecurityAPIGetSecurityScansRequest) Execute() (*SecurityScanList, *http.Response, error) {
return r.ApiService.GetSecurityScansExecute(r)
}
/*
GetSecurityScans Is the org's scan history, newest first, each as the same summary the submission answered — files read, findings fired, tally by severity.
Is the org's scan history, newest first, each as the same summary the
submission answered — files read, findings fired, tally by severity.
Strictly org-scoped: a caller only ever sees its own scans, and one with no
validated org is refused.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return SecurityAPIGetSecurityScansRequest
*/
func (a *SecurityAPIService) GetSecurityScans(ctx context.Context) SecurityAPIGetSecurityScansRequest {
return SecurityAPIGetSecurityScansRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return SecurityScanList
func (a *SecurityAPIService) GetSecurityScansExecute(r SecurityAPIGetSecurityScansRequest) (*SecurityScanList, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *SecurityScanList
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "SecurityAPIService.GetSecurityScans")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/security/scans"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.limit != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "limit", r.limit, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type SecurityAPIGetSecurityScansByIdRequest struct {
ctx context.Context
ApiService *SecurityAPIService
id string
}
func (r SecurityAPIGetSecurityScansByIdRequest) Execute() (*SecurityScanDetail, *http.Response, error) {
return r.ApiService.GetSecurityScansByIdExecute(r)
}
/*
GetSecurityScansById Returns one scan together with every finding on it, so the detail view is one round-trip rather than a list call per scan.
Returns one scan together with every finding on it, so the detail view
is one round-trip rather than a list call per scan. The findings carry masked
previews and fingerprints, never secrets.
Scoped to the caller's org: a scan id belonging to another org is the same 404
as an id that never existed, so a ruleset learns nothing about what exists
elsewhere. No validated org is refused.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id ID is the scan the URL names.
@return SecurityAPIGetSecurityScansByIdRequest
*/
func (a *SecurityAPIService) GetSecurityScansById(ctx context.Context, id string) SecurityAPIGetSecurityScansByIdRequest {
return SecurityAPIGetSecurityScansByIdRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return SecurityScanDetail
func (a *SecurityAPIService) GetSecurityScansByIdExecute(r SecurityAPIGetSecurityScansByIdRequest) (*SecurityScanDetail, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *SecurityScanDetail
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "SecurityAPIService.GetSecurityScansById")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/security/scans/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type SecurityAPIPostSecurityScansRequest struct {
ctx context.Context
ApiService *SecurityAPIService
securitySubmitReq *SecuritySubmitReq
}
func (r SecurityAPIPostSecurityScansRequest) SecuritySubmitReq(securitySubmitReq SecuritySubmitReq) SecurityAPIPostSecurityScansRequest {
r.securitySubmitReq = &securitySubmitReq
return r
}
func (r SecurityAPIPostSecurityScansRequest) Execute() (*SecurityScanView, *http.Response, error) {
return r.ApiService.PostSecurityScansExecute(r)
}
/*
PostSecurityScans 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.
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.
THE SUBMITTED CONTENT IS NEVER STORED. It is scanned in memory; what persists is
the finding — its rule, its path and line, a MASKED preview (first and last
characters kept, the middle starred) and the SHA-256 fingerprint of the raw
secret. The fingerprint is what makes the same secret recognisable across scans
and after rotation without the secret ever being written down.
It requires a validated org, which scopes the stored scan and every finding on
it; a caller with no org is refused. Bounded at 500 files and 8 MiB of total
content per submission — split a larger tree across scans. One scan is one
metered unit, and the scan is recorded in the audit log with its tally, never
with its findings.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return SecurityAPIPostSecurityScansRequest
*/
func (a *SecurityAPIService) PostSecurityScans(ctx context.Context) SecurityAPIPostSecurityScansRequest {
return SecurityAPIPostSecurityScansRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return SecurityScanView
func (a *SecurityAPIService) PostSecurityScansExecute(r SecurityAPIPostSecurityScansRequest) (*SecurityScanView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *SecurityScanView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "SecurityAPIService.PostSecurityScans")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/security/scans"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.securitySubmitReq == nil {
return localVarReturnValue, nil, reportError("securitySubmitReq is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.securitySubmitReq
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}