Documentation
¶
Overview ¶
Package generated provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Index ¶
- Constants
- func NewExemptionsApproveExemptionRequest(server string, id string, action ExemptionsApproveExemptionParamsAction, ...) (*http.Request, error)
- func NewExemptionsApproveExemptionRequestWithBody(server string, id string, action ExemptionsApproveExemptionParamsAction, ...) (*http.Request, error)
- func NewExemptionsFindExemptionByIdRequest(server string, id string, params *ExemptionsFindExemptionByIdParams) (*http.Request, error)
- func NewExemptionsPromoteExemptionRequest(server string, id string, params *ExemptionsPromoteExemptionParams, ...) (*http.Request, error)
- func NewExemptionsPromoteExemptionRequestWithBody(server string, id string, params *ExemptionsPromoteExemptionParams, ...) (*http.Request, error)
- func NewFrontendAllIssuesFiltersRequest(server string, params *FrontendAllIssuesFiltersParams) (*http.Request, error)
- func NewFrontendAllIssuesListRequest(server string, params *FrontendAllIssuesListParams) (*http.Request, error)
- func NewFrontendGlobalExemptionsRequest(server string, params *FrontendGlobalExemptionsParams, ...) (*http.Request, error)
- func NewFrontendGlobalExemptionsRequestWithBody(server string, params *FrontendGlobalExemptionsParams, contentType string, ...) (*http.Request, error)
- type AllIssueSummary
- type AllIssueSummarySeverityCode
- type AllIssueSummaryStatus
- type AllIssuesFiltersResult
- type AllIssuesListResult
- type ApproveExemptionRequestBody
- type Client
- func (c *Client) ExemptionsApproveExemption(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, ...) (*http.Response, error)
- func (c *Client) ExemptionsApproveExemptionWithBody(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, ...) (*http.Response, error)
- func (c *Client) ExemptionsFindExemptionById(ctx context.Context, id string, params *ExemptionsFindExemptionByIdParams, ...) (*http.Response, error)
- func (c *Client) ExemptionsPromoteExemption(ctx context.Context, id string, params *ExemptionsPromoteExemptionParams, ...) (*http.Response, error)
- func (c *Client) ExemptionsPromoteExemptionWithBody(ctx context.Context, id string, params *ExemptionsPromoteExemptionParams, ...) (*http.Response, error)
- func (c *Client) FrontendAllIssuesFilters(ctx context.Context, params *FrontendAllIssuesFiltersParams, ...) (*http.Response, error)
- func (c *Client) FrontendAllIssuesList(ctx context.Context, params *FrontendAllIssuesListParams, ...) (*http.Response, error)
- func (c *Client) FrontendGlobalExemptions(ctx context.Context, params *FrontendGlobalExemptionsParams, ...) (*http.Response, error)
- func (c *Client) FrontendGlobalExemptionsWithBody(ctx context.Context, params *FrontendGlobalExemptionsParams, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) ExemptionsApproveExemptionWithBodyWithResponse(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, ...) (*ExemptionsApproveExemptionResponse, error)
- func (c *ClientWithResponses) ExemptionsApproveExemptionWithResponse(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, ...) (*ExemptionsApproveExemptionResponse, error)
- func (c *ClientWithResponses) ExemptionsFindExemptionByIdWithResponse(ctx context.Context, id string, params *ExemptionsFindExemptionByIdParams, ...) (*ExemptionsFindExemptionByIdResponse, error)
- func (c *ClientWithResponses) ExemptionsPromoteExemptionWithBodyWithResponse(ctx context.Context, id string, params *ExemptionsPromoteExemptionParams, ...) (*ExemptionsPromoteExemptionResponse, error)
- func (c *ClientWithResponses) ExemptionsPromoteExemptionWithResponse(ctx context.Context, id string, params *ExemptionsPromoteExemptionParams, ...) (*ExemptionsPromoteExemptionResponse, error)
- func (c *ClientWithResponses) FrontendAllIssuesFiltersWithResponse(ctx context.Context, params *FrontendAllIssuesFiltersParams, ...) (*FrontendAllIssuesFiltersResponse, error)
- func (c *ClientWithResponses) FrontendAllIssuesListWithResponse(ctx context.Context, params *FrontendAllIssuesListParams, ...) (*FrontendAllIssuesListResponse, error)
- func (c *ClientWithResponses) FrontendGlobalExemptionsWithBodyWithResponse(ctx context.Context, params *FrontendGlobalExemptionsParams, ...) (*FrontendGlobalExemptionsResponse, error)
- func (c *ClientWithResponses) FrontendGlobalExemptionsWithResponse(ctx context.Context, params *FrontendGlobalExemptionsParams, ...) (*FrontendGlobalExemptionsResponse, error)
- type ClientWithResponsesInterface
- type Exemption
- type ExemptionCanApproveFor
- type ExemptionExemptionStatusAtScan
- type ExemptionScope
- type ExemptionStatus
- type ExemptionType
- type ExemptionsApproveExemptionJSONRequestBody
- type ExemptionsApproveExemptionParams
- type ExemptionsApproveExemptionParamsAction
- type ExemptionsApproveExemptionResponse
- type ExemptionsFindExemptionByIdParams
- type ExemptionsFindExemptionByIdResponse
- type ExemptionsPromoteExemptionJSONRequestBody
- type ExemptionsPromoteExemptionParams
- type ExemptionsPromoteExemptionResponse
- type FrontendAllIssuesFiltersParams
- type FrontendAllIssuesFiltersResponse
- type FrontendAllIssuesFiltersResponseBody
- type FrontendAllIssuesListParams
- type FrontendAllIssuesListResponse
- type FrontendAllIssuesListResponseBody
- type FrontendExemption
- type FrontendExemptionCanApproveFor
- type FrontendExemptionCounts
- type FrontendExemptionScope
- type FrontendGlobalExemptionsJSONRequestBody
- type FrontendGlobalExemptionsParams
- type FrontendGlobalExemptionsParamsStatus
- type FrontendGlobalExemptionsResponse
- type FrontendSecurityReviewResponseBody
- type GlobalExemptionsRequestBody
- type HttpRequestDoer
- type IssueSummary
- type IssueSummaryCurrentStatus
- type IssueSummaryExemptionStatusAtScan
- type IssueSummarySeverityCode
- type IssueSummaryStatus
- type IssueSummaryType
- type LatestBaselineScanInfo
- type LatestBaselineScanInfoTargetType
- type NotFound
- type OverrideResult
- type Pagination
- type PendingChanges
- type PromoteExemptionRequestBody
- type RequestEditorFn
- type SecurityReviewResult
Constants ¶
const ( X_Api_Key_header_X_Api_KeyScopes = "X_Api_Key_header_X_Api_Key.Scopes" Jwt_header_AuthorizationScopes = "jwt_header_Authorization.Scopes" )
Variables ¶
This section is empty.
Functions ¶
func NewExemptionsApproveExemptionRequest ¶
func NewExemptionsApproveExemptionRequest(server string, id string, action ExemptionsApproveExemptionParamsAction, params *ExemptionsApproveExemptionParams, body ExemptionsApproveExemptionJSONRequestBody) (*http.Request, error)
NewExemptionsApproveExemptionRequest calls the generic ExemptionsApproveExemption builder with application/json body
func NewExemptionsApproveExemptionRequestWithBody ¶
func NewExemptionsApproveExemptionRequestWithBody(server string, id string, action ExemptionsApproveExemptionParamsAction, params *ExemptionsApproveExemptionParams, contentType string, body io.Reader) (*http.Request, error)
NewExemptionsApproveExemptionRequestWithBody generates requests for ExemptionsApproveExemption with any type of body
func NewExemptionsFindExemptionByIdRequest ¶
func NewExemptionsFindExemptionByIdRequest(server string, id string, params *ExemptionsFindExemptionByIdParams) (*http.Request, error)
NewExemptionsFindExemptionByIdRequest generates requests for ExemptionsFindExemptionById
func NewExemptionsPromoteExemptionRequest ¶
func NewExemptionsPromoteExemptionRequest(server string, id string, params *ExemptionsPromoteExemptionParams, body ExemptionsPromoteExemptionJSONRequestBody) (*http.Request, error)
NewExemptionsPromoteExemptionRequest calls the generic ExemptionsPromoteExemption builder with application/json body
func NewExemptionsPromoteExemptionRequestWithBody ¶
func NewExemptionsPromoteExemptionRequestWithBody(server string, id string, params *ExemptionsPromoteExemptionParams, contentType string, body io.Reader) (*http.Request, error)
NewExemptionsPromoteExemptionRequestWithBody generates requests for ExemptionsPromoteExemption with any type of body
func NewFrontendAllIssuesFiltersRequest ¶
func NewFrontendAllIssuesFiltersRequest(server string, params *FrontendAllIssuesFiltersParams) (*http.Request, error)
NewFrontendAllIssuesFiltersRequest generates requests for FrontendAllIssuesFilters
func NewFrontendAllIssuesListRequest ¶
func NewFrontendAllIssuesListRequest(server string, params *FrontendAllIssuesListParams) (*http.Request, error)
NewFrontendAllIssuesListRequest generates requests for FrontendAllIssuesList
func NewFrontendGlobalExemptionsRequest ¶
func NewFrontendGlobalExemptionsRequest(server string, params *FrontendGlobalExemptionsParams, body FrontendGlobalExemptionsJSONRequestBody) (*http.Request, error)
NewFrontendGlobalExemptionsRequest calls the generic FrontendGlobalExemptions builder with application/json body
func NewFrontendGlobalExemptionsRequestWithBody ¶
func NewFrontendGlobalExemptionsRequestWithBody(server string, params *FrontendGlobalExemptionsParams, contentType string, body io.Reader) (*http.Request, error)
NewFrontendGlobalExemptionsRequestWithBody generates requests for FrontendGlobalExemptions with any type of body
Types ¶
type AllIssueSummary ¶
type AllIssueSummary struct {
// ExemptionExpiration Unix timestamp at which this Exemption will expire
ExemptionExpiration *int64 `json:"exemptionExpiration,omitempty"`
// ExemptionId ID of Security Test Exemption
ExemptionId *string `json:"exemptionId,omitempty"`
// ExemptionStatus Status of project scoped exemption for this issue
ExemptionStatus *string `json:"exemptionStatus,omitempty"`
// Id Resource identifier
Id string `json:"id"`
// IssueType Issue Type
IssueType *string `json:"issueType,omitempty"`
// LastDetected Timestamp of the last detection of this issue
LastDetected int64 `json:"lastDetected"`
// NumOccurrences Number of occurrences of this issue against the latest baseline scan
NumOccurrences float32 `json:"numOccurrences"`
// NumTargetsImpacted Number of targets impacted where this issue was found against the latest baseline scan
NumTargetsImpacted float32 `json:"numTargetsImpacted"`
// Overrides List of issue overrides
Overrides *[]OverrideResult `json:"overrides,omitempty"`
// SeverityCode Severity code
SeverityCode AllIssueSummarySeverityCode `json:"severityCode"`
// Status Issue Status
Status *AllIssueSummaryStatus `json:"status,omitempty"`
// Title Title of the Security Issue
Title string `json:"title"`
}
AllIssueSummary All issue list summary
type AllIssueSummarySeverityCode ¶
type AllIssueSummarySeverityCode string
AllIssueSummarySeverityCode Severity code
const ( AllIssueSummarySeverityCodeCritical AllIssueSummarySeverityCode = "Critical" AllIssueSummarySeverityCodeHigh AllIssueSummarySeverityCode = "High" AllIssueSummarySeverityCodeInfo AllIssueSummarySeverityCode = "Info" AllIssueSummarySeverityCodeLow AllIssueSummarySeverityCode = "Low" AllIssueSummarySeverityCodeMedium AllIssueSummarySeverityCode = "Medium" AllIssueSummarySeverityCodeUnassigned AllIssueSummarySeverityCode = "Unassigned" )
Defines values for AllIssueSummarySeverityCode.
type AllIssueSummaryStatus ¶
type AllIssueSummaryStatus string
AllIssueSummaryStatus Issue Status
const ( AllIssueSummaryStatusActive AllIssueSummaryStatus = "Active" AllIssueSummaryStatusExempted AllIssueSummaryStatus = "Exempted" )
Defines values for AllIssueSummaryStatus.
type AllIssuesFiltersResult ¶
type AllIssuesFiltersResult struct {
LatestBaselineScans []LatestBaselineScanInfo `json:"latestBaselineScans"`
}
AllIssuesFiltersResult defines model for AllIssuesFiltersResult.
type AllIssuesListResult ¶
type AllIssuesListResult struct {
// Issues Issues related to the latest scans of a baseline in a specific project
Issues []AllIssueSummary `json:"issues"`
Pagination Pagination `json:"pagination"`
}
AllIssuesListResult defines model for AllIssuesListResult.
type ApproveExemptionRequestBody ¶
type ApproveExemptionRequestBody struct {
// ApproverId User ID the user who approved or rejected this exemptions
ApproverId string `json:"approverId"`
// Comment Comment to be added to the Exemption approval or rejection
Comment *string `json:"comment,omitempty"`
}
ApproveExemptionRequestBody defines model for ApproveExemptionRequestBody.
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) ExemptionsApproveExemption ¶
func (c *Client) ExemptionsApproveExemption(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, params *ExemptionsApproveExemptionParams, body ExemptionsApproveExemptionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ExemptionsApproveExemptionWithBody ¶
func (c *Client) ExemptionsApproveExemptionWithBody(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, params *ExemptionsApproveExemptionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ExemptionsFindExemptionById ¶
func (c *Client) ExemptionsFindExemptionById(ctx context.Context, id string, params *ExemptionsFindExemptionByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ExemptionsPromoteExemption ¶
func (c *Client) ExemptionsPromoteExemption(ctx context.Context, id string, params *ExemptionsPromoteExemptionParams, body ExemptionsPromoteExemptionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ExemptionsPromoteExemptionWithBody ¶
func (*Client) FrontendAllIssuesFilters ¶
func (c *Client) FrontendAllIssuesFilters(ctx context.Context, params *FrontendAllIssuesFiltersParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) FrontendAllIssuesList ¶
func (c *Client) FrontendAllIssuesList(ctx context.Context, params *FrontendAllIssuesListParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) FrontendGlobalExemptions ¶
func (c *Client) FrontendGlobalExemptions(ctx context.Context, params *FrontendGlobalExemptionsParams, body FrontendGlobalExemptionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) FrontendGlobalExemptionsWithBody ¶
type ClientInterface ¶
type ClientInterface interface {
// ExemptionsFindExemptionById request
ExemptionsFindExemptionById(ctx context.Context, id string, params *ExemptionsFindExemptionByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// ExemptionsPromoteExemptionWithBody request with any body
ExemptionsPromoteExemptionWithBody(ctx context.Context, id string, params *ExemptionsPromoteExemptionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ExemptionsPromoteExemption(ctx context.Context, id string, params *ExemptionsPromoteExemptionParams, body ExemptionsPromoteExemptionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ExemptionsApproveExemptionWithBody request with any body
ExemptionsApproveExemptionWithBody(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, params *ExemptionsApproveExemptionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ExemptionsApproveExemption(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, params *ExemptionsApproveExemptionParams, body ExemptionsApproveExemptionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// FrontendAllIssuesFilters request
FrontendAllIssuesFilters(ctx context.Context, params *FrontendAllIssuesFiltersParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// FrontendAllIssuesList request
FrontendAllIssuesList(ctx context.Context, params *FrontendAllIssuesListParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// FrontendGlobalExemptionsWithBody request with any body
FrontendGlobalExemptionsWithBody(ctx context.Context, params *FrontendGlobalExemptionsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
FrontendGlobalExemptions(ctx context.Context, params *FrontendGlobalExemptionsParams, body FrontendGlobalExemptionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) ExemptionsApproveExemptionWithBodyWithResponse ¶
func (c *ClientWithResponses) ExemptionsApproveExemptionWithBodyWithResponse(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, params *ExemptionsApproveExemptionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExemptionsApproveExemptionResponse, error)
ExemptionsApproveExemptionWithBodyWithResponse request with arbitrary body returning *ExemptionsApproveExemptionResponse
func (*ClientWithResponses) ExemptionsApproveExemptionWithResponse ¶
func (c *ClientWithResponses) ExemptionsApproveExemptionWithResponse(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, params *ExemptionsApproveExemptionParams, body ExemptionsApproveExemptionJSONRequestBody, reqEditors ...RequestEditorFn) (*ExemptionsApproveExemptionResponse, error)
func (*ClientWithResponses) ExemptionsFindExemptionByIdWithResponse ¶
func (c *ClientWithResponses) ExemptionsFindExemptionByIdWithResponse(ctx context.Context, id string, params *ExemptionsFindExemptionByIdParams, reqEditors ...RequestEditorFn) (*ExemptionsFindExemptionByIdResponse, error)
ExemptionsFindExemptionByIdWithResponse request returning *ExemptionsFindExemptionByIdResponse
func (*ClientWithResponses) ExemptionsPromoteExemptionWithBodyWithResponse ¶
func (c *ClientWithResponses) ExemptionsPromoteExemptionWithBodyWithResponse(ctx context.Context, id string, params *ExemptionsPromoteExemptionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExemptionsPromoteExemptionResponse, error)
ExemptionsPromoteExemptionWithBodyWithResponse request with arbitrary body returning *ExemptionsPromoteExemptionResponse
func (*ClientWithResponses) ExemptionsPromoteExemptionWithResponse ¶
func (c *ClientWithResponses) ExemptionsPromoteExemptionWithResponse(ctx context.Context, id string, params *ExemptionsPromoteExemptionParams, body ExemptionsPromoteExemptionJSONRequestBody, reqEditors ...RequestEditorFn) (*ExemptionsPromoteExemptionResponse, error)
func (*ClientWithResponses) FrontendAllIssuesFiltersWithResponse ¶
func (c *ClientWithResponses) FrontendAllIssuesFiltersWithResponse(ctx context.Context, params *FrontendAllIssuesFiltersParams, reqEditors ...RequestEditorFn) (*FrontendAllIssuesFiltersResponse, error)
FrontendAllIssuesFiltersWithResponse request returning *FrontendAllIssuesFiltersResponse
func (*ClientWithResponses) FrontendAllIssuesListWithResponse ¶
func (c *ClientWithResponses) FrontendAllIssuesListWithResponse(ctx context.Context, params *FrontendAllIssuesListParams, reqEditors ...RequestEditorFn) (*FrontendAllIssuesListResponse, error)
FrontendAllIssuesListWithResponse request returning *FrontendAllIssuesListResponse
func (*ClientWithResponses) FrontendGlobalExemptionsWithBodyWithResponse ¶
func (c *ClientWithResponses) FrontendGlobalExemptionsWithBodyWithResponse(ctx context.Context, params *FrontendGlobalExemptionsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*FrontendGlobalExemptionsResponse, error)
FrontendGlobalExemptionsWithBodyWithResponse request with arbitrary body returning *FrontendGlobalExemptionsResponse
func (*ClientWithResponses) FrontendGlobalExemptionsWithResponse ¶
func (c *ClientWithResponses) FrontendGlobalExemptionsWithResponse(ctx context.Context, params *FrontendGlobalExemptionsParams, body FrontendGlobalExemptionsJSONRequestBody, reqEditors ...RequestEditorFn) (*FrontendGlobalExemptionsResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// ExemptionsFindExemptionByIdWithResponse request
ExemptionsFindExemptionByIdWithResponse(ctx context.Context, id string, params *ExemptionsFindExemptionByIdParams, reqEditors ...RequestEditorFn) (*ExemptionsFindExemptionByIdResponse, error)
// ExemptionsPromoteExemptionWithBodyWithResponse request with any body
ExemptionsPromoteExemptionWithBodyWithResponse(ctx context.Context, id string, params *ExemptionsPromoteExemptionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExemptionsPromoteExemptionResponse, error)
ExemptionsPromoteExemptionWithResponse(ctx context.Context, id string, params *ExemptionsPromoteExemptionParams, body ExemptionsPromoteExemptionJSONRequestBody, reqEditors ...RequestEditorFn) (*ExemptionsPromoteExemptionResponse, error)
// ExemptionsApproveExemptionWithBodyWithResponse request with any body
ExemptionsApproveExemptionWithBodyWithResponse(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, params *ExemptionsApproveExemptionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExemptionsApproveExemptionResponse, error)
ExemptionsApproveExemptionWithResponse(ctx context.Context, id string, action ExemptionsApproveExemptionParamsAction, params *ExemptionsApproveExemptionParams, body ExemptionsApproveExemptionJSONRequestBody, reqEditors ...RequestEditorFn) (*ExemptionsApproveExemptionResponse, error)
// FrontendAllIssuesFiltersWithResponse request
FrontendAllIssuesFiltersWithResponse(ctx context.Context, params *FrontendAllIssuesFiltersParams, reqEditors ...RequestEditorFn) (*FrontendAllIssuesFiltersResponse, error)
// FrontendAllIssuesListWithResponse request
FrontendAllIssuesListWithResponse(ctx context.Context, params *FrontendAllIssuesListParams, reqEditors ...RequestEditorFn) (*FrontendAllIssuesListResponse, error)
// FrontendGlobalExemptionsWithBodyWithResponse request with any body
FrontendGlobalExemptionsWithBodyWithResponse(ctx context.Context, params *FrontendGlobalExemptionsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*FrontendGlobalExemptionsResponse, error)
FrontendGlobalExemptionsWithResponse(ctx context.Context, params *FrontendGlobalExemptionsParams, body FrontendGlobalExemptionsJSONRequestBody, reqEditors ...RequestEditorFn) (*FrontendGlobalExemptionsResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type Exemption ¶
type Exemption struct {
// ApproverEmail Email of the user who approved this Exemption
ApproverEmail *string `json:"approverEmail,omitempty"`
// ApproverId User ID the user who approved or rejected this exemptions
ApproverId *string `json:"approverId,omitempty"`
// ApproverName Name of the user who approved this Exemption
ApproverName *string `json:"approverName,omitempty"`
// CanApproveFor Consists of RBAC scopes for an user associated with this Exemption
CanApproveFor *[]ExemptionCanApproveFor `json:"canApproveFor,omitempty"`
// CanCancel States if the user can cancel the exemption
CanCancel *bool `json:"canCancel,omitempty"`
// CanCreate States whether the user can create or reopen the exemption
CanCreate *bool `json:"canCreate,omitempty"`
// CanReApprove States if the user can re-approve the exemption for the exemption's scope
CanReApprove *bool `json:"canReApprove,omitempty"`
// CanReject States whether the user can reject the exemption
CanReject *bool `json:"canReject,omitempty"`
// Comment The additional comment to include with the exemption
Comment *string `json:"comment,omitempty"`
// Created Unix timestamp at which the resource was created
Created int64 `json:"created"`
// ExemptionStatusAtScan Exemption's status at the Security Scan created time
ExemptionStatusAtScan *ExemptionExemptionStatusAtScan `json:"exemptionStatusAtScan,omitempty"`
// Expiration Unix timestamp at which this Exemption will expire
Expiration *int64 `json:"expiration,omitempty"`
// Id Resource identifier
Id string `json:"id"`
// IsDeleted States if the exemption is deleted
IsDeleted *bool `json:"isDeleted,omitempty"`
// IssueId Issue ID associated with the Exemption
IssueId string `json:"issueId"`
// LastModified Unix timestamp at which the resource was most recently modified
LastModified int64 `json:"lastModified"`
// Link Link to a related ticket
Link *string `json:"link,omitempty"`
// NumOccurrences States how may occurrences are associated with the exemption, if not an issue level exemption
NumOccurrences *int64 `json:"numOccurrences,omitempty"`
// Occurrences Array of occurrence Ids
Occurrences *[]int64 `json:"occurrences,omitempty"`
// OrgId ID of the Harness Organization to which the exemption applies. Cannot be specified alongside "targetId".
OrgId *string `json:"orgId,omitempty"`
// OrgName Name of the organization associated with the exemption
OrgName *string `json:"orgName,omitempty"`
PendingChanges PendingChanges `json:"pendingChanges"`
// PipelineId ID of the Harness Pipeline to which the exemption applies. You must also specify "projectId" and "orgId". Cannot be specified alongside "targetId".
PipelineId *string `json:"pipelineId,omitempty"`
// ProjectId ID of the Harness Project to which the exemption applies. You must also specify "orgId". Cannot be specified alongside "targetId".
ProjectId *string `json:"projectId,omitempty"`
// ProjectName Name of the project associated with the exemption
ProjectName *string `json:"projectName,omitempty"`
// Reason Text describing why this Exemption is necessary
Reason string `json:"reason"`
// RequesterEmail Email of the user who requested this Exemption
RequesterEmail *string `json:"requesterEmail,omitempty"`
// RequesterId User ID of the user who requested this Exemption
RequesterId string `json:"requesterId"`
// RequesterName Name of the user who requested this Exemption
RequesterName *string `json:"requesterName,omitempty"`
// ScanId ID of the Harness Scan to determine all the occurrences for the scan-issue. You must also specify "projectId", "orgId" and "targetId". Cannot be specified alongside "pipelineId".
ScanId *string `json:"scanId,omitempty"`
// Scope States the scope for the exemption
Scope *ExemptionScope `json:"scope,omitempty"`
// Search Search parameter to find filtered occurrences of the issue
Search *string `json:"search,omitempty"`
// Status Approval status of Exemption
Status ExemptionStatus `json:"status"`
// TargetId ID of the Target to which the exemption applies. Cannot be specified alongside "projectId" or "pipelineId".
TargetId *string `json:"targetId,omitempty"`
// Type Type of Exemption (Compensating Controls / Acceptable Use / Acceptable Risk / False Positive / Fix Unavailable / Other)
Type ExemptionType `json:"type"`
}
Exemption Information about an Exemption
type ExemptionCanApproveFor ¶
type ExemptionCanApproveFor string
ExemptionCanApproveFor defines model for Exemption.CanApproveFor.
const ( ExemptionCanApproveForACCOUNT ExemptionCanApproveFor = "ACCOUNT" ExemptionCanApproveForORG ExemptionCanApproveFor = "ORG" ExemptionCanApproveForPIPELINE ExemptionCanApproveFor = "PIPELINE" ExemptionCanApproveForPROJECT ExemptionCanApproveFor = "PROJECT" ExemptionCanApproveForTARGET ExemptionCanApproveFor = "TARGET" )
Defines values for ExemptionCanApproveFor.
type ExemptionExemptionStatusAtScan ¶
type ExemptionExemptionStatusAtScan string
ExemptionExemptionStatusAtScan Exemption's status at the Security Scan created time
const ( ExemptionExemptionStatusAtScanApproved ExemptionExemptionStatusAtScan = "Approved" ExemptionExemptionStatusAtScanExpired ExemptionExemptionStatusAtScan = "Expired" ExemptionExemptionStatusAtScanPending ExemptionExemptionStatusAtScan = "Pending" ExemptionExemptionStatusAtScanRejected ExemptionExemptionStatusAtScan = "Rejected" )
Defines values for ExemptionExemptionStatusAtScan.
type ExemptionScope ¶
type ExemptionScope string
ExemptionScope States the scope for the exemption
const ( ExemptionScopeACCOUNT ExemptionScope = "ACCOUNT" ExemptionScopeORG ExemptionScope = "ORG" ExemptionScopePIPELINE ExemptionScope = "PIPELINE" ExemptionScopePROJECT ExemptionScope = "PROJECT" ExemptionScopeTARGET ExemptionScope = "TARGET" )
Defines values for ExemptionScope.
type ExemptionStatus ¶
type ExemptionStatus string
ExemptionStatus Approval status of Exemption
const ( ExemptionStatusApproved ExemptionStatus = "Approved" ExemptionStatusCanceled ExemptionStatus = "Canceled" ExemptionStatusExpired ExemptionStatus = "Expired" ExemptionStatusPending ExemptionStatus = "Pending" ExemptionStatusRejected ExemptionStatus = "Rejected" )
Defines values for ExemptionStatus.
type ExemptionType ¶
type ExemptionType string
ExemptionType Type of Exemption (Compensating Controls / Acceptable Use / Acceptable Risk / False Positive / Fix Unavailable / Other)
const ( AcceptableRisk ExemptionType = "Acceptable Risk" AcceptableUse ExemptionType = "Acceptable Use" CompensatingControls ExemptionType = "Compensating Controls" FalsePositive ExemptionType = "False Positive" Other ExemptionType = "Other" )
Defines values for ExemptionType.
type ExemptionsApproveExemptionJSONRequestBody ¶
type ExemptionsApproveExemptionJSONRequestBody = ApproveExemptionRequestBody
ExemptionsApproveExemptionJSONRequestBody defines body for ExemptionsApproveExemption for application/json ContentType.
type ExemptionsApproveExemptionParams ¶
type ExemptionsApproveExemptionParams struct {
// AccountId Harness Account ID
AccountId string `form:"accountId" json:"accountId"`
// OrgId Harness Organization ID
OrgId *string `form:"orgId,omitempty" json:"orgId,omitempty"`
// ProjectId Harness Project ID
ProjectId *string `form:"projectId,omitempty" json:"projectId,omitempty"`
// XApiKey Harness personal or service access token
XApiKey *string `json:"X-Api-Key,omitempty"`
}
ExemptionsApproveExemptionParams defines parameters for ExemptionsApproveExemption.
type ExemptionsApproveExemptionParamsAction ¶
type ExemptionsApproveExemptionParamsAction string
ExemptionsApproveExemptionParamsAction defines parameters for ExemptionsApproveExemption.
const ( Approve ExemptionsApproveExemptionParamsAction = "approve" Reject ExemptionsApproveExemptionParamsAction = "reject" )
Defines values for ExemptionsApproveExemptionParamsAction.
type ExemptionsApproveExemptionResponse ¶
type ExemptionsApproveExemptionResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Exemption
JSON400 *NotFound
JSON401 *NotFound
JSON403 *NotFound
JSON404 *NotFound
JSON429 *NotFound
JSON500 *NotFound
}
func ParseExemptionsApproveExemptionResponse ¶
func ParseExemptionsApproveExemptionResponse(rsp *http.Response) (*ExemptionsApproveExemptionResponse, error)
ParseExemptionsApproveExemptionResponse parses an HTTP response from a ExemptionsApproveExemptionWithResponse call
func (ExemptionsApproveExemptionResponse) Status ¶
func (r ExemptionsApproveExemptionResponse) Status() string
Status returns HTTPResponse.Status
func (ExemptionsApproveExemptionResponse) StatusCode ¶
func (r ExemptionsApproveExemptionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ExemptionsFindExemptionByIdParams ¶
type ExemptionsFindExemptionByIdParams struct {
// AccountId Harness Account ID
AccountId string `form:"accountId" json:"accountId"`
// OrgId Harness Organization ID
OrgId *string `form:"orgId,omitempty" json:"orgId,omitempty"`
// ProjectId Harness Project ID
ProjectId *string `form:"projectId,omitempty" json:"projectId,omitempty"`
// ExecutionId Harness Execution ID
ExecutionId *string `form:"executionId,omitempty" json:"executionId,omitempty"`
// IgnoreScope Ignore scope
IgnoreScope *bool `form:"ignoreScope,omitempty" json:"ignoreScope,omitempty"`
// XApiKey Harness personal or service access token
XApiKey *string `json:"X-Api-Key,omitempty"`
}
ExemptionsFindExemptionByIdParams defines parameters for ExemptionsFindExemptionById.
type ExemptionsFindExemptionByIdResponse ¶
type ExemptionsFindExemptionByIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Exemption
JSON400 *NotFound
JSON401 *NotFound
JSON403 *NotFound
JSON404 *NotFound
JSON429 *NotFound
JSON500 *NotFound
}
func ParseExemptionsFindExemptionByIdResponse ¶
func ParseExemptionsFindExemptionByIdResponse(rsp *http.Response) (*ExemptionsFindExemptionByIdResponse, error)
ParseExemptionsFindExemptionByIdResponse parses an HTTP response from a ExemptionsFindExemptionByIdWithResponse call
func (ExemptionsFindExemptionByIdResponse) Status ¶
func (r ExemptionsFindExemptionByIdResponse) Status() string
Status returns HTTPResponse.Status
func (ExemptionsFindExemptionByIdResponse) StatusCode ¶
func (r ExemptionsFindExemptionByIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ExemptionsPromoteExemptionJSONRequestBody ¶
type ExemptionsPromoteExemptionJSONRequestBody = PromoteExemptionRequestBody
ExemptionsPromoteExemptionJSONRequestBody defines body for ExemptionsPromoteExemption for application/json ContentType.
type ExemptionsPromoteExemptionParams ¶
type ExemptionsPromoteExemptionParams struct {
// AccountId Harness Account ID
AccountId string `form:"accountId" json:"accountId"`
// OrgId Harness Organization ID
OrgId *string `form:"orgId,omitempty" json:"orgId,omitempty"`
// ProjectId Harness Project ID
ProjectId *string `form:"projectId,omitempty" json:"projectId,omitempty"`
// XApiKey Harness personal or service access token
XApiKey *string `json:"X-Api-Key,omitempty"`
}
ExemptionsPromoteExemptionParams defines parameters for ExemptionsPromoteExemption.
type ExemptionsPromoteExemptionResponse ¶
type ExemptionsPromoteExemptionResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Exemption
JSON400 *NotFound
JSON401 *NotFound
JSON403 *NotFound
JSON404 *NotFound
JSON429 *NotFound
JSON500 *NotFound
}
func ParseExemptionsPromoteExemptionResponse ¶
func ParseExemptionsPromoteExemptionResponse(rsp *http.Response) (*ExemptionsPromoteExemptionResponse, error)
ParseExemptionsPromoteExemptionResponse parses an HTTP response from a ExemptionsPromoteExemptionWithResponse call
func (ExemptionsPromoteExemptionResponse) Status ¶
func (r ExemptionsPromoteExemptionResponse) Status() string
Status returns HTTPResponse.Status
func (ExemptionsPromoteExemptionResponse) StatusCode ¶
func (r ExemptionsPromoteExemptionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FrontendAllIssuesFiltersParams ¶
type FrontendAllIssuesFiltersParams struct {
// AccountId Harness Account ID
AccountId string `form:"accountId" json:"accountId"`
// OrgId Harness Organization ID
OrgId string `form:"orgId" json:"orgId"`
// ProjectId Harness Project ID
ProjectId string `form:"projectId" json:"projectId"`
}
FrontendAllIssuesFiltersParams defines parameters for FrontendAllIssuesFilters.
type FrontendAllIssuesFiltersResponse ¶
type FrontendAllIssuesFiltersResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FrontendAllIssuesFiltersResponseBody
JSON400 *NotFound
JSON401 *NotFound
JSON403 *NotFound
JSON404 *NotFound
JSON429 *NotFound
JSON500 *NotFound
}
func ParseFrontendAllIssuesFiltersResponse ¶
func ParseFrontendAllIssuesFiltersResponse(rsp *http.Response) (*FrontendAllIssuesFiltersResponse, error)
ParseFrontendAllIssuesFiltersResponse parses an HTTP response from a FrontendAllIssuesFiltersWithResponse call
func (FrontendAllIssuesFiltersResponse) Status ¶
func (r FrontendAllIssuesFiltersResponse) Status() string
Status returns HTTPResponse.Status
func (FrontendAllIssuesFiltersResponse) StatusCode ¶
func (r FrontendAllIssuesFiltersResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FrontendAllIssuesFiltersResponseBody ¶
type FrontendAllIssuesFiltersResponseBody = AllIssuesFiltersResult
FrontendAllIssuesFiltersResponseBody defines model for FrontendAllIssuesFiltersResponseBody.
type FrontendAllIssuesListParams ¶
type FrontendAllIssuesListParams struct {
// AccountId Harness Account ID
AccountId string `form:"accountId" json:"accountId"`
// OrgId Harness Organization ID
OrgId string `form:"orgId" json:"orgId"`
// ProjectId Harness Project ID
ProjectId string `form:"projectId" json:"projectId"`
// Page Page number to fetch (starting from 0)
Page *int64 `form:"page,omitempty" json:"page,omitempty"`
// PageSize Number of results per page
PageSize *int64 `form:"pageSize,omitempty" json:"pageSize,omitempty"`
TargetIds *string `form:"targetIds,omitempty" json:"targetIds,omitempty"`
TargetTypes *string `form:"targetTypes,omitempty" json:"targetTypes,omitempty"`
PipelineIds *string `form:"pipelineIds,omitempty" json:"pipelineIds,omitempty"`
ScanTools *string `form:"scanTools,omitempty" json:"scanTools,omitempty"`
SeverityCodes *string `form:"severityCodes,omitempty" json:"severityCodes,omitempty"`
ExemptionStatuses *string `form:"exemptionStatuses,omitempty" json:"exemptionStatuses,omitempty"`
// SeverityOverriden Filter issues by whether their severity has been overridden. Use 'Yes,No' for all issues.
SeverityOverriden *string `form:"severityOverriden,omitempty" json:"severityOverriden,omitempty"`
Search *string `form:"search,omitempty" json:"search,omitempty"`
IssueTypes *string `form:"issueTypes,omitempty" json:"issueTypes,omitempty"`
Statuses *string `form:"statuses,omitempty" json:"statuses,omitempty"`
}
FrontendAllIssuesListParams defines parameters for FrontendAllIssuesList.
type FrontendAllIssuesListResponse ¶
type FrontendAllIssuesListResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FrontendAllIssuesListResponseBody
JSON400 *NotFound
JSON401 *NotFound
JSON403 *NotFound
JSON404 *NotFound
JSON429 *NotFound
JSON500 *NotFound
}
func ParseFrontendAllIssuesListResponse ¶
func ParseFrontendAllIssuesListResponse(rsp *http.Response) (*FrontendAllIssuesListResponse, error)
ParseFrontendAllIssuesListResponse parses an HTTP response from a FrontendAllIssuesListWithResponse call
func (FrontendAllIssuesListResponse) Status ¶
func (r FrontendAllIssuesListResponse) Status() string
Status returns HTTPResponse.Status
func (FrontendAllIssuesListResponse) StatusCode ¶
func (r FrontendAllIssuesListResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FrontendAllIssuesListResponseBody ¶
type FrontendAllIssuesListResponseBody = AllIssuesListResult
FrontendAllIssuesListResponseBody defines model for FrontendAllIssuesListResponseBody.
type FrontendExemption ¶
type FrontendExemption struct {
// ApproverEmail Email of the user who approved this Exemption
ApproverEmail *string `json:"approverEmail,omitempty"`
// ApproverId User ID of the user who approved this Exemption
ApproverId *string `json:"approverId,omitempty"`
// ApproverName Name of the user who approved this Exemption
ApproverName *string `json:"approverName,omitempty"`
// CanApproveFor Scopes that the user has permission to approve for this Exemption
CanApproveFor *[]FrontendExemptionCanApproveFor `json:"canApproveFor,omitempty"`
// CanCancel States if the user can cancel the exemption
CanCancel *bool `json:"canCancel,omitempty"`
// CanCreate States if the user can create or reopen the exemption
CanCreate *bool `json:"canCreate,omitempty"`
// CanReApprove States if the user can re-approve the exemption for the exemption's scope
CanReApprove *bool `json:"canReApprove,omitempty"`
// CanReject States if the user can reject the exemption
CanReject *bool `json:"canReject,omitempty"`
// Created Unix timestamp at which the resource was created
Created int64 `json:"created"`
// Expiration Unix timestamp at which this Exemption will expire
Expiration *int64 `json:"expiration,omitempty"`
// Id Resource identifier
Id string `json:"id"`
// IsDeleted States if the exemption is deleted
IsDeleted *bool `json:"isDeleted,omitempty"`
// IsOccurrenceLevelExemption States if the exemption is an occurrence level exemption
IsOccurrenceLevelExemption *bool `json:"isOccurrenceLevelExemption,omitempty"`
// IssueSummary Short summary of an Issue
IssueSummary IssueSummary `json:"issueSummary"`
// LastModified Unix timestamp at which the resource was most recently modified
LastModified int64 `json:"lastModified"`
// Link Link related to this Exemption
Link *string `json:"link,omitempty"`
// NumOccurrences States how may occurrences are associated with the exemption, if not an issue level exemption
NumOccurrences *int64 `json:"numOccurrences,omitempty"`
// OrgId ID of the Harness Org to which this Exemption applies
OrgId *string `json:"orgId,omitempty"`
// OrgName Name of the Harness Org to which this Exemption applies
OrgName *string `json:"orgName,omitempty"`
PendingChanges PendingChanges `json:"pendingChanges"`
// PipelineId ID of the Harness pipeline to which this Exemption applies
PipelineId *string `json:"pipelineId,omitempty"`
// ProjectId ID of the Harness project to which this Exemption applies
ProjectId *string `json:"projectId,omitempty"`
// ProjectName Name of the Harness project
ProjectName *string `json:"projectName,omitempty"`
// Reason Reason for Exemption
Reason string `json:"reason"`
// RequesterEmail Email of the user who requested this Exemption
RequesterEmail *string `json:"requesterEmail,omitempty"`
// RequesterId User ID of the user who requested this Exemption
RequesterId string `json:"requesterId"`
// RequesterName Name of the user who requested this Exemption
RequesterName *string `json:"requesterName,omitempty"`
// Scope The scope of the exemption
Scope *FrontendExemptionScope `json:"scope,omitempty"`
// Status Status of this Exemption
Status string `json:"status"`
// TargetId ID of Target to which this Exemption applies
TargetId *string `json:"targetId,omitempty"`
// TotalOccurrences States total occurrences associated with the issue exemption
TotalOccurrences *int64 `json:"totalOccurrences,omitempty"`
// Type Type of Exemption
Type string `json:"type"`
}
FrontendExemption Exemption summary for frontend use
type FrontendExemptionCanApproveFor ¶
type FrontendExemptionCanApproveFor string
FrontendExemptionCanApproveFor defines model for FrontendExemption.CanApproveFor.
const ( FrontendExemptionCanApproveForACCOUNT FrontendExemptionCanApproveFor = "ACCOUNT" FrontendExemptionCanApproveForORG FrontendExemptionCanApproveFor = "ORG" FrontendExemptionCanApproveForPIPELINE FrontendExemptionCanApproveFor = "PIPELINE" FrontendExemptionCanApproveForPROJECT FrontendExemptionCanApproveFor = "PROJECT" FrontendExemptionCanApproveForTARGET FrontendExemptionCanApproveFor = "TARGET" )
Defines values for FrontendExemptionCanApproveFor.
type FrontendExemptionCounts ¶
type FrontendExemptionCounts struct {
// Approved The count of approved Exemptions
Approved *int32 `json:"Approved,omitempty"`
// Expired The count of expired Exemptions
Expired *int32 `json:"Expired,omitempty"`
// Pending The count of pending Exemptions
Pending *int32 `json:"Pending,omitempty"`
// Rejected The count of rejected Exemptions
Rejected *int32 `json:"Rejected,omitempty"`
}
FrontendExemptionCounts defines model for FrontendExemptionCounts.
type FrontendExemptionScope ¶
type FrontendExemptionScope string
FrontendExemptionScope The scope of the exemption
const ( FrontendExemptionScopeACCOUNT FrontendExemptionScope = "ACCOUNT" FrontendExemptionScopeORG FrontendExemptionScope = "ORG" FrontendExemptionScopePIPELINE FrontendExemptionScope = "PIPELINE" FrontendExemptionScopePROJECT FrontendExemptionScope = "PROJECT" FrontendExemptionScopeTARGET FrontendExemptionScope = "TARGET" )
Defines values for FrontendExemptionScope.
type FrontendGlobalExemptionsJSONRequestBody ¶
type FrontendGlobalExemptionsJSONRequestBody = GlobalExemptionsRequestBody
FrontendGlobalExemptionsJSONRequestBody defines body for FrontendGlobalExemptions for application/json ContentType.
type FrontendGlobalExemptionsParams ¶
type FrontendGlobalExemptionsParams struct {
// AccountId Harness Account ID
AccountId string `form:"accountId" json:"accountId"`
// OrgId Harness Organization ID
OrgId *string `form:"orgId,omitempty" json:"orgId,omitempty"`
// ProjectId Harness Project ID
ProjectId *string `form:"projectId,omitempty" json:"projectId,omitempty"`
// Page Page number to fetch (starting from 0)
Page *int64 `form:"page,omitempty" json:"page,omitempty"`
// PageSize Number of results per page
PageSize *int64 `form:"pageSize,omitempty" json:"pageSize,omitempty"`
// Status Exemption status
Status FrontendGlobalExemptionsParamsStatus `form:"status" json:"status"`
Search *string `form:"search,omitempty" json:"search,omitempty"`
// XApiKey Harness personal or service access token
XApiKey *string `json:"X-Api-Key,omitempty"`
}
FrontendGlobalExemptionsParams defines parameters for FrontendGlobalExemptions.
type FrontendGlobalExemptionsParamsStatus ¶
type FrontendGlobalExemptionsParamsStatus string
FrontendGlobalExemptionsParamsStatus defines parameters for FrontendGlobalExemptions.
const ( Approved FrontendGlobalExemptionsParamsStatus = "Approved" Canceled FrontendGlobalExemptionsParamsStatus = "Canceled" Expired FrontendGlobalExemptionsParamsStatus = "Expired" Pending FrontendGlobalExemptionsParamsStatus = "Pending" Rejected FrontendGlobalExemptionsParamsStatus = "Rejected" )
Defines values for FrontendGlobalExemptionsParamsStatus.
type FrontendGlobalExemptionsResponse ¶
type FrontendGlobalExemptionsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FrontendSecurityReviewResponseBody
JSON400 *NotFound
JSON401 *NotFound
JSON403 *NotFound
JSON429 *NotFound
JSON500 *NotFound
}
func ParseFrontendGlobalExemptionsResponse ¶
func ParseFrontendGlobalExemptionsResponse(rsp *http.Response) (*FrontendGlobalExemptionsResponse, error)
ParseFrontendGlobalExemptionsResponse parses an HTTP response from a FrontendGlobalExemptionsWithResponse call
func (FrontendGlobalExemptionsResponse) Status ¶
func (r FrontendGlobalExemptionsResponse) Status() string
Status returns HTTPResponse.Status
func (FrontendGlobalExemptionsResponse) StatusCode ¶
func (r FrontendGlobalExemptionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FrontendSecurityReviewResponseBody ¶
type FrontendSecurityReviewResponseBody = SecurityReviewResult
FrontendSecurityReviewResponseBody Data needed by the Security Review page
type GlobalExemptionsRequestBody ¶
type GlobalExemptionsRequestBody struct {
// OrgProjectFilter List of organization:project pairs
OrgProjectFilter *[]string `json:"orgProjectFilter,omitempty"`
}
GlobalExemptionsRequestBody defines model for GlobalExemptionsRequestBody.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type IssueSummary ¶
type IssueSummary struct {
// CurrentStatus Current status of the Exemption
CurrentStatus *IssueSummaryCurrentStatus `json:"currentStatus,omitempty"`
// EpssLastModified Last date the issue EPSS data was last modified
EpssLastModified *string `json:"epssLastModified,omitempty"`
// EpssPercentile EPSS percentile of the issue CVE identifier
EpssPercentile *float64 `json:"epssPercentile,omitempty"`
// EpssScore EPSS score of the issue CVE identifier
EpssScore *float64 `json:"epssScore,omitempty"`
// ExemptionCoverage Indicates if the Security Issue was found to be Exempted, Partially Exempted.
ExemptionCoverage *string `json:"exemptionCoverage,omitempty"`
// ExemptionId ID of Security Test Exemption
ExemptionId *string `json:"exemptionId,omitempty"`
// ExemptionStatusAtScan Exemption's status at the Security Scan created time
ExemptionStatusAtScan *IssueSummaryExemptionStatusAtScan `json:"exemptionStatusAtScan,omitempty"`
// Id Resource identifier
Id string `json:"id"`
// Key Compression/deduplication key
Key string `json:"key"`
NumNewOccurrences *int64 `json:"numNewOccurrences,omitempty"`
NumOccurrences *int64 `json:"numOccurrences,omitempty"`
NumRemediatedOccurrences *int64 `json:"numRemediatedOccurrences,omitempty"`
// OriginStatus The status of the origin, either 'approved' or 'unapproved'
OriginStatus *string `json:"originStatus,omitempty"`
// Origins The origin of the issue, either 'app' or 'base'
Origins *[]string `json:"origins,omitempty"`
// Overrides List of issue overrides
Overrides *[]OverrideResult `json:"overrides,omitempty"`
// OverridesAtScan List of issue overrides at scan time
OverridesAtScan *[]OverrideResult `json:"overridesAtScan,omitempty"`
// ScanId The ID of the Scan that detected this Security Issue
ScanId string `json:"scanId"`
// Severity Numeric severity, from 0 (lowest) to 10 (highest)
Severity float32 `json:"severity"`
// SeverityCode Severity code
SeverityCode IssueSummarySeverityCode `json:"severityCode"`
// Status Indicates if the Security Issue was found to be remediated, ignored, etc.
Status *IssueSummaryStatus `json:"status,omitempty"`
// TargetVariantName Name of the associated Target and Variant
TargetVariantName *string `json:"targetVariantName,omitempty"`
// Title Title of the Security Issue
Title string `json:"title"`
// Type The type of vulnerability or quality issue for this Issue
Type *IssueSummaryType `json:"type,omitempty"`
}
IssueSummary Short summary of an Issue
type IssueSummaryCurrentStatus ¶
type IssueSummaryCurrentStatus string
IssueSummaryCurrentStatus Current status of the Exemption
const ( IssueSummaryCurrentStatusApproved IssueSummaryCurrentStatus = "Approved" IssueSummaryCurrentStatusExpired IssueSummaryCurrentStatus = "Expired" IssueSummaryCurrentStatusPending IssueSummaryCurrentStatus = "Pending" IssueSummaryCurrentStatusRejected IssueSummaryCurrentStatus = "Rejected" )
Defines values for IssueSummaryCurrentStatus.
type IssueSummaryExemptionStatusAtScan ¶
type IssueSummaryExemptionStatusAtScan string
IssueSummaryExemptionStatusAtScan Exemption's status at the Security Scan created time
const ( IssueSummaryExemptionStatusAtScanApproved IssueSummaryExemptionStatusAtScan = "Approved" IssueSummaryExemptionStatusAtScanExpired IssueSummaryExemptionStatusAtScan = "Expired" IssueSummaryExemptionStatusAtScanPending IssueSummaryExemptionStatusAtScan = "Pending" IssueSummaryExemptionStatusAtScanRejected IssueSummaryExemptionStatusAtScan = "Rejected" )
Defines values for IssueSummaryExemptionStatusAtScan.
type IssueSummarySeverityCode ¶
type IssueSummarySeverityCode string
IssueSummarySeverityCode Severity code
const ( IssueSummarySeverityCodeCritical IssueSummarySeverityCode = "Critical" IssueSummarySeverityCodeHigh IssueSummarySeverityCode = "High" IssueSummarySeverityCodeInfo IssueSummarySeverityCode = "Info" IssueSummarySeverityCodeLow IssueSummarySeverityCode = "Low" IssueSummarySeverityCodeMedium IssueSummarySeverityCode = "Medium" IssueSummarySeverityCodeUnassigned IssueSummarySeverityCode = "Unassigned" )
Defines values for IssueSummarySeverityCode.
type IssueSummaryStatus ¶
type IssueSummaryStatus string
IssueSummaryStatus Indicates if the Security Issue was found to be remediated, ignored, etc.
const ( IssueSummaryStatusAcceptableRisk IssueSummaryStatus = "Acceptable Risk" IssueSummaryStatusAcceptableUse IssueSummaryStatus = "Acceptable Use" IssueSummaryStatusCompensatingControls IssueSummaryStatus = "Compensating Controls" IssueSummaryStatusExempted IssueSummaryStatus = "Exempted" IssueSummaryStatusFalsePositive IssueSummaryStatus = "False Positive" IssueSummaryStatusRemediated IssueSummaryStatus = "Remediated" )
Defines values for IssueSummaryStatus.
type IssueSummaryType ¶
type IssueSummaryType string
IssueSummaryType The type of vulnerability or quality issue for this Issue
const ( BUGSMELLS IssueSummaryType = "BUG_SMELLS" CODECOVERAGE IssueSummaryType = "CODE_COVERAGE" CODESMELLS IssueSummaryType = "CODE_SMELLS" DAST IssueSummaryType = "DAST" EXTERNALPOLICY IssueSummaryType = "EXTERNAL_POLICY" IAC IssueSummaryType = "IAC" MISCONFIG IssueSummaryType = "MISCONFIG" SAST IssueSummaryType = "SAST" SCA IssueSummaryType = "SCA" SECRET IssueSummaryType = "SECRET" )
Defines values for IssueSummaryType.
type LatestBaselineScanInfo ¶
type LatestBaselineScanInfo struct {
// PipelineId ID of the Harness pipeline to which this Exemption applies
PipelineId string `json:"pipelineId"`
// ScanTool Product name of the scan tool used in this step
ScanTool string `json:"scanTool"`
// ScanToolName Human readable name of the scan tool used in this step
ScanToolName string `json:"scanToolName"`
// TargetId Associated Target ID
TargetId string `json:"targetId"`
// TargetName The name of the target of the pipeline step's scan
TargetName string `json:"targetName"`
TargetType LatestBaselineScanInfoTargetType `json:"targetType"`
}
LatestBaselineScanInfo Information about a the latest scan of a targets baseline variant
type LatestBaselineScanInfoTargetType ¶
type LatestBaselineScanInfoTargetType string
LatestBaselineScanInfoTargetType defines model for LatestBaselineScanInfo.TargetType.
const ( Configuration LatestBaselineScanInfoTargetType = "configuration" Container LatestBaselineScanInfoTargetType = "container" Instance LatestBaselineScanInfoTargetType = "instance" Repository LatestBaselineScanInfoTargetType = "repository" )
Defines values for LatestBaselineScanInfoTargetType.
type OverrideResult ¶
type OverrideResult struct {
// Created Unix timestamp at which the resource was created
Created int64 `json:"created"`
// FieldName Name of the field that is being overridden
FieldName string `json:"fieldName"`
// ImpactedTargetId ID of the impacted target
ImpactedTargetId *string `json:"impactedTargetId,omitempty"`
// OriginalFieldValue Original value of the field that is being overridden
OriginalFieldValue string `json:"originalFieldValue"`
// OverrideFieldValue Value of the field that is being overridden
OverrideFieldValue string `json:"overrideFieldValue"`
// OverrideId Override Id of the override
OverrideId *string `json:"overrideId,omitempty"`
// Reason Text describing why this override is necessary
Reason string `json:"reason"`
// RequesterEmail Email of the user who requested this Exemption
RequesterEmail *string `json:"requesterEmail,omitempty"`
// RequesterId User ID of the user who requested the override
RequesterId *string `json:"requesterId,omitempty"`
// RequesterName Name of the user who requested this Exemption
RequesterName *string `json:"requesterName,omitempty"`
}
OverrideResult defines model for OverrideResult.
type Pagination ¶
type Pagination struct {
// Link Link-based paging
Link *string `json:"link,omitempty"`
// Page Page number (starting from 0)
Page int64 `json:"page"`
// PageSize Requested page size
PageSize int64 `json:"pageSize"`
// TotalItems Total results available
TotalItems int64 `json:"totalItems"`
// TotalPages Total pages available
TotalPages int64 `json:"totalPages"`
}
Pagination defines model for Pagination.
type PendingChanges ¶
type PendingChanges struct {
// DurationDays The number of days an issue should be exempted for
DurationDays *int64 `json:"durationDays,omitempty"`
}
PendingChanges defines model for PendingChanges.
type PromoteExemptionRequestBody ¶
type PromoteExemptionRequestBody struct {
// ApproverId User ID the user who approved or rejected this exemptions
ApproverId string `json:"approverId"`
// Comment Comment to be added to the Exemption approval or rejection
Comment *string `json:"comment,omitempty"`
// PipelineId Harness STO pipeline ID
PipelineId *string `json:"pipelineId,omitempty"`
// TargetId Harness STO Target ID
TargetId *string `json:"targetId,omitempty"`
}
PromoteExemptionRequestBody defines model for PromoteExemptionRequestBody.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type SecurityReviewResult ¶
type SecurityReviewResult struct {
Counts FrontendExemptionCounts `json:"counts"`
// Exemptions Security Review data
Exemptions []FrontendExemption `json:"exemptions"`
Pagination Pagination `json:"pagination"`
}
SecurityReviewResult Data needed by the Security Review page