package
1.3.51
Repository: https://github.com/adevinta/vulcan-api.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
No description provided by the author
ValidAssetType indicates if the asset type name exists in Vulcan.

# Constants

Assets discovered by the Common Platform.
Assets discovered by Redcon.
DiscoveredAssetsGroupSuffix is used by the Merge Discovered Assets feature to restrict the discovery onboarding to Groups with a name containing that suffix.
JobStatusDone defines the status of a done Job.
JobStatusPending defines the status of a pending Job.
JobStatusRunning defines the status of a running Job.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
ErrInvalidProgramGroupPolicy is returned when any of the groups of policies in a program does not have.
ErrNoProgramsGroupsPolicies is returned when there are any policy group with, at least, one asset and checktype.
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AssetMergeOperations defines a set of operations to perform when merging a list of assets requested by a discovery service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CreateTarget specifies the payload for the vulnerability DB create target endpoint.
Finding represents the response data returned from the vulnerability DB for the get finding request.
No description provided by the author
No description provided by the author
No description provided by the author
FindingsIssuesList represents the response data returned from the vulnerability DB for the issues summary request.
FindingsLabels represents the response data returned from the vulnerability DB for the list labels request.
FindingsList represents the response data returned from the vulnerability DB for a findings requests.
FindingsParams represents the group of parameters that can be used to customize the call to retrieve the list of findings.
FindingsTargetsList represents the response data returned from the vulnerability DB for the targets summary request.
FindingTicketCreate represents the data needed to create a ticket.
FindingTicketCreateResponse represents a response when request a ticket creation.
GlobalProgramsMetadata defines the shape of the metadata stored per team for a given global program.
GlobalStatsParams represents the group of parameters that can be used to customize the call to retrieve the global statistics.
No description provided by the author
No description provided by the author
Healthcheck ....
HealthcheckResponse ...
IssuesList representes the response data returned from the vulnerability DB for an issues requests.
Job contains the status information of an asynchronous operation.
JobResponse represents the data for a Job that is returned as a response to Job queries through the API.
JobResult represents the result of a job.
No description provided by the author
JobsRunner is a dependency used by the CDC parser to execute async API jobs, providing a limited access to the API service layer.
No description provided by the author
Pagination represents the pagination data requested.
PaginationInfo represents the pagination data provided for each vulnerability DB response.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ProgramsGroupsPolicies defines the association between a group and a policy in a program.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ROLFP stores the vector containing the dimensions we use to classify the impact of an asset.
No description provided by the author
No description provided by the author
No description provided by the author
StatsAssets represents the stats for assets grouped by severity.
No description provided by the author
StatsCurrentExposure represents the current exposure time stats by different averages.
StatsExposure represents the exposure time stats by different averages.
StatsFixed represents the stats for fixed issues grouped by severity.
StatsMTTR represents the mean time to remediation stats by issue severity.
StatsOpen represents the stats for open issues grouped by severity.
StatsParams represents the group of parameters that can be used to customize the call to retrieve the statistics.
No description provided by the author
Target represents the response data returned from the vulnerability DB for the create target request.
TargetsList represents the response data returned from the vulnerability DB for the targets list request.
TargetsParams represents the group of parameters that can be used to customize the call to retrieve the list of targets.
No description provided by the author
No description provided by the author
No description provided by the author
Ticket represents the response data returned from the vulcan tracker service for the get ticket request.
Token represents a personal API token.
UpdateFinding represents the payload submitted to update a finding.
User ...
No description provided by the author
UserTeam ...

# Interfaces

AuthService defines the exposed functions of an authorization service.
JobsClient defines the API service layer methods exposd by the JobsRunner.
UserStore contains methods to manage teams in data store.
VulcanitoService represents all operations provided by Vulcanito.
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author