client

package
v1.3.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 21, 2023 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AssetsGlobalStatsPath

func AssetsGlobalStatsPath() string

AssetsGlobalStatsPath computes a request path to the assets action of global-stats.

func CoverageStatsPath

func CoverageStatsPath(teamID string) string

CoverageStatsPath computes a request path to the coverage action of stats.

func CreateAPITokenPath

func CreateAPITokenPath(userID string) string

CreateAPITokenPath computes a request path to the create action of api-token.

func CreateAssetAnnotationsPath

func CreateAssetAnnotationsPath(teamID string, assetID string) string

CreateAssetAnnotationsPath computes a request path to the create action of asset-annotations.

func CreateAssetGroupPath

func CreateAssetGroupPath(teamID string, groupID string) string

CreateAssetGroupPath computes a request path to the create action of asset-group.

func CreateAssetsPath

func CreateAssetsPath(teamID string) string

CreateAssetsPath computes a request path to the create action of assets.

func CreateGroupPath

func CreateGroupPath(teamID string) string

CreateGroupPath computes a request path to the create action of group.

func CreateMultiStatusAssetsPath

func CreateMultiStatusAssetsPath(teamID string) string

CreateMultiStatusAssetsPath computes a request path to the createMultiStatus action of assets.

func CreatePoliciesPath

func CreatePoliciesPath(teamID string) string

CreatePoliciesPath computes a request path to the create action of policies.

func CreatePolicySettingsPath

func CreatePolicySettingsPath(teamID string, policyID string) string

CreatePolicySettingsPath computes a request path to the create action of policy-settings.

func CreateProgramsPath

func CreateProgramsPath(teamID string) string

CreateProgramsPath computes a request path to the create action of programs.

func CreateScanPath

func CreateScanPath(teamID string) string

CreateScanPath computes a request path to the create action of scan.

func CreateSchedulePath

func CreateSchedulePath(teamID string, programID string) string

CreateSchedulePath computes a request path to the create action of schedule.

func CreateTeamMembersPath

func CreateTeamMembersPath(teamID string) string

CreateTeamMembersPath computes a request path to the create action of team-members.

func CreateTeamsPath

func CreateTeamsPath() string

CreateTeamsPath computes a request path to the create action of teams.

func CreateUserPath

func CreateUserPath() string

CreateUserPath computes a request path to the create action of user.

func CurrentExposureGlobalStatsPath

func CurrentExposureGlobalStatsPath() string

CurrentExposureGlobalStatsPath computes a request path to the current exposure action of global-stats.

func CurrentExposureStatsPath

func CurrentExposureStatsPath(teamID string) string

CurrentExposureStatsPath computes a request path to the current exposure action of stats.

func DeleteAssetAnnotationsPath

func DeleteAssetAnnotationsPath(teamID string, assetID string) string

DeleteAssetAnnotationsPath computes a request path to the delete action of asset-annotations.

func DeleteAssetGroupPath

func DeleteAssetGroupPath(teamID string, groupID string, assetID string) string

DeleteAssetGroupPath computes a request path to the delete action of asset-group.

func DeleteAssetsPath

func DeleteAssetsPath(teamID string, assetID string) string

DeleteAssetsPath computes a request path to the delete action of assets.

func DeleteGroupPath

func DeleteGroupPath(teamID string, groupID string) string

DeleteGroupPath computes a request path to the delete action of group.

func DeletePoliciesPath

func DeletePoliciesPath(teamID string, policyID string) string

DeletePoliciesPath computes a request path to the delete action of policies.

func DeletePolicySettingsPath

func DeletePolicySettingsPath(teamID string, policyID string, settingsID string) string

DeletePolicySettingsPath computes a request path to the delete action of policy-settings.

func DeleteProgramsPath

func DeleteProgramsPath(teamID string, programID string) string

DeleteProgramsPath computes a request path to the delete action of programs.

func DeleteSchedulePath

func DeleteSchedulePath(teamID string, programID string) string

DeleteSchedulePath computes a request path to the delete action of schedule.

func DeleteTeamMembersPath

func DeleteTeamMembersPath(teamID string, userID string) string

DeleteTeamMembersPath computes a request path to the delete action of team-members.

func DeleteTeamsPath

func DeleteTeamsPath(teamID string) string

DeleteTeamsPath computes a request path to the delete action of teams.

func DeleteUserPath

func DeleteUserPath(userID string) string

DeleteUserPath computes a request path to the delete action of user.

func DiscoverAssetsPath

func DiscoverAssetsPath(teamID string) string

DiscoverAssetsPath computes a request path to the discover action of assets.

func ExposureGlobalStatsPath

func ExposureGlobalStatsPath() string

ExposureGlobalStatsPath computes a request path to the exposure action of global-stats.

func ExposureStatsPath

func ExposureStatsPath(teamID string) string

ExposureStatsPath computes a request path to the exposure action of stats.

func FindFindingFindingsPath

func FindFindingFindingsPath(teamID string, findingID string) string

FindFindingFindingsPath computes a request path to the Find finding action of findings.

func FindFindingsFromAIssueFindingsPath

func FindFindingsFromAIssueFindingsPath(teamID string, issueID string) string

FindFindingsFromAIssueFindingsPath computes a request path to the Find findings from a Issue action of findings.

func FindFindingsFromATargetFindingsPath

func FindFindingsFromATargetFindingsPath(teamID string, targetID string) string

FindFindingsFromATargetFindingsPath computes a request path to the Find findings from a Target action of findings.

func FixedGlobalStatsPath

func FixedGlobalStatsPath() string

FixedGlobalStatsPath computes a request path to the fixed action of global-stats.

func FixedStatsPath

func FixedStatsPath(teamID string) string

FixedStatsPath computes a request path to the fixed action of stats.

func ListAssetAnnotationsPath

func ListAssetAnnotationsPath(teamID string, assetID string) string

ListAssetAnnotationsPath computes a request path to the list action of asset-annotations.

func ListAssetGroupPath

func ListAssetGroupPath(teamID string, groupID string) string

ListAssetGroupPath computes a request path to the list action of asset-group.

func ListAssetsPath

func ListAssetsPath(teamID string) string

ListAssetsPath computes a request path to the list action of assets.

func ListFindingOverwritesFindingsPath

func ListFindingOverwritesFindingsPath(teamID string, findingID string) string

ListFindingOverwritesFindingsPath computes a request path to the List Finding Overwrites action of findings.

func ListFindingsFindingsPath

func ListFindingsFindingsPath(teamID string) string

ListFindingsFindingsPath computes a request path to the list findings action of findings.

func ListFindingsIssuesFindingsPath

func ListFindingsIssuesFindingsPath(teamID string) string

ListFindingsIssuesFindingsPath computes a request path to the list findings issues action of findings.

func ListFindingsLabelsFindingsPath

func ListFindingsLabelsFindingsPath(teamID string) string

ListFindingsLabelsFindingsPath computes a request path to the List findings labels action of findings.

func ListFindingsTargetsFindingsPath

func ListFindingsTargetsFindingsPath(teamID string) string

ListFindingsTargetsFindingsPath computes a request path to the list findings targets action of findings.

func ListGroupPath

func ListGroupPath(teamID string) string

ListGroupPath computes a request path to the list action of group.

func ListPoliciesPath

func ListPoliciesPath(teamID string) string

ListPoliciesPath computes a request path to the list action of policies.

func ListPolicySettingsPath

func ListPolicySettingsPath(teamID string, policyID string) string

ListPolicySettingsPath computes a request path to the list action of policy-settings.

func ListProgramScansPath

func ListProgramScansPath(teamID string, programID string) string

ListProgramScansPath computes a request path to the list action of program-scans.

func ListProgramsPath

func ListProgramsPath(teamID string) string

ListProgramsPath computes a request path to the list action of programs.

func ListRecipientsPath

func ListRecipientsPath(teamID string) string

ListRecipientsPath computes a request path to the list action of recipients.

func ListTeamMembersPath

func ListTeamMembersPath(teamID string) string

ListTeamMembersPath computes a request path to the list action of team-members.

func ListTeamsPath

func ListTeamsPath() string

ListTeamsPath computes a request path to the list action of teams.

func ListTeamsUserPath

func ListTeamsUserPath(userID string) string

ListTeamsUserPath computes a request path to the list-teams action of user.

func ListUserPath

func ListUserPath() string

ListUserPath computes a request path to the list action of user.

func MttrGlobalStatsPath

func MttrGlobalStatsPath() string

MttrGlobalStatsPath computes a request path to the mttr action of global-stats.

func MttrStatsPath

func MttrStatsPath(teamID string) string

MttrStatsPath computes a request path to the mttr action of stats.

func OpenGlobalStatsPath

func OpenGlobalStatsPath() string

OpenGlobalStatsPath computes a request path to the open action of global-stats.

func OpenStatsPath

func OpenStatsPath(teamID string) string

OpenStatsPath computes a request path to the open action of stats.

func ProfileUserPath

func ProfileUserPath() string

ProfileUserPath computes a request path to the profile action of user.

func PutAssetAnnotationsPath

func PutAssetAnnotationsPath(teamID string, assetID string) string

PutAssetAnnotationsPath computes a request path to the put action of asset-annotations.

func SendDigestReportPath

func SendDigestReportPath(teamID string) string

SendDigestReportPath computes a request path to the send digest action of report.

func ShowAssetsPath

func ShowAssetsPath(teamID string, assetID string) string

ShowAssetsPath computes a request path to the show action of assets.

func ShowGroupPath

func ShowGroupPath(teamID string, groupID string) string

ShowGroupPath computes a request path to the show action of group.

func ShowHealthcheckPath

func ShowHealthcheckPath() string

ShowHealthcheckPath computes a request path to the show action of healthcheck.

func ShowJobsPath

func ShowJobsPath(jobID string) string

ShowJobsPath computes a request path to the show action of jobs.

func ShowPoliciesPath

func ShowPoliciesPath(teamID string, policyID string) string

ShowPoliciesPath computes a request path to the show action of policies.

func ShowPolicySettingsPath

func ShowPolicySettingsPath(teamID string, policyID string, settingsID string) string

ShowPolicySettingsPath computes a request path to the show action of policy-settings.

func ShowProgramsPath

func ShowProgramsPath(teamID string, programID string) string

ShowProgramsPath computes a request path to the show action of programs.

func ShowScanPath

func ShowScanPath(teamID string, scanID string) string

ShowScanPath computes a request path to the show action of scan.

func ShowTeamMembersPath

func ShowTeamMembersPath(teamID string, userID string) string

ShowTeamMembersPath computes a request path to the show action of team-members.

func ShowTeamsPath

func ShowTeamsPath(teamID string) string

ShowTeamsPath computes a request path to the show action of teams.

func ShowUserPath

func ShowUserPath(userID string) string

ShowUserPath computes a request path to the show action of user.

func SubmitAFindingOverwriteFindingsPath

func SubmitAFindingOverwriteFindingsPath(teamID string, findingID string) string

SubmitAFindingOverwriteFindingsPath computes a request path to the Submit a Finding Overwrite action of findings.

func SubmitAFindingTicketCreationFindingsPath added in v1.2.9

func SubmitAFindingTicketCreationFindingsPath(teamID string, findingID string) string

SubmitAFindingTicketCreationFindingsPath computes a request path to the Submit a Finding Ticket Creation action of findings.

func UpdateAssetAnnotationsPath

func UpdateAssetAnnotationsPath(teamID string, assetID string) string

UpdateAssetAnnotationsPath computes a request path to the update action of asset-annotations.

func UpdateAssetsPath

func UpdateAssetsPath(teamID string, assetID string) string

UpdateAssetsPath computes a request path to the update action of assets.

func UpdateGroupPath

func UpdateGroupPath(teamID string, groupID string) string

UpdateGroupPath computes a request path to the update action of group.

func UpdatePoliciesPath

func UpdatePoliciesPath(teamID string, policyID string) string

UpdatePoliciesPath computes a request path to the update action of policies.

func UpdatePolicySettingsPath

func UpdatePolicySettingsPath(teamID string, policyID string, settingsID string) string

UpdatePolicySettingsPath computes a request path to the update action of policy-settings.

func UpdateProgramsPath

func UpdateProgramsPath(teamID string, programID string) string

UpdateProgramsPath computes a request path to the update action of programs.

func UpdateRecipientsPath

func UpdateRecipientsPath(teamID string) string

UpdateRecipientsPath computes a request path to the update action of recipients.

func UpdateSchedulePath

func UpdateSchedulePath(teamID string, programID string) string

UpdateSchedulePath computes a request path to the update action of schedule.

func UpdateTeamMembersPath

func UpdateTeamMembersPath(teamID string, userID string) string

UpdateTeamMembersPath computes a request path to the update action of team-members.

func UpdateTeamsPath

func UpdateTeamsPath(teamID string) string

UpdateTeamsPath computes a request path to the update action of teams.

func UpdateUserPath

func UpdateUserPath(userID string) string

UpdateUserPath computes a request path to the update action of user.

Types

type Asset

type Asset struct {
	// Alias
	Alias       *string           `form:"alias,omitempty" json:"alias,omitempty" yaml:"alias,omitempty" xml:"alias,omitempty"`
	Annotations map[string]string `form:"annotations,omitempty" json:"annotations,omitempty" yaml:"annotations,omitempty" xml:"annotations,omitempty"`
	// Classified At
	ClassifiedAt *string `form:"classified_at,omitempty" json:"classified_at,omitempty" yaml:"classified_at,omitempty" xml:"classified_at,omitempty"`
	// Environmental CVSS
	EnvironmentalCvss *string `` /* 142-byte string literal not displayed */
	// Asset ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Identifier
	Identifier *string `form:"identifier,omitempty" json:"identifier,omitempty" yaml:"identifier,omitempty" xml:"identifier,omitempty"`
	// Options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
	// Rolfp plus scope vector
	Rolfp *string `form:"rolfp,omitempty" json:"rolfp,omitempty" yaml:"rolfp,omitempty" xml:"rolfp,omitempty"`
	// Scannable
	Scannable *bool `form:"scannable,omitempty" json:"scannable,omitempty" yaml:"scannable,omitempty" xml:"scannable,omitempty"`
	// Type
	Type *Assettype `form:"type,omitempty" json:"type,omitempty" yaml:"type,omitempty" xml:"type,omitempty"`
}

Asset (default view)

Identifier: asset; view=default

type AssetAnnotationDeleteRequest

type AssetAnnotationDeleteRequest struct {
	Annotations []string `form:"annotations,omitempty" json:"annotations,omitempty" yaml:"annotations,omitempty" xml:"annotations,omitempty"`
}

AssetAnnotationDeleteRequest user type.

type AssetAnnotationRequest

type AssetAnnotationRequest struct {
	Annotations map[string]string `form:"annotations,omitempty" json:"annotations,omitempty" yaml:"annotations,omitempty" xml:"annotations,omitempty"`
}

AssetAnnotationRequest user type.

type AssetCollection

type AssetCollection []*Asset

AssetCollection is the media type for an array of Asset (default view)

Identifier: asset; type=collection; view=default

type AssetGroupPayload

type AssetGroupPayload struct {
	// Asset ID
	AssetID string `form:"asset_id" json:"asset_id" yaml:"asset_id" xml:"asset_id"`
}

AssetGroupPayload user type.

func (*AssetGroupPayload) Validate

func (ut *AssetGroupPayload) Validate() (err error)

Validate validates the AssetGroupPayload type instance.

type AssetPayload

type AssetPayload struct {
	// The alias of the asset in Vulcan
	Alias *string `form:"alias,omitempty" json:"alias,omitempty" yaml:"alias,omitempty" xml:"alias,omitempty"`
	// Environmental CVSS
	EnvironmentalCvss *string `` /* 142-byte string literal not displayed */
	// Identifier
	Identifier string `form:"identifier" json:"identifier" yaml:"identifier" xml:"identifier"`
	// Options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
	// Rolfp plus scope vector
	Rolfp *string `form:"rolfp,omitempty" json:"rolfp,omitempty" yaml:"rolfp,omitempty" xml:"rolfp,omitempty"`
	// Scannable
	Scannable *bool `form:"scannable,omitempty" json:"scannable,omitempty" yaml:"scannable,omitempty" xml:"scannable,omitempty"`
	// Type
	Type *string `form:"type,omitempty" json:"type,omitempty" yaml:"type,omitempty" xml:"type,omitempty"`
}

AssetPayload user type.

func (*AssetPayload) Validate

func (ut *AssetPayload) Validate() (err error)

Validate validates the AssetPayload type instance.

type AssetUpdatePayload

type AssetUpdatePayload struct {
	// Alias
	Alias *string `form:"alias,omitempty" json:"alias,omitempty" yaml:"alias,omitempty" xml:"alias,omitempty"`
	// Environmental CVSS
	EnvironmentalCvss *string `` /* 142-byte string literal not displayed */
	// Identifier
	Identifier *string `form:"identifier,omitempty" json:"identifier,omitempty" yaml:"identifier,omitempty" xml:"identifier,omitempty"`
	// Options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
	// Rolfp plus scope vector
	Rolfp *string `form:"rolfp,omitempty" json:"rolfp,omitempty" yaml:"rolfp,omitempty" xml:"rolfp,omitempty"`
	// Scannable
	Scannable *bool `form:"scannable,omitempty" json:"scannable,omitempty" yaml:"scannable,omitempty" xml:"scannable,omitempty"`
	// Type
	Type *string `form:"type,omitempty" json:"type,omitempty" yaml:"type,omitempty" xml:"type,omitempty"`
}

AssetUpdatePayload user type.

type AssetWithAnnotationsPayload

type AssetWithAnnotationsPayload struct {
	// The alias of the asset in Vulcan
	Alias *string `form:"alias,omitempty" json:"alias,omitempty" yaml:"alias,omitempty" xml:"alias,omitempty"`
	// The provided annotations may differ from the ones that
	// will be stored, because they will include a prefix to not mess with any other
	// annotations already present in the asset.
	Annotations map[string]string `form:"annotations,omitempty" json:"annotations,omitempty" yaml:"annotations,omitempty" xml:"annotations,omitempty"`
	// Environmental CVSS
	EnvironmentalCvss *string `` /* 142-byte string literal not displayed */
	// Identifier
	Identifier string `form:"identifier" json:"identifier" yaml:"identifier" xml:"identifier"`
	// Options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
	// Rolfp plus scope vector
	Rolfp *string `form:"rolfp,omitempty" json:"rolfp,omitempty" yaml:"rolfp,omitempty" xml:"rolfp,omitempty"`
	// Scannable
	Scannable *bool `form:"scannable,omitempty" json:"scannable,omitempty" yaml:"scannable,omitempty" xml:"scannable,omitempty"`
	// Type
	Type string `form:"type" json:"type" yaml:"type" xml:"type"`
}

AssetWithAnnotationsPayload user type.

func (*AssetWithAnnotationsPayload) Validate

func (ut *AssetWithAnnotationsPayload) Validate() (err error)

Validate validates the AssetWithAnnotationsPayload type instance.

type AssetannotationsResponse

type AssetannotationsResponse struct {
	Annotations map[string]string `form:"annotations,omitempty" json:"annotations,omitempty" yaml:"annotations,omitempty" xml:"annotations,omitempty"`
}

Asset Annotations (default view)

Identifier: assetannotations_response; view=default

type Asseterror

type Asseterror struct {
	// Error
	Error *string `form:"error,omitempty" json:"error,omitempty" yaml:"error,omitempty" xml:"error,omitempty"`
	// ID
	ID *int `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
}

Create Assets Errors (default view)

Identifier: asseterror; view=default

type AsseterrorCollection

type AsseterrorCollection []*Asseterror

AsseterrorCollection is the media type for an array of Asseterror (default view)

Identifier: asseterror; type=collection; view=default

type Assetgroup

type Assetgroup struct {
	// Asset
	Asset *Asset `form:"asset,omitempty" json:"asset,omitempty" yaml:"asset,omitempty" xml:"asset,omitempty"`
	// Group
	Group *Group `form:"group,omitempty" json:"group,omitempty" yaml:"group,omitempty" xml:"group,omitempty"`
}

Asset group (default view)

Identifier: assetgroup; view=default

type Assetresponse

type Assetresponse struct {
	// Alias
	Alias *string `form:"alias,omitempty" json:"alias,omitempty" yaml:"alias,omitempty" xml:"alias,omitempty"`
	// Classified At
	ClassifiedAt *string `form:"classified_at,omitempty" json:"classified_at,omitempty" yaml:"classified_at,omitempty" xml:"classified_at,omitempty"`
	// Environmental CVSS
	EnvironmentalCvss *string `` /* 142-byte string literal not displayed */
	// Asset ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Identifier
	Identifier *string `form:"identifier,omitempty" json:"identifier,omitempty" yaml:"identifier,omitempty" xml:"identifier,omitempty"`
	// Options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
	// Rolfp plus scope vector
	Rolfp *string `form:"rolfp,omitempty" json:"rolfp,omitempty" yaml:"rolfp,omitempty" xml:"rolfp,omitempty"`
	// Scannable
	Scannable *bool `form:"scannable,omitempty" json:"scannable,omitempty" yaml:"scannable,omitempty" xml:"scannable,omitempty"`
	// Status
	Status *Error `form:"status,omitempty" json:"status,omitempty" yaml:"status,omitempty" xml:"status,omitempty"`
	// Type
	Type *Assettype `form:"type,omitempty" json:"type,omitempty" yaml:"type,omitempty" xml:"type,omitempty"`
}

Asset (default view)

Identifier: assetresponse; view=default

func (*Assetresponse) Validate

func (mt *Assetresponse) Validate() (err error)

Validate validates the Assetresponse media type instance.

type AssetresponseCollection

type AssetresponseCollection []*Assetresponse

AssetresponseCollection is the media type for an array of Assetresponse (default view)

Identifier: assetresponse; type=collection; view=default

func (AssetresponseCollection) Validate

func (mt AssetresponseCollection) Validate() (err error)

Validate validates the AssetresponseCollection media type instance.

type Assettype

type Assettype struct {
	// Asset Type ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
}

Asset Type (default view)

Identifier: assettype; view=default

type Attachment

type Attachment struct {
	// Content Type of the attachment
	ContentType *string `form:"content_type,omitempty" json:"content_type,omitempty" yaml:"content_type,omitempty" xml:"content_type,omitempty"`
	// attachment data
	Data interface{} `form:"data,omitempty" json:"data,omitempty" yaml:"data,omitempty" xml:"data,omitempty"`
	// Attachment name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
}

attachment (default view)

Identifier: attachment; view=default

type Client

type Client struct {
	*goaclient.Client
	BearerSigner goaclient.Signer
	Encoder      *goa.HTTPEncoder
	Decoder      *goa.HTTPDecoder
}

Client is the Vulcan-API service client.

func New

func New(c goaclient.Doer) *Client

New instantiates the client.

func (*Client) AssetsGlobalStats

func (c *Client) AssetsGlobalStats(ctx context.Context, path string, identifiers *string, labels *string, tags *string) (*http.Response, error)

Get global assets per severity statistics.

func (*Client) CoverageStats

func (c *Client) CoverageStats(ctx context.Context, path string) (*http.Response, error)

Get asset coverage for a team.

func (*Client) CreateAPIToken

func (c *Client) CreateAPIToken(ctx context.Context, path string) (*http.Response, error)

Generate an API token for an user.

func (*Client) CreateAssetAnnotations

func (c *Client) CreateAssetAnnotations(ctx context.Context, path string, payload *AssetAnnotationRequest) (*http.Response, error)

Create one or more annotation for a given asset.

func (*Client) CreateAssetGroup

func (c *Client) CreateAssetGroup(ctx context.Context, path string, payload *AssetGroupPayload) (*http.Response, error)

Associate an asset to a group.

func (*Client) CreateAssets

func (c *Client) CreateAssets(ctx context.Context, path string, payload *CreateAssetPayload) (*http.Response, error)

Creates assets in bulk mode. This operation accepts an array of assets, an optional array of group identifiers, an optional map of annotations, and returns an array of successfully created assets. If no groups are specified, assets will be added to the team's Default group. If one of the specified assets already exists for the team but is currently not associated with the requested groups, the association is created. If for any reason, the creation of an asset fails, an error message will be returned referencing the failed asset and the entire operation will be rolled back. --- Valid asset types: - AWSAccount - DomainName - Hostname - IP - IPRange - DockerImage - WebAddress - GitRepository --- If the asset type is informed, then Vulcan will use that value to create the new asset. Otherwise, Vulcan will try to automatically discover the asset type. Notice that this may result in Vulcan creating more than one asset. For instance, an user trying to create an asset for "vulcan.example.com", without specifying the asset type, will end up with two assets created: - vulcan.example.com (DomainName) and - vulcan.example.com (Hostname).

func (*Client) CreateGroup

func (c *Client) CreateGroup(ctx context.Context, path string, payload *GroupPayload) (*http.Response, error)

Create a new group of assets.

func (*Client) CreateMultiStatusAssets

func (c *Client) CreateMultiStatusAssets(ctx context.Context, path string, payload *CreateAssetPayload) (*http.Response, error)

Creates assets in bulk mode (MultiStatus). This operation is similar to the "Create Assets in Bulk Mode", with 2 main differences: - This endpoint is not atomic. Each asset creation request will succeed or fail indenpendently of the other requests. - This endpoint will return an array of AssetResponse in the following way: · For each asset with specified type, returns an AssetResponse indicating the success or failure for its creation. · For each asset with no type specified and successfully created, returns one AssetResponse for each auto detected asset. · For each asset detected from the ones with no type indicated which their creation produced an error, returns one AssetResponse indicating the failure for its creation specifying its detected type. In the case of all assets being successfully created, this endpoint will return status code 201-Created. Otherwise, it will return a 207-MultiStatus code, indicating that at least one of the requested operations failed.

func (*Client) CreatePolicies

func (c *Client) CreatePolicies(ctx context.Context, path string, payload *PolicyPayload) (*http.Response, error)

Create a new policy.

func (*Client) CreatePolicySettings

func (c *Client) CreatePolicySettings(ctx context.Context, path string, payload *PolicySettingPayload) (*http.Response, error)

Create a new policy setting.

func (*Client) CreatePrograms

func (c *Client) CreatePrograms(ctx context.Context, path string, payload *ProgramPayload) (*http.Response, error)

Create a new program.

func (*Client) CreateScan

func (c *Client) CreateScan(ctx context.Context, path string, payload *ScanPayload) (*http.Response, error)

Create scan

func (*Client) CreateSchedule

func (c *Client) CreateSchedule(ctx context.Context, path string, payload *SchedulePayload) (*http.Response, error)

Create a new schedule.

func (*Client) CreateTeamMembers

func (c *Client) CreateTeamMembers(ctx context.Context, path string, payload *TeamMemberPayload) (*http.Response, error)

Create a team-member association. --- At least one of the following fields must be specified: "email", "user_id". Otherwise the operation will fail. If an email is specified, but the user does not exists on the database yet, a new user will be created for that email. --- Valid values for 'role' attribute: - member - owner

func (*Client) CreateTeams

func (c *Client) CreateTeams(ctx context.Context, path string, payload *TeamPayload) (*http.Response, error)

Create a new team.

func (*Client) CreateUser

func (c *Client) CreateUser(ctx context.Context, path string, payload *UserPayload) (*http.Response, error)

Create user

func (*Client) CurrentExposureGlobalStats

func (c *Client) CurrentExposureGlobalStats(ctx context.Context, path string, labels *string, maxScore *float64, minScore *float64, tags *string) (*http.Response, error)

Get global current exposure statistics. This metric takes into account only the exposure for open vulnerabilities since the last time they were detected.

func (*Client) CurrentExposureStats

func (c *Client) CurrentExposureStats(ctx context.Context, path string, maxScore *float64, minScore *float64) (*http.Response, error)

Get current exposure statistics for a team. This metric takes into account only the exposure for open vulnerabilities since the last time they were detected.

func (*Client) DecodeAsset

func (c *Client) DecodeAsset(resp *http.Response) (*Asset, error)

DecodeAsset decodes the Asset instance encoded in resp body.

func (*Client) DecodeAssetCollection

func (c *Client) DecodeAssetCollection(resp *http.Response) (AssetCollection, error)

DecodeAssetCollection decodes the AssetCollection instance encoded in resp body.

func (*Client) DecodeAssetannotationsResponse

func (c *Client) DecodeAssetannotationsResponse(resp *http.Response) (*AssetannotationsResponse, error)

DecodeAssetannotationsResponse decodes the AssetannotationsResponse instance encoded in resp body.

func (*Client) DecodeAsseterror

func (c *Client) DecodeAsseterror(resp *http.Response) (*Asseterror, error)

DecodeAsseterror decodes the Asseterror instance encoded in resp body.

func (*Client) DecodeAsseterrorCollection

func (c *Client) DecodeAsseterrorCollection(resp *http.Response) (AsseterrorCollection, error)

DecodeAsseterrorCollection decodes the AsseterrorCollection instance encoded in resp body.

func (*Client) DecodeAssetgroup

func (c *Client) DecodeAssetgroup(resp *http.Response) (*Assetgroup, error)

DecodeAssetgroup decodes the Assetgroup instance encoded in resp body.

func (*Client) DecodeAssetresponse

func (c *Client) DecodeAssetresponse(resp *http.Response) (*Assetresponse, error)

DecodeAssetresponse decodes the Assetresponse instance encoded in resp body.

func (*Client) DecodeAssetresponseCollection

func (c *Client) DecodeAssetresponseCollection(resp *http.Response) (AssetresponseCollection, error)

DecodeAssetresponseCollection decodes the AssetresponseCollection instance encoded in resp body.

func (*Client) DecodeAssettype

func (c *Client) DecodeAssettype(resp *http.Response) (*Assettype, error)

DecodeAssettype decodes the Assettype instance encoded in resp body.

func (*Client) DecodeAttachment

func (c *Client) DecodeAttachment(resp *http.Response) (*Attachment, error)

DecodeAttachment decodes the Attachment instance encoded in resp body.

func (*Client) DecodeCreateAssets

func (c *Client) DecodeCreateAssets(resp *http.Response) (*CreateAssets, error)

DecodeCreateAssets decodes the CreateAssets instance encoded in resp body.

func (*Client) DecodeCurrentExposure

func (c *Client) DecodeCurrentExposure(resp *http.Response) (*CurrentExposure, error)

DecodeCurrentExposure decodes the CurrentExposure instance encoded in resp body.

func (*Client) DecodeError

func (c *Client) DecodeError(resp *http.Response) (*Error, error)

DecodeError decodes the Error instance encoded in resp body.

func (*Client) DecodeExposure

func (c *Client) DecodeExposure(resp *http.Response) (*Exposure, error)

DecodeExposure decodes the Exposure instance encoded in resp body.

func (*Client) DecodeFinding

func (c *Client) DecodeFinding(resp *http.Response) (*Finding, error)

DecodeFinding decodes the Finding instance encoded in resp body.

func (*Client) DecodeFindingCollection

func (c *Client) DecodeFindingCollection(resp *http.Response) (FindingCollection, error)

DecodeFindingCollection decodes the FindingCollection instance encoded in resp body.

func (*Client) DecodeFindingOverwrite

func (c *Client) DecodeFindingOverwrite(resp *http.Response) (*FindingOverwrite, error)

DecodeFindingOverwrite decodes the FindingOverwrite instance encoded in resp body.

func (*Client) DecodeFindingOverwriteCollection

func (c *Client) DecodeFindingOverwriteCollection(resp *http.Response) (FindingOverwriteCollection, error)

DecodeFindingOverwriteCollection decodes the FindingOverwriteCollection instance encoded in resp body.

func (*Client) DecodeFindingTicket added in v1.2.9

func (c *Client) DecodeFindingTicket(resp *http.Response) (*FindingTicket, error)

DecodeFindingTicket decodes the FindingTicket instance encoded in resp body.

func (*Client) DecodeFindingsIssue

func (c *Client) DecodeFindingsIssue(resp *http.Response) (*FindingsIssue, error)

DecodeFindingsIssue decodes the FindingsIssue instance encoded in resp body.

func (*Client) DecodeFindingsIssueCollection

func (c *Client) DecodeFindingsIssueCollection(resp *http.Response) (FindingsIssueCollection, error)

DecodeFindingsIssueCollection decodes the FindingsIssueCollection instance encoded in resp body.

func (*Client) DecodeFindingsIssuesList

func (c *Client) DecodeFindingsIssuesList(resp *http.Response) (*FindingsIssuesList, error)

DecodeFindingsIssuesList decodes the FindingsIssuesList instance encoded in resp body.

func (*Client) DecodeFindingsLabels

func (c *Client) DecodeFindingsLabels(resp *http.Response) (*FindingsLabels, error)

DecodeFindingsLabels decodes the FindingsLabels instance encoded in resp body.

func (*Client) DecodeFindingsList

func (c *Client) DecodeFindingsList(resp *http.Response) (*FindingsList, error)

DecodeFindingsList decodes the FindingsList instance encoded in resp body.

func (*Client) DecodeFindingsTarget

func (c *Client) DecodeFindingsTarget(resp *http.Response) (*FindingsTarget, error)

DecodeFindingsTarget decodes the FindingsTarget instance encoded in resp body.

func (*Client) DecodeFindingsTargetCollection

func (c *Client) DecodeFindingsTargetCollection(resp *http.Response) (FindingsTargetCollection, error)

DecodeFindingsTargetCollection decodes the FindingsTargetCollection instance encoded in resp body.

func (*Client) DecodeFindingsTargetsList

func (c *Client) DecodeFindingsTargetsList(resp *http.Response) (*FindingsTargetsList, error)

DecodeFindingsTargetsList decodes the FindingsTargetsList instance encoded in resp body.

func (*Client) DecodeGroup

func (c *Client) DecodeGroup(resp *http.Response) (*Group, error)

DecodeGroup decodes the Group instance encoded in resp body.

func (*Client) DecodeGroupCollection

func (c *Client) DecodeGroupCollection(resp *http.Response) (GroupCollection, error)

DecodeGroupCollection decodes the GroupCollection instance encoded in resp body.

func (*Client) DecodeGroupWithoutAssetsCount

func (c *Client) DecodeGroupWithoutAssetsCount(resp *http.Response) (*GroupWithoutAssetsCount, error)

DecodeGroupWithoutAssetsCount decodes the GroupWithoutAssetsCount instance encoded in resp body.

func (*Client) DecodeGroupWithoutAssetsCountCollection

func (c *Client) DecodeGroupWithoutAssetsCountCollection(resp *http.Response) (GroupWithoutAssetsCountCollection, error)

DecodeGroupWithoutAssetsCountCollection decodes the GroupWithoutAssetsCountCollection instance encoded in resp body.

func (*Client) DecodeHealthcheck

func (c *Client) DecodeHealthcheck(resp *http.Response) (*Healthcheck, error)

DecodeHealthcheck decodes the Healthcheck instance encoded in resp body.

func (*Client) DecodeIssue

func (c *Client) DecodeIssue(resp *http.Response) (*Issue, error)

DecodeIssue decodes the Issue instance encoded in resp body.

func (*Client) DecodeJob

func (c *Client) DecodeJob(resp *http.Response) (*Job, error)

DecodeJob decodes the Job instance encoded in resp body.

func (*Client) DecodeListassetentry

func (c *Client) DecodeListassetentry(resp *http.Response) (*Listassetentry, error)

DecodeListassetentry decodes the Listassetentry instance encoded in resp body.

func (*Client) DecodeListassetentryCollection

func (c *Client) DecodeListassetentryCollection(resp *http.Response) (ListassetentryCollection, error)

DecodeListassetentryCollection decodes the ListassetentryCollection instance encoded in resp body.

func (*Client) DecodeListassetgroup

func (c *Client) DecodeListassetgroup(resp *http.Response) (*Listassetgroup, error)

DecodeListassetgroup decodes the Listassetgroup instance encoded in resp body.

func (*Client) DecodeMttr

func (c *Client) DecodeMttr(resp *http.Response) (*Mttr, error)

DecodeMttr decodes the Mttr instance encoded in resp body.

func (*Client) DecodePagination

func (c *Client) DecodePagination(resp *http.Response) (*Pagination, error)

DecodePagination decodes the Pagination instance encoded in resp body.

func (*Client) DecodePolicy

func (c *Client) DecodePolicy(resp *http.Response) (*Policy, error)

DecodePolicy decodes the Policy instance encoded in resp body.

func (*Client) DecodePolicyCollection

func (c *Client) DecodePolicyCollection(resp *http.Response) (PolicyCollection, error)

DecodePolicyCollection decodes the PolicyCollection instance encoded in resp body.

func (*Client) DecodePolicysetting

func (c *Client) DecodePolicysetting(resp *http.Response) (*Policysetting, error)

DecodePolicysetting decodes the Policysetting instance encoded in resp body.

func (*Client) DecodePolicysettingCollection

func (c *Client) DecodePolicysettingCollection(resp *http.Response) (PolicysettingCollection, error)

DecodePolicysettingCollection decodes the PolicysettingCollection instance encoded in resp body.

func (*Client) DecodeProgram

func (c *Client) DecodeProgram(resp *http.Response) (*Program, error)

DecodeProgram decodes the Program instance encoded in resp body.

func (*Client) DecodeProgramCollection

func (c *Client) DecodeProgramCollection(resp *http.Response) (ProgramCollection, error)

DecodeProgramCollection decodes the ProgramCollection instance encoded in resp body.

func (*Client) DecodeProgramPolicyGroup

func (c *Client) DecodeProgramPolicyGroup(resp *http.Response) (*ProgramPolicyGroup, error)

DecodeProgramPolicyGroup decodes the ProgramPolicyGroup instance encoded in resp body.

func (*Client) DecodeRecipient

func (c *Client) DecodeRecipient(resp *http.Response) (*Recipient, error)

DecodeRecipient decodes the Recipient instance encoded in resp body.

func (*Client) DecodeRecipientCollection

func (c *Client) DecodeRecipientCollection(resp *http.Response) (RecipientCollection, error)

DecodeRecipientCollection decodes the RecipientCollection instance encoded in resp body.

func (*Client) DecodeResource

func (c *Client) DecodeResource(resp *http.Response) (*Resource, error)

DecodeResource decodes the Resource instance encoded in resp body.

func (*Client) DecodeScan

func (c *Client) DecodeScan(resp *http.Response) (*Scan, error)

DecodeScan decodes the Scan instance encoded in resp body.

func (*Client) DecodeScanCollection

func (c *Client) DecodeScanCollection(resp *http.Response) (ScanCollection, error)

DecodeScanCollection decodes the ScanCollection instance encoded in resp body.

func (*Client) DecodeSchedule

func (c *Client) DecodeSchedule(resp *http.Response) (*Schedule, error)

DecodeSchedule decodes the Schedule instance encoded in resp body.

func (*Client) DecodeSource

func (c *Client) DecodeSource(resp *http.Response) (*Source, error)

DecodeSource decodes the Source instance encoded in resp body.

func (*Client) DecodeStats

func (c *Client) DecodeStats(resp *http.Response) (*Stats, error)

DecodeStats decodes the Stats instance encoded in resp body.

func (*Client) DecodeStatsassets

func (c *Client) DecodeStatsassets(resp *http.Response) (*Statsassets, error)

DecodeStatsassets decodes the Statsassets instance encoded in resp body.

func (*Client) DecodeStatsaverages

func (c *Client) DecodeStatsaverages(resp *http.Response) (*Statsaverages, error)

DecodeStatsaverages decodes the Statsaverages instance encoded in resp body.

func (*Client) DecodeStatscoverage

func (c *Client) DecodeStatscoverage(resp *http.Response) (*Statscoverage, error)

DecodeStatscoverage decodes the Statscoverage instance encoded in resp body.

func (*Client) DecodeStatsfixed

func (c *Client) DecodeStatsfixed(resp *http.Response) (*Statsfixed, error)

DecodeStatsfixed decodes the Statsfixed instance encoded in resp body.

func (*Client) DecodeStatsopen

func (c *Client) DecodeStatsopen(resp *http.Response) (*Statsopen, error)

DecodeStatsopen decodes the Statsopen instance encoded in resp body.

func (*Client) DecodeStatstotal

func (c *Client) DecodeStatstotal(resp *http.Response) (*Statstotal, error)

DecodeStatstotal decodes the Statstotal instance encoded in resp body.

func (*Client) DecodeTarget

func (c *Client) DecodeTarget(resp *http.Response) (*Target, error)

DecodeTarget decodes the Target instance encoded in resp body.

func (*Client) DecodeTeam

func (c *Client) DecodeTeam(resp *http.Response) (*Team, error)

DecodeTeam decodes the Team instance encoded in resp body.

func (*Client) DecodeTeamCollection

func (c *Client) DecodeTeamCollection(resp *http.Response) (TeamCollection, error)

DecodeTeamCollection decodes the TeamCollection instance encoded in resp body.

func (*Client) DecodeTeammember

func (c *Client) DecodeTeammember(resp *http.Response) (*Teammember, error)

DecodeTeammember decodes the Teammember instance encoded in resp body.

func (*Client) DecodeTeammemberCollection

func (c *Client) DecodeTeammemberCollection(resp *http.Response) (TeammemberCollection, error)

DecodeTeammemberCollection decodes the TeammemberCollection instance encoded in resp body.

func (*Client) DecodeToken

func (c *Client) DecodeToken(resp *http.Response) (*Token, error)

DecodeToken decodes the Token instance encoded in resp body.

func (*Client) DecodeTokenMetadata

func (c *Client) DecodeTokenMetadata(resp *http.Response) (*TokenMetadata, error)

DecodeTokenMetadata decodes the TokenMetadata instance encoded in resp body.

func (*Client) DecodeUser

func (c *Client) DecodeUser(resp *http.Response) (*User, error)

DecodeUser decodes the User instance encoded in resp body.

func (*Client) DecodeUserCollection

func (c *Client) DecodeUserCollection(resp *http.Response) (UserCollection, error)

DecodeUserCollection decodes the UserCollection instance encoded in resp body.

func (*Client) DeleteAssetAnnotations

func (c *Client) DeleteAssetAnnotations(ctx context.Context, path string, payload *AssetAnnotationDeleteRequest) (*http.Response, error)

Delete one or more annotation for a given asset.

func (*Client) DeleteAssetGroup

func (c *Client) DeleteAssetGroup(ctx context.Context, path string) (*http.Response, error)

Remove an asset from a group.

func (*Client) DeleteAssets

func (c *Client) DeleteAssets(ctx context.Context, path string) (*http.Response, error)

Delete an asset.

func (*Client) DeleteGroup

func (c *Client) DeleteGroup(ctx context.Context, path string) (*http.Response, error)

Delete a group of assets.

func (*Client) DeletePolicies

func (c *Client) DeletePolicies(ctx context.Context, path string) (*http.Response, error)

Delete a policy.

func (*Client) DeletePolicySettings

func (c *Client) DeletePolicySettings(ctx context.Context, path string) (*http.Response, error)

Delete a policy setting.

func (*Client) DeletePrograms

func (c *Client) DeletePrograms(ctx context.Context, path string) (*http.Response, error)

Delete a program.

func (*Client) DeleteSchedule

func (c *Client) DeleteSchedule(ctx context.Context, path string) (*http.Response, error)

Delete a schedule.

func (*Client) DeleteTeamMembers

func (c *Client) DeleteTeamMembers(ctx context.Context, path string) (*http.Response, error)

Delete a member from a team.

func (*Client) DeleteTeams

func (c *Client) DeleteTeams(ctx context.Context, path string) (*http.Response, error)

Delete a team.

func (*Client) DeleteUser

func (c *Client) DeleteUser(ctx context.Context, path string) (*http.Response, error)

Remove user

func (*Client) DiscoverAssets

func (c *Client) DiscoverAssets(ctx context.Context, path string, payload *DiscoveredAssetsPayload) (*http.Response, error)

This endpoint receives a list of assets with embedded asset annotations, and the group name where to be added. It should be used by third-party asset discovery services to onboard the discovered assets into Vulcan. The provided list of assets will overwrite the assets previously present in the group, in a way that: - Assets that do not exist in the team will be created and associated to the group - Assets that were already existing in the team but not associated to the group will be associated - Existing assets where the scannable field or the annotations are different will be updated accordingly - Assets that were associated to the group and now are not present in the provided list will be de-associated from the group if they belong to any other group, or deleted otherwise Because of the latency of this operation the endpoint is asynchronous. It returns a 202-Accepted HTTP response with the Job information in the response body.

The discovery group name must end with '-discovered-assets' to not mess with manually managed asset groups. Also the first part of the name should identify the discovery service using the endpoint, for example: serviceX-discovered-assets. Also be aware that the provided annotations may differ from the ones that will be stored, because they will include a prefix to not mess with any other annotations already present in the asset.

Duplicated assets (same identifier and type) in the payload are ignored if all their attributes are matching. Otherwise they produce an error and the job is aborted.

func (*Client) ExposureGlobalStats

func (c *Client) ExposureGlobalStats(ctx context.Context, path string, atDate *string, maxScore *float64, minScore *float64, tags *string) (*http.Response, error)

Get global exposure statistics. This metric takes into account the exposure across all lifecycle of vulnerabilities.

func (*Client) ExposureStats

func (c *Client) ExposureStats(ctx context.Context, path string, atDate *string, maxScore *float64, minScore *float64) (*http.Response, error)

Get exposure statistics for a team. This metric takes into account the exposure across all lifecycle of vulnerabilities.

func (*Client) FindFindingFindings

func (c *Client) FindFindingFindings(ctx context.Context, path string) (*http.Response, error)

Find a finding.

func (*Client) FindFindingsFromAIssueFindings

func (c *Client) FindFindingsFromAIssueFindings(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, maxScore *float64, minDate *string, minScore *float64, page *float64, size *float64, sortBy *string, status *string) (*http.Response, error)

Find all findings from a team and issue.

func (*Client) FindFindingsFromATargetFindings

func (c *Client) FindFindingsFromATargetFindings(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, maxScore *float64, minDate *string, minScore *float64, page *float64, size *float64, sortBy *string, status *string) (*http.Response, error)

Find all findings from a team and target.

func (*Client) FixedGlobalStats

func (c *Client) FixedGlobalStats(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, minDate *string, tags *string) (*http.Response, error)

Get global fixed issues statistics.

func (*Client) FixedStats

func (c *Client) FixedStats(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, minDate *string) (*http.Response, error)

Get fixed issues statistics for a team.

func (*Client) ListAssetAnnotations

func (c *Client) ListAssetAnnotations(ctx context.Context, path string) (*http.Response, error)

List annotations of a given asset.

func (*Client) ListAssetGroup

func (c *Client) ListAssetGroup(ctx context.Context, path string) (*http.Response, error)

List all assets from a group.

func (*Client) ListAssets

func (c *Client) ListAssets(ctx context.Context, path string, identifier *string) (*http.Response, error)

List all assets from a team.

func (*Client) ListFindingOverwritesFindings

func (c *Client) ListFindingOverwritesFindings(ctx context.Context, path string) (*http.Response, error)

List Finding Overwrites.

func (*Client) ListFindingsFindings

func (c *Client) ListFindingsFindings(ctx context.Context, path string, atDate *string, identifier *string, identifiers *string, issueID *string, labels *string, maxDate *string, maxScore *float64, minDate *string, minScore *float64, page *float64, size *float64, sortBy *string, status *string, targetID *string) (*http.Response, error)

List all findings from a team.

func (*Client) ListFindingsIssuesFindings

func (c *Client) ListFindingsIssuesFindings(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, minDate *string, page *float64, size *float64, sortBy *string, status *string, targetID *string) (*http.Response, error)

List number of findings and max score per issue.

func (*Client) ListFindingsLabelsFindings

func (c *Client) ListFindingsLabelsFindings(ctx context.Context, path string, atDate *string, identifiers *string, maxDate *string, minDate *string, status *string) (*http.Response, error)

List all findings labels.

func (*Client) ListFindingsTargetsFindings

func (c *Client) ListFindingsTargetsFindings(ctx context.Context, path string, atDate *string, identifiers *string, issueID *string, labels *string, maxDate *string, minDate *string, page *float64, size *float64, sortBy *string, status *string) (*http.Response, error)

List number of findings and max score per target.

func (*Client) ListGroup

func (c *Client) ListGroup(ctx context.Context, path string) (*http.Response, error)

List all groups of assets from a team.

func (*Client) ListPolicies

func (c *Client) ListPolicies(ctx context.Context, path string) (*http.Response, error)

List all policies from a team.

func (*Client) ListPolicySettings

func (c *Client) ListPolicySettings(ctx context.Context, path string) (*http.Response, error)

List settings for a policy.

func (*Client) ListProgramScans

func (c *Client) ListProgramScans(ctx context.Context, path string) (*http.Response, error)

List the scans of a program.

func (*Client) ListPrograms

func (c *Client) ListPrograms(ctx context.Context, path string) (*http.Response, error)

List all programs from a team.

func (*Client) ListRecipients

func (c *Client) ListRecipients(ctx context.Context, path string) (*http.Response, error)

List all recipients from a team.

func (*Client) ListTeamMembers

func (c *Client) ListTeamMembers(ctx context.Context, path string) (*http.Response, error)

List all members from a team.

func (*Client) ListTeams

func (c *Client) ListTeams(ctx context.Context, path string, tag *string) (*http.Response, error)

List all teams in Vulcan.

func (*Client) ListTeamsUser

func (c *Client) ListTeamsUser(ctx context.Context, path string) (*http.Response, error)

List all teams for an user.

func (*Client) ListUser

func (c *Client) ListUser(ctx context.Context, path string) (*http.Response, error)

List all users

func (*Client) MttrGlobalStats

func (c *Client) MttrGlobalStats(ctx context.Context, path string, labels *string, maxDate *string, minDate *string, tags *string) (*http.Response, error)

Get global MTTR statistics.

func (*Client) MttrStats

func (c *Client) MttrStats(ctx context.Context, path string, maxDate *string, minDate *string) (*http.Response, error)

Get MTR statistics for a team.

func (*Client) NewAssetsGlobalStatsRequest

func (c *Client) NewAssetsGlobalStatsRequest(ctx context.Context, path string, identifiers *string, labels *string, tags *string) (*http.Request, error)

NewAssetsGlobalStatsRequest create the request corresponding to the assets action endpoint of the global-stats resource.

func (*Client) NewCoverageStatsRequest

func (c *Client) NewCoverageStatsRequest(ctx context.Context, path string) (*http.Request, error)

NewCoverageStatsRequest create the request corresponding to the coverage action endpoint of the stats resource.

func (*Client) NewCreateAPITokenRequest

func (c *Client) NewCreateAPITokenRequest(ctx context.Context, path string) (*http.Request, error)

NewCreateAPITokenRequest create the request corresponding to the create action endpoint of the api-token resource.

func (*Client) NewCreateAssetAnnotationsRequest

func (c *Client) NewCreateAssetAnnotationsRequest(ctx context.Context, path string, payload *AssetAnnotationRequest) (*http.Request, error)

NewCreateAssetAnnotationsRequest create the request corresponding to the create action endpoint of the asset-annotations resource.

func (*Client) NewCreateAssetGroupRequest

func (c *Client) NewCreateAssetGroupRequest(ctx context.Context, path string, payload *AssetGroupPayload) (*http.Request, error)

NewCreateAssetGroupRequest create the request corresponding to the create action endpoint of the asset-group resource.

func (*Client) NewCreateAssetsRequest

func (c *Client) NewCreateAssetsRequest(ctx context.Context, path string, payload *CreateAssetPayload) (*http.Request, error)

NewCreateAssetsRequest create the request corresponding to the create action endpoint of the assets resource.

func (*Client) NewCreateGroupRequest

func (c *Client) NewCreateGroupRequest(ctx context.Context, path string, payload *GroupPayload) (*http.Request, error)

NewCreateGroupRequest create the request corresponding to the create action endpoint of the group resource.

func (*Client) NewCreateMultiStatusAssetsRequest

func (c *Client) NewCreateMultiStatusAssetsRequest(ctx context.Context, path string, payload *CreateAssetPayload) (*http.Request, error)

NewCreateMultiStatusAssetsRequest create the request corresponding to the createMultiStatus action endpoint of the assets resource.

func (*Client) NewCreatePoliciesRequest

func (c *Client) NewCreatePoliciesRequest(ctx context.Context, path string, payload *PolicyPayload) (*http.Request, error)

NewCreatePoliciesRequest create the request corresponding to the create action endpoint of the policies resource.

func (*Client) NewCreatePolicySettingsRequest

func (c *Client) NewCreatePolicySettingsRequest(ctx context.Context, path string, payload *PolicySettingPayload) (*http.Request, error)

NewCreatePolicySettingsRequest create the request corresponding to the create action endpoint of the policy-settings resource.

func (*Client) NewCreateProgramsRequest

func (c *Client) NewCreateProgramsRequest(ctx context.Context, path string, payload *ProgramPayload) (*http.Request, error)

NewCreateProgramsRequest create the request corresponding to the create action endpoint of the programs resource.

func (*Client) NewCreateScanRequest

func (c *Client) NewCreateScanRequest(ctx context.Context, path string, payload *ScanPayload) (*http.Request, error)

NewCreateScanRequest create the request corresponding to the create action endpoint of the scan resource.

func (*Client) NewCreateScheduleRequest

func (c *Client) NewCreateScheduleRequest(ctx context.Context, path string, payload *SchedulePayload) (*http.Request, error)

NewCreateScheduleRequest create the request corresponding to the create action endpoint of the schedule resource.

func (*Client) NewCreateTeamMembersRequest

func (c *Client) NewCreateTeamMembersRequest(ctx context.Context, path string, payload *TeamMemberPayload) (*http.Request, error)

NewCreateTeamMembersRequest create the request corresponding to the create action endpoint of the team-members resource.

func (*Client) NewCreateTeamsRequest

func (c *Client) NewCreateTeamsRequest(ctx context.Context, path string, payload *TeamPayload) (*http.Request, error)

NewCreateTeamsRequest create the request corresponding to the create action endpoint of the teams resource.

func (*Client) NewCreateUserRequest

func (c *Client) NewCreateUserRequest(ctx context.Context, path string, payload *UserPayload) (*http.Request, error)

NewCreateUserRequest create the request corresponding to the create action endpoint of the user resource.

func (*Client) NewCurrentExposureGlobalStatsRequest

func (c *Client) NewCurrentExposureGlobalStatsRequest(ctx context.Context, path string, labels *string, maxScore *float64, minScore *float64, tags *string) (*http.Request, error)

NewCurrentExposureGlobalStatsRequest create the request corresponding to the current exposure action endpoint of the global-stats resource.

func (*Client) NewCurrentExposureStatsRequest

func (c *Client) NewCurrentExposureStatsRequest(ctx context.Context, path string, maxScore *float64, minScore *float64) (*http.Request, error)

NewCurrentExposureStatsRequest create the request corresponding to the current exposure action endpoint of the stats resource.

func (*Client) NewDeleteAssetAnnotationsRequest

func (c *Client) NewDeleteAssetAnnotationsRequest(ctx context.Context, path string, payload *AssetAnnotationDeleteRequest) (*http.Request, error)

NewDeleteAssetAnnotationsRequest create the request corresponding to the delete action endpoint of the asset-annotations resource.

func (*Client) NewDeleteAssetGroupRequest

func (c *Client) NewDeleteAssetGroupRequest(ctx context.Context, path string) (*http.Request, error)

NewDeleteAssetGroupRequest create the request corresponding to the delete action endpoint of the asset-group resource.

func (*Client) NewDeleteAssetsRequest

func (c *Client) NewDeleteAssetsRequest(ctx context.Context, path string) (*http.Request, error)

NewDeleteAssetsRequest create the request corresponding to the delete action endpoint of the assets resource.

func (*Client) NewDeleteGroupRequest

func (c *Client) NewDeleteGroupRequest(ctx context.Context, path string) (*http.Request, error)

NewDeleteGroupRequest create the request corresponding to the delete action endpoint of the group resource.

func (*Client) NewDeletePoliciesRequest

func (c *Client) NewDeletePoliciesRequest(ctx context.Context, path string) (*http.Request, error)

NewDeletePoliciesRequest create the request corresponding to the delete action endpoint of the policies resource.

func (*Client) NewDeletePolicySettingsRequest

func (c *Client) NewDeletePolicySettingsRequest(ctx context.Context, path string) (*http.Request, error)

NewDeletePolicySettingsRequest create the request corresponding to the delete action endpoint of the policy-settings resource.

func (*Client) NewDeleteProgramsRequest

func (c *Client) NewDeleteProgramsRequest(ctx context.Context, path string) (*http.Request, error)

NewDeleteProgramsRequest create the request corresponding to the delete action endpoint of the programs resource.

func (*Client) NewDeleteScheduleRequest

func (c *Client) NewDeleteScheduleRequest(ctx context.Context, path string) (*http.Request, error)

NewDeleteScheduleRequest create the request corresponding to the delete action endpoint of the schedule resource.

func (*Client) NewDeleteTeamMembersRequest

func (c *Client) NewDeleteTeamMembersRequest(ctx context.Context, path string) (*http.Request, error)

NewDeleteTeamMembersRequest create the request corresponding to the delete action endpoint of the team-members resource.

func (*Client) NewDeleteTeamsRequest

func (c *Client) NewDeleteTeamsRequest(ctx context.Context, path string) (*http.Request, error)

NewDeleteTeamsRequest create the request corresponding to the delete action endpoint of the teams resource.

func (*Client) NewDeleteUserRequest

func (c *Client) NewDeleteUserRequest(ctx context.Context, path string) (*http.Request, error)

NewDeleteUserRequest create the request corresponding to the delete action endpoint of the user resource.

func (*Client) NewDiscoverAssetsRequest

func (c *Client) NewDiscoverAssetsRequest(ctx context.Context, path string, payload *DiscoveredAssetsPayload) (*http.Request, error)

NewDiscoverAssetsRequest create the request corresponding to the discover action endpoint of the assets resource.

func (*Client) NewExposureGlobalStatsRequest

func (c *Client) NewExposureGlobalStatsRequest(ctx context.Context, path string, atDate *string, maxScore *float64, minScore *float64, tags *string) (*http.Request, error)

NewExposureGlobalStatsRequest create the request corresponding to the exposure action endpoint of the global-stats resource.

func (*Client) NewExposureStatsRequest

func (c *Client) NewExposureStatsRequest(ctx context.Context, path string, atDate *string, maxScore *float64, minScore *float64) (*http.Request, error)

NewExposureStatsRequest create the request corresponding to the exposure action endpoint of the stats resource.

func (*Client) NewFindFindingFindingsRequest

func (c *Client) NewFindFindingFindingsRequest(ctx context.Context, path string) (*http.Request, error)

NewFindFindingFindingsRequest create the request corresponding to the Find finding action endpoint of the findings resource.

func (*Client) NewFindFindingsFromAIssueFindingsRequest

func (c *Client) NewFindFindingsFromAIssueFindingsRequest(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, maxScore *float64, minDate *string, minScore *float64, page *float64, size *float64, sortBy *string, status *string) (*http.Request, error)

NewFindFindingsFromAIssueFindingsRequest create the request corresponding to the Find findings from a Issue action endpoint of the findings resource.

func (*Client) NewFindFindingsFromATargetFindingsRequest

func (c *Client) NewFindFindingsFromATargetFindingsRequest(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, maxScore *float64, minDate *string, minScore *float64, page *float64, size *float64, sortBy *string, status *string) (*http.Request, error)

NewFindFindingsFromATargetFindingsRequest create the request corresponding to the Find findings from a Target action endpoint of the findings resource.

func (*Client) NewFixedGlobalStatsRequest

func (c *Client) NewFixedGlobalStatsRequest(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, minDate *string, tags *string) (*http.Request, error)

NewFixedGlobalStatsRequest create the request corresponding to the fixed action endpoint of the global-stats resource.

func (*Client) NewFixedStatsRequest

func (c *Client) NewFixedStatsRequest(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, minDate *string) (*http.Request, error)

NewFixedStatsRequest create the request corresponding to the fixed action endpoint of the stats resource.

func (*Client) NewListAssetAnnotationsRequest

func (c *Client) NewListAssetAnnotationsRequest(ctx context.Context, path string) (*http.Request, error)

NewListAssetAnnotationsRequest create the request corresponding to the list action endpoint of the asset-annotations resource.

func (*Client) NewListAssetGroupRequest

func (c *Client) NewListAssetGroupRequest(ctx context.Context, path string) (*http.Request, error)

NewListAssetGroupRequest create the request corresponding to the list action endpoint of the asset-group resource.

func (*Client) NewListAssetsRequest

func (c *Client) NewListAssetsRequest(ctx context.Context, path string, identifier *string) (*http.Request, error)

NewListAssetsRequest create the request corresponding to the list action endpoint of the assets resource.

func (*Client) NewListFindingOverwritesFindingsRequest

func (c *Client) NewListFindingOverwritesFindingsRequest(ctx context.Context, path string) (*http.Request, error)

NewListFindingOverwritesFindingsRequest create the request corresponding to the List Finding Overwrites action endpoint of the findings resource.

func (*Client) NewListFindingsFindingsRequest

func (c *Client) NewListFindingsFindingsRequest(ctx context.Context, path string, atDate *string, identifier *string, identifiers *string, issueID *string, labels *string, maxDate *string, maxScore *float64, minDate *string, minScore *float64, page *float64, size *float64, sortBy *string, status *string, targetID *string) (*http.Request, error)

NewListFindingsFindingsRequest create the request corresponding to the list findings action endpoint of the findings resource.

func (*Client) NewListFindingsIssuesFindingsRequest

func (c *Client) NewListFindingsIssuesFindingsRequest(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, minDate *string, page *float64, size *float64, sortBy *string, status *string, targetID *string) (*http.Request, error)

NewListFindingsIssuesFindingsRequest create the request corresponding to the list findings issues action endpoint of the findings resource.

func (*Client) NewListFindingsLabelsFindingsRequest

func (c *Client) NewListFindingsLabelsFindingsRequest(ctx context.Context, path string, atDate *string, identifiers *string, maxDate *string, minDate *string, status *string) (*http.Request, error)

NewListFindingsLabelsFindingsRequest create the request corresponding to the List findings labels action endpoint of the findings resource.

func (*Client) NewListFindingsTargetsFindingsRequest

func (c *Client) NewListFindingsTargetsFindingsRequest(ctx context.Context, path string, atDate *string, identifiers *string, issueID *string, labels *string, maxDate *string, minDate *string, page *float64, size *float64, sortBy *string, status *string) (*http.Request, error)

NewListFindingsTargetsFindingsRequest create the request corresponding to the list findings targets action endpoint of the findings resource.

func (*Client) NewListGroupRequest

func (c *Client) NewListGroupRequest(ctx context.Context, path string) (*http.Request, error)

NewListGroupRequest create the request corresponding to the list action endpoint of the group resource.

func (*Client) NewListPoliciesRequest

func (c *Client) NewListPoliciesRequest(ctx context.Context, path string) (*http.Request, error)

NewListPoliciesRequest create the request corresponding to the list action endpoint of the policies resource.

func (*Client) NewListPolicySettingsRequest

func (c *Client) NewListPolicySettingsRequest(ctx context.Context, path string) (*http.Request, error)

NewListPolicySettingsRequest create the request corresponding to the list action endpoint of the policy-settings resource.

func (*Client) NewListProgramScansRequest

func (c *Client) NewListProgramScansRequest(ctx context.Context, path string) (*http.Request, error)

NewListProgramScansRequest create the request corresponding to the list action endpoint of the program-scans resource.

func (*Client) NewListProgramsRequest

func (c *Client) NewListProgramsRequest(ctx context.Context, path string) (*http.Request, error)

NewListProgramsRequest create the request corresponding to the list action endpoint of the programs resource.

func (*Client) NewListRecipientsRequest

func (c *Client) NewListRecipientsRequest(ctx context.Context, path string) (*http.Request, error)

NewListRecipientsRequest create the request corresponding to the list action endpoint of the recipients resource.

func (*Client) NewListTeamMembersRequest

func (c *Client) NewListTeamMembersRequest(ctx context.Context, path string) (*http.Request, error)

NewListTeamMembersRequest create the request corresponding to the list action endpoint of the team-members resource.

func (*Client) NewListTeamsRequest

func (c *Client) NewListTeamsRequest(ctx context.Context, path string, tag *string) (*http.Request, error)

NewListTeamsRequest create the request corresponding to the list action endpoint of the teams resource.

func (*Client) NewListTeamsUserRequest

func (c *Client) NewListTeamsUserRequest(ctx context.Context, path string) (*http.Request, error)

NewListTeamsUserRequest create the request corresponding to the list-teams action endpoint of the user resource.

func (*Client) NewListUserRequest

func (c *Client) NewListUserRequest(ctx context.Context, path string) (*http.Request, error)

NewListUserRequest create the request corresponding to the list action endpoint of the user resource.

func (*Client) NewMttrGlobalStatsRequest

func (c *Client) NewMttrGlobalStatsRequest(ctx context.Context, path string, labels *string, maxDate *string, minDate *string, tags *string) (*http.Request, error)

NewMttrGlobalStatsRequest create the request corresponding to the mttr action endpoint of the global-stats resource.

func (*Client) NewMttrStatsRequest

func (c *Client) NewMttrStatsRequest(ctx context.Context, path string, maxDate *string, minDate *string) (*http.Request, error)

NewMttrStatsRequest create the request corresponding to the mttr action endpoint of the stats resource.

func (*Client) NewOpenGlobalStatsRequest

func (c *Client) NewOpenGlobalStatsRequest(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, minDate *string, tags *string) (*http.Request, error)

NewOpenGlobalStatsRequest create the request corresponding to the open action endpoint of the global-stats resource.

func (*Client) NewOpenStatsRequest

func (c *Client) NewOpenStatsRequest(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, minDate *string) (*http.Request, error)

NewOpenStatsRequest create the request corresponding to the open action endpoint of the stats resource.

func (*Client) NewProfileUserRequest

func (c *Client) NewProfileUserRequest(ctx context.Context, path string) (*http.Request, error)

NewProfileUserRequest create the request corresponding to the profile action endpoint of the user resource.

func (*Client) NewPutAssetAnnotationsRequest

func (c *Client) NewPutAssetAnnotationsRequest(ctx context.Context, path string, payload *AssetAnnotationRequest) (*http.Request, error)

NewPutAssetAnnotationsRequest create the request corresponding to the put action endpoint of the asset-annotations resource.

func (*Client) NewSendDigestReportRequest

func (c *Client) NewSendDigestReportRequest(ctx context.Context, path string, payload *DigestPayload) (*http.Request, error)

NewSendDigestReportRequest create the request corresponding to the send digest action endpoint of the report resource.

func (*Client) NewShowAssetsRequest

func (c *Client) NewShowAssetsRequest(ctx context.Context, path string) (*http.Request, error)

NewShowAssetsRequest create the request corresponding to the show action endpoint of the assets resource.

func (*Client) NewShowGroupRequest

func (c *Client) NewShowGroupRequest(ctx context.Context, path string) (*http.Request, error)

NewShowGroupRequest create the request corresponding to the show action endpoint of the group resource.

func (*Client) NewShowHealthcheckRequest

func (c *Client) NewShowHealthcheckRequest(ctx context.Context, path string) (*http.Request, error)

NewShowHealthcheckRequest create the request corresponding to the show action endpoint of the healthcheck resource.

func (*Client) NewShowJobsRequest

func (c *Client) NewShowJobsRequest(ctx context.Context, path string) (*http.Request, error)

NewShowJobsRequest create the request corresponding to the show action endpoint of the jobs resource.

func (*Client) NewShowPoliciesRequest

func (c *Client) NewShowPoliciesRequest(ctx context.Context, path string) (*http.Request, error)

NewShowPoliciesRequest create the request corresponding to the show action endpoint of the policies resource.

func (*Client) NewShowPolicySettingsRequest

func (c *Client) NewShowPolicySettingsRequest(ctx context.Context, path string) (*http.Request, error)

NewShowPolicySettingsRequest create the request corresponding to the show action endpoint of the policy-settings resource.

func (*Client) NewShowProgramsRequest

func (c *Client) NewShowProgramsRequest(ctx context.Context, path string) (*http.Request, error)

NewShowProgramsRequest create the request corresponding to the show action endpoint of the programs resource.

func (*Client) NewShowScanRequest

func (c *Client) NewShowScanRequest(ctx context.Context, path string) (*http.Request, error)

NewShowScanRequest create the request corresponding to the show action endpoint of the scan resource.

func (*Client) NewShowTeamMembersRequest

func (c *Client) NewShowTeamMembersRequest(ctx context.Context, path string) (*http.Request, error)

NewShowTeamMembersRequest create the request corresponding to the show action endpoint of the team-members resource.

func (*Client) NewShowTeamsRequest

func (c *Client) NewShowTeamsRequest(ctx context.Context, path string) (*http.Request, error)

NewShowTeamsRequest create the request corresponding to the show action endpoint of the teams resource.

func (*Client) NewShowUserRequest

func (c *Client) NewShowUserRequest(ctx context.Context, path string) (*http.Request, error)

NewShowUserRequest create the request corresponding to the show action endpoint of the user resource.

func (*Client) NewSubmitAFindingOverwriteFindingsRequest

func (c *Client) NewSubmitAFindingOverwriteFindingsRequest(ctx context.Context, path string, payload *FindingOverwritePayload) (*http.Request, error)

NewSubmitAFindingOverwriteFindingsRequest create the request corresponding to the Submit a Finding Overwrite action endpoint of the findings resource.

func (*Client) NewSubmitAFindingTicketCreationFindingsRequest added in v1.2.9

func (c *Client) NewSubmitAFindingTicketCreationFindingsRequest(ctx context.Context, path string, payload *FindingTicketPayload) (*http.Request, error)

NewSubmitAFindingTicketCreationFindingsRequest create the request corresponding to the Submit a Finding Ticket Creation action endpoint of the findings resource.

func (*Client) NewUpdateAssetAnnotationsRequest

func (c *Client) NewUpdateAssetAnnotationsRequest(ctx context.Context, path string, payload *AssetAnnotationRequest) (*http.Request, error)

NewUpdateAssetAnnotationsRequest create the request corresponding to the update action endpoint of the asset-annotations resource.

func (*Client) NewUpdateAssetsRequest

func (c *Client) NewUpdateAssetsRequest(ctx context.Context, path string, payload *AssetUpdatePayload) (*http.Request, error)

NewUpdateAssetsRequest create the request corresponding to the update action endpoint of the assets resource.

func (*Client) NewUpdateGroupRequest

func (c *Client) NewUpdateGroupRequest(ctx context.Context, path string, payload *GroupPayload) (*http.Request, error)

NewUpdateGroupRequest create the request corresponding to the update action endpoint of the group resource.

func (*Client) NewUpdatePoliciesRequest

func (c *Client) NewUpdatePoliciesRequest(ctx context.Context, path string, payload *PolicyUpdatePayload) (*http.Request, error)

NewUpdatePoliciesRequest create the request corresponding to the update action endpoint of the policies resource.

func (*Client) NewUpdatePolicySettingsRequest

func (c *Client) NewUpdatePolicySettingsRequest(ctx context.Context, path string, payload *PolicySettingUploadPayload) (*http.Request, error)

NewUpdatePolicySettingsRequest create the request corresponding to the update action endpoint of the policy-settings resource.

func (*Client) NewUpdateProgramsRequest

func (c *Client) NewUpdateProgramsRequest(ctx context.Context, path string, payload *ProgramUpdatePayload) (*http.Request, error)

NewUpdateProgramsRequest create the request corresponding to the update action endpoint of the programs resource.

func (*Client) NewUpdateRecipientsRequest

func (c *Client) NewUpdateRecipientsRequest(ctx context.Context, path string, payload *RecipientsPayload) (*http.Request, error)

NewUpdateRecipientsRequest create the request corresponding to the update action endpoint of the recipients resource.

func (*Client) NewUpdateScheduleRequest

func (c *Client) NewUpdateScheduleRequest(ctx context.Context, path string, payload *ScheduleUpdatePayload) (*http.Request, error)

NewUpdateScheduleRequest create the request corresponding to the update action endpoint of the schedule resource.

func (*Client) NewUpdateTeamMembersRequest

func (c *Client) NewUpdateTeamMembersRequest(ctx context.Context, path string, payload *TeamMemberUpdatePayload) (*http.Request, error)

NewUpdateTeamMembersRequest create the request corresponding to the update action endpoint of the team-members resource.

func (*Client) NewUpdateTeamsRequest

func (c *Client) NewUpdateTeamsRequest(ctx context.Context, path string, payload *TeamUpdatePayload) (*http.Request, error)

NewUpdateTeamsRequest create the request corresponding to the update action endpoint of the teams resource.

func (*Client) NewUpdateUserRequest

func (c *Client) NewUpdateUserRequest(ctx context.Context, path string, payload *UserUpdatePayload) (*http.Request, error)

NewUpdateUserRequest create the request corresponding to the update action endpoint of the user resource.

func (*Client) OpenGlobalStats

func (c *Client) OpenGlobalStats(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, minDate *string, tags *string) (*http.Response, error)

Get global open issues statistics.

func (*Client) OpenStats

func (c *Client) OpenStats(ctx context.Context, path string, atDate *string, identifiers *string, labels *string, maxDate *string, minDate *string) (*http.Response, error)

Get open issues statistics for a team.

func (*Client) ProfileUser

func (c *Client) ProfileUser(ctx context.Context, path string) (*http.Response, error)

Show profile information for the current authenticated user based on the key used to make the request.

func (*Client) PutAssetAnnotations

func (c *Client) PutAssetAnnotations(ctx context.Context, path string, payload *AssetAnnotationRequest) (*http.Response, error)

Override all annotations with a new list

func (*Client) SendDigestReport

func (c *Client) SendDigestReport(ctx context.Context, path string, payload *DigestPayload) (*http.Response, error)

Send digest report. If no dates are specified, the time range will be set for the last 30 days.

func (*Client) SetBearerSigner

func (c *Client) SetBearerSigner(signer goaclient.Signer)

SetBearerSigner sets the request signer for the Bearer security scheme.

func (*Client) ShowAssets

func (c *Client) ShowAssets(ctx context.Context, path string) (*http.Response, error)

Describe an asset.

func (*Client) ShowGroup

func (c *Client) ShowGroup(ctx context.Context, path string) (*http.Response, error)

Describe a group of assets.

func (*Client) ShowHealthcheck

func (c *Client) ShowHealthcheck(ctx context.Context, path string) (*http.Response, error)

A simple HTTP healthcheck.

func (*Client) ShowJobs

func (c *Client) ShowJobs(ctx context.Context, path string) (*http.Response, error)

Describes job status and results. The possible values for the status are: - 'PENDING': The job has been noted and is pending to be processed - 'RUNNING': The job is on execution - 'DONE': The job has finished, either successfully or unsuccesfully. Result.error needs to be processed to determine it

The results field indicates if there was an error during the execution of the job, and otherwise can return data from the job execution

func (*Client) ShowPolicies

func (c *Client) ShowPolicies(ctx context.Context, path string) (*http.Response, error)

Show information about a policy.

func (*Client) ShowPolicySettings

func (c *Client) ShowPolicySettings(ctx context.Context, path string) (*http.Response, error)

Describe a policy setting.

func (*Client) ShowPrograms

func (c *Client) ShowPrograms(ctx context.Context, path string) (*http.Response, error)

Show information about a program.

func (*Client) ShowScan

func (c *Client) ShowScan(ctx context.Context, path string) (*http.Response, error)

Describe scan

func (*Client) ShowTeamMembers

func (c *Client) ShowTeamMembers(ctx context.Context, path string) (*http.Response, error)

Describe a team-member association.

func (*Client) ShowTeams

func (c *Client) ShowTeams(ctx context.Context, path string) (*http.Response, error)

Show information about a team.

func (*Client) ShowUser

func (c *Client) ShowUser(ctx context.Context, path string) (*http.Response, error)

Describe user

func (*Client) SubmitAFindingOverwriteFindings

func (c *Client) SubmitAFindingOverwriteFindings(ctx context.Context, path string, payload *FindingOverwritePayload) (*http.Response, error)

Overwrite data for a specific finding.

func (*Client) SubmitAFindingTicketCreationFindings added in v1.2.9

func (c *Client) SubmitAFindingTicketCreationFindings(ctx context.Context, path string, payload *FindingTicketPayload) (*http.Response, error)

Create a ticket associated with the finding in a ticket tracker tool.

func (*Client) UpdateAssetAnnotations

func (c *Client) UpdateAssetAnnotations(ctx context.Context, path string, payload *AssetAnnotationRequest) (*http.Response, error)

Update one or more annotation for a given asset.

func (*Client) UpdateAssets

func (c *Client) UpdateAssets(ctx context.Context, path string, payload *AssetUpdatePayload) (*http.Response, error)

Update an asset. Asset type and identifier can not be modified.

func (*Client) UpdateGroup

func (c *Client) UpdateGroup(ctx context.Context, path string, payload *GroupPayload) (*http.Response, error)

Update a group of assets.

func (*Client) UpdatePolicies

func (c *Client) UpdatePolicies(ctx context.Context, path string, payload *PolicyUpdatePayload) (*http.Response, error)

Update information about a policy.

func (*Client) UpdatePolicySettings

func (c *Client) UpdatePolicySettings(ctx context.Context, path string, payload *PolicySettingUploadPayload) (*http.Response, error)

Update a policy setting.

func (*Client) UpdatePrograms

func (c *Client) UpdatePrograms(ctx context.Context, path string, payload *ProgramUpdatePayload) (*http.Response, error)

Update information about a program.

func (*Client) UpdateRecipients

func (c *Client) UpdateRecipients(ctx context.Context, path string, payload *RecipientsPayload) (*http.Response, error)

Update team recipients.

func (*Client) UpdateSchedule

func (c *Client) UpdateSchedule(ctx context.Context, path string, payload *ScheduleUpdatePayload) (*http.Response, error)

Update information about a schedule.

func (*Client) UpdateTeamMembers

func (c *Client) UpdateTeamMembers(ctx context.Context, path string, payload *TeamMemberUpdatePayload) (*http.Response, error)

Update a team-member association. Valid values for 'role' attribute: 'member', 'owner'.

func (*Client) UpdateTeams

func (c *Client) UpdateTeams(ctx context.Context, path string, payload *TeamUpdatePayload) (*http.Response, error)

Update information about a team.

func (*Client) UpdateUser

func (c *Client) UpdateUser(ctx context.Context, path string, payload *UserUpdatePayload) (*http.Response, error)

Update user

type CreateAssetPayload

type CreateAssetPayload struct {
	Annotations map[string]string `form:"annotations,omitempty" json:"annotations,omitempty" yaml:"annotations,omitempty" xml:"annotations,omitempty"`
	Assets      []*AssetPayload   `form:"assets" json:"assets" yaml:"assets" xml:"assets"`
	Groups      []string          `form:"groups,omitempty" json:"groups,omitempty" yaml:"groups,omitempty" xml:"groups,omitempty"`
}

CreateAssetPayload user type.

func (*CreateAssetPayload) Validate

func (ut *CreateAssetPayload) Validate() (err error)

Validate validates the CreateAssetPayload type instance.

type CreateAssets

type CreateAssets struct {
	// Assets
	Assets AssetCollection `form:"assets,omitempty" json:"assets,omitempty" yaml:"assets,omitempty" xml:"assets,omitempty"`
	// Errors
	Errors AsseterrorCollection `form:"errors,omitempty" json:"errors,omitempty" yaml:"errors,omitempty" xml:"errors,omitempty"`
}

Create Assets (default view)

Identifier: create_assets; view=default

type CurrentExposure

type CurrentExposure struct {
	// Stats for current exposure by different averages
	CurrentExposure *Statsaverages `` /* 134-byte string literal not displayed */
}

Current exposure stats (default view)

Identifier: current_exposure; view=default

type DigestPayload

type DigestPayload struct {
	// End Date
	EndDate *string `form:"end_date,omitempty" json:"end_date,omitempty" yaml:"end_date,omitempty" xml:"end_date,omitempty"`
	// Start Date
	StartDate *string `form:"start_date,omitempty" json:"start_date,omitempty" yaml:"start_date,omitempty" xml:"start_date,omitempty"`
}

DigestPayload user type.

type DiscoveredAssetsPayload

type DiscoveredAssetsPayload struct {
	Assets []*AssetWithAnnotationsPayload `form:"assets,omitempty" json:"assets,omitempty" yaml:"assets,omitempty" xml:"assets,omitempty"`
	// The discovery group name where assets will be added. It
	// 		must end with '-discovered-assets'. The first part of the name should
	// 		identify the discovery service using the endpoint
	GroupName string `form:"group_name" json:"group_name" yaml:"group_name" xml:"group_name"`
}

DiscoveredAssetsPayload user type.

func (*DiscoveredAssetsPayload) Validate

func (ut *DiscoveredAssetsPayload) Validate() (err error)

Validate validates the DiscoveredAssetsPayload type instance.

type Error

type Error struct {
	// Code
	Code int `form:"code" json:"code" yaml:"code" xml:"code"`
	// Error
	Error string `form:"error" json:"error" yaml:"error" xml:"error"`
	// Type
	Type string `form:"type" json:"type" yaml:"type" xml:"type"`
}

Error (default view)

Identifier: error; view=default

func (*Error) Validate

func (mt *Error) Validate() (err error)

Validate validates the Error media type instance.

type Exposure

type Exposure struct {
	// Stats for exposure by different averages
	Exposure *Statsaverages `form:"exposure,omitempty" json:"exposure,omitempty" yaml:"exposure,omitempty" xml:"exposure,omitempty"`
}

Exposure stats (default view)

Identifier: exposure; view=default

type Finding

type Finding struct {
	// Affected Resource
	AffectedResource *string `` /* 138-byte string literal not displayed */
	// Attachments
	Attachments []*Attachment `form:"attachments,omitempty" json:"attachments,omitempty" yaml:"attachments,omitempty" xml:"attachments,omitempty"`
	// Current exposure (hours). Only for OPEN findings
	CurrentExposure *float64 `` /* 134-byte string literal not displayed */
	// Details
	Details *string `form:"details,omitempty" json:"details,omitempty" yaml:"details,omitempty" xml:"details,omitempty"`
	// Finding ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Impact details
	ImpactDetails *string `` /* 126-byte string literal not displayed */
	// Issue
	Issue *Issue `form:"issue,omitempty" json:"issue,omitempty" yaml:"issue,omitempty" xml:"issue,omitempty"`
	// Resources
	Resources []*Resource `form:"resources,omitempty" json:"resources,omitempty" yaml:"resources,omitempty" xml:"resources,omitempty"`
	// Score
	Score *float64 `form:"score,omitempty" json:"score,omitempty" yaml:"score,omitempty" xml:"score,omitempty"`
	// Source
	Source *Source `form:"source,omitempty" json:"source,omitempty" yaml:"source,omitempty" xml:"source,omitempty"`
	// Status
	Status *string `form:"status,omitempty" json:"status,omitempty" yaml:"status,omitempty" xml:"status,omitempty"`
	// Target
	Target *Target `form:"target,omitempty" json:"target,omitempty" yaml:"target,omitempty" xml:"target,omitempty"`
	// Total exposure (hours)
	TotalExposure *float64 `` /* 126-byte string literal not displayed */
	// Link to the ticket
	URLTracker *string `form:"url_tracker,omitempty" json:"url_tracker,omitempty" yaml:"url_tracker,omitempty" xml:"url_tracker,omitempty"`
}

Finding (default view)

Identifier: finding; view=default

type FindingCollection

type FindingCollection []*Finding

FindingCollection is the media type for an array of Finding (default view)

Identifier: finding; type=collection; view=default

type FindingOverwrite

type FindingOverwrite struct {
	// Creation time
	CreatedAt *time.Time `form:"created_at,omitempty" json:"created_at,omitempty" yaml:"created_at,omitempty" xml:"created_at,omitempty"`
	// Finding ID
	FindingID *string `form:"finding_id,omitempty" json:"finding_id,omitempty" yaml:"finding_id,omitempty" xml:"finding_id,omitempty"`
	// Finding Overwrite ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Complementary information
	Notes *string `form:"notes,omitempty" json:"notes,omitempty" yaml:"notes,omitempty" xml:"notes,omitempty"`
	// The status requested for the finding referenced by the finding_id field
	Status *string `form:"status,omitempty" json:"status,omitempty" yaml:"status,omitempty" xml:"status,omitempty"`
	// The previous status for the finding referenced by the finding_id field
	StatusPrevious *string `` /* 130-byte string literal not displayed */
	// The ID associated to the team who requested this overwrite
	TeamID *string `form:"team_id,omitempty" json:"team_id,omitempty" yaml:"team_id,omitempty" xml:"team_id,omitempty"`
	// User who requested the finding overwrite
	User *string `form:"user,omitempty" json:"user,omitempty" yaml:"user,omitempty" xml:"user,omitempty"`
}

Finding Overwrite (default view)

Identifier: finding_overwrite; view=default

type FindingOverwriteCollection

type FindingOverwriteCollection []*FindingOverwrite

Finding_overwriteCollection is the media type for an array of Finding_overwrite (default view)

Identifier: finding_overwrite; type=collection; view=default

type FindingOverwritePayload

type FindingOverwritePayload struct {
	// Notes
	Notes string `form:"notes" json:"notes" yaml:"notes" xml:"notes"`
	// Status
	Status string `form:"status" json:"status" yaml:"status" xml:"status"`
}

FindingOverwritePayload user type.

func (*FindingOverwritePayload) Validate

func (ut *FindingOverwritePayload) Validate() (err error)

Validate validates the FindingOverwritePayload type instance.

type FindingTicket added in v1.2.9

type FindingTicket struct {
	// Link to the ticket
	URLTracker *string `form:"url_tracker,omitempty" json:"url_tracker,omitempty" yaml:"url_tracker,omitempty" xml:"url_tracker,omitempty"`
}

Finding Ticket (default view)

Identifier: finding_ticket; view=default

type FindingTicketPayload added in v1.2.9

type FindingTicketPayload struct {
	// Description
	Description *string `form:"description,omitempty" json:"description,omitempty" yaml:"description,omitempty" xml:"description,omitempty"`
	// Summary
	Summary string `form:"summary" json:"summary" yaml:"summary" xml:"summary"`
}

FindingTicketPayload user type.

func (*FindingTicketPayload) Validate added in v1.2.9

func (ut *FindingTicketPayload) Validate() (err error)

Validate validates the FindingTicketPayload type instance.

type FindingsIssue

type FindingsIssue struct {
	// Issue ID
	IssueID *string `form:"issue_id,omitempty" json:"issue_id,omitempty" yaml:"issue_id,omitempty" xml:"issue_id,omitempty"`
	// Max score for the issue among the affected assets
	MaxScore *float64 `form:"max_score,omitempty" json:"max_score,omitempty" yaml:"max_score,omitempty" xml:"max_score,omitempty"`
	// Number of affected resources by the issue
	ResourcesCount *float64 `` /* 130-byte string literal not displayed */
	// Issue summary
	Summary *string `form:"summary,omitempty" json:"summary,omitempty" yaml:"summary,omitempty" xml:"summary,omitempty"`
	// Number of targets affected by the issue
	TargetsCount *float64 `form:"targets_count,omitempty" json:"targets_count,omitempty" yaml:"targets_count,omitempty" xml:"targets_count,omitempty"`
}

Findings by Issue (default view)

Identifier: findings_issue; view=default

type FindingsIssueCollection

type FindingsIssueCollection []*FindingsIssue

Findings_issueCollection is the media type for an array of Findings_issue (default view)

Identifier: findings_issue; type=collection; view=default

type FindingsIssuesList

type FindingsIssuesList struct {
	// List of affected assets by issue
	Issues FindingsIssueCollection `form:"issues,omitempty" json:"issues,omitempty" yaml:"issues,omitempty" xml:"issues,omitempty"`
	// Pagination info
	Pagination *Pagination `form:"pagination,omitempty" json:"pagination,omitempty" yaml:"pagination,omitempty" xml:"pagination,omitempty"`
}

Findings by Issue list (default view)

Identifier: findings_issues_list; view=default

type FindingsLabels

type FindingsLabels struct {
	// associated labels
	Labels []string `form:"labels,omitempty" json:"labels,omitempty" yaml:"labels,omitempty" xml:"labels,omitempty"`
}

Findings Labels (default view)

Identifier: findings_labels; view=default

type FindingsList

type FindingsList struct {
	// List of findings
	Findings FindingCollection `form:"findings,omitempty" json:"findings,omitempty" yaml:"findings,omitempty" xml:"findings,omitempty"`
	// Pagination info
	Pagination *Pagination `form:"pagination,omitempty" json:"pagination,omitempty" yaml:"pagination,omitempty" xml:"pagination,omitempty"`
}

Findings list (default view)

Identifier: findings_list; view=default

type FindingsTarget

type FindingsTarget struct {
	// Number of findings for the target
	FindingsCount *float64 `` /* 126-byte string literal not displayed */
	// Target Identifier
	Identifier *string `form:"identifier,omitempty" json:"identifier,omitempty" yaml:"identifier,omitempty" xml:"identifier,omitempty"`
	// Number of issues for the target
	IssuesCount *float64 `form:"issues_count,omitempty" json:"issues_count,omitempty" yaml:"issues_count,omitempty" xml:"issues_count,omitempty"`
	// Max score for the issue among the affected assets
	MaxScore *float64 `form:"max_score,omitempty" json:"max_score,omitempty" yaml:"max_score,omitempty" xml:"max_score,omitempty"`
	// Target ID
	TargetID *string `form:"target_id,omitempty" json:"target_id,omitempty" yaml:"target_id,omitempty" xml:"target_id,omitempty"`
}

Findings by Target (default view)

Identifier: findings_target; view=default

type FindingsTargetCollection

type FindingsTargetCollection []*FindingsTarget

Findings_targetCollection is the media type for an array of Findings_target (default view)

Identifier: findings_target; type=collection; view=default

type FindingsTargetsList

type FindingsTargetsList struct {
	// Pagination info
	Pagination *Pagination `form:"pagination,omitempty" json:"pagination,omitempty" yaml:"pagination,omitempty" xml:"pagination,omitempty"`
	// List of findings per asset
	Targets FindingsTargetCollection `form:"targets,omitempty" json:"targets,omitempty" yaml:"targets,omitempty" xml:"targets,omitempty"`
}

Findings by Target list (default view)

Identifier: findings_targets_list; view=default

type Group

type Group struct {
	// Assets Count
	AssetsCount *int `form:"assets_count,omitempty" json:"assets_count,omitempty" yaml:"assets_count,omitempty" xml:"assets_count,omitempty"`
	// Description
	Description *string `form:"description,omitempty" json:"description,omitempty" yaml:"description,omitempty" xml:"description,omitempty"`
	// Group ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
	// Options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
}

Group (default view)

Identifier: group; view=default

type GroupCollection

type GroupCollection []*Group

GroupCollection is the media type for an array of Group (default view)

Identifier: group; type=collection; view=default

type GroupPayload

type GroupPayload struct {
	// name
	Name string `form:"name" json:"name" yaml:"name" xml:"name"`
	// Options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
}

GroupPayload user type.

func (*GroupPayload) Validate

func (ut *GroupPayload) Validate() (err error)

Validate validates the GroupPayload type instance.

type GroupWithoutAssetsCount

type GroupWithoutAssetsCount struct {
	// Description
	Description *string `form:"description,omitempty" json:"description,omitempty" yaml:"description,omitempty" xml:"description,omitempty"`
	// Group ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
	// Options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
}

Group (WithoutAssetsCount view)

Identifier: group; view=WithoutAssetsCount

type GroupWithoutAssetsCountCollection

type GroupWithoutAssetsCountCollection []*GroupWithoutAssetsCount

GroupCollection is the media type for an array of Group (WithoutAssetsCount view)

Identifier: group; type=collection; view=WithoutAssetsCount

type Healthcheck

type Healthcheck struct {
	// Status
	Status *string `form:"status,omitempty" json:"status,omitempty" yaml:"status,omitempty" xml:"status,omitempty"`
}

Healthcheck (default view)

Identifier: healthcheck; view=default

type Issue

type Issue struct {
	// Common Weakness Enumeration ID
	CweID *float64 `form:"cwe_id,omitempty" json:"cwe_id,omitempty" yaml:"cwe_id,omitempty" xml:"cwe_id,omitempty"`
	// Issue description
	Description *string `form:"description,omitempty" json:"description,omitempty" yaml:"description,omitempty" xml:"description,omitempty"`
	// Issue ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Associated labels
	Labels []string `form:"labels,omitempty" json:"labels,omitempty" yaml:"labels,omitempty" xml:"labels,omitempty"`
	// Recommendations to fix the issue
	Recommendations []string `` /* 130-byte string literal not displayed */
	// Documentation reference for the issue
	ReferenceLinks []string `` /* 130-byte string literal not displayed */
	// Issue summary
	Summary *string `form:"summary,omitempty" json:"summary,omitempty" yaml:"summary,omitempty" xml:"summary,omitempty"`
}

Issue (default view)

Identifier: issue; view=default

type Job

type Job struct {
	// Job ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Operation that triggered the job
	Operation *string `form:"operation,omitempty" json:"operation,omitempty" yaml:"operation,omitempty" xml:"operation,omitempty"`
	// Result of the job operation
	Result *struct {
		// Optionally populated field when the job finishes correctly, that returns execution related data. The format of the data is defined per operation type
		Data interface{} `form:"data,omitempty" json:"data,omitempty" yaml:"data,omitempty" xml:"data,omitempty"`
		// When not empty indicates that the job failed
		Error *string `form:"error,omitempty" json:"error,omitempty" yaml:"error,omitempty" xml:"error,omitempty"`
	} `form:"result,omitempty" json:"result,omitempty" yaml:"result,omitempty" xml:"result,omitempty"`
	// Indicates the status of the operation. The possible values are:
	// 	- 'PENDING': The job has been noted and is pending to be processed
	// 	- 'RUNNING': The job is on execution
	// 	- 'DONE': The job has finished, either successfully or unsuccesfully. Result.error needs to be processed to determine it
	Status *string `form:"status,omitempty" json:"status,omitempty" yaml:"status,omitempty" xml:"status,omitempty"`
	// Team ID
	TeamID *string `form:"team_id,omitempty" json:"team_id,omitempty" yaml:"team_id,omitempty" xml:"team_id,omitempty"`
}

Job (default view)

Identifier: job; view=default

type Listassetentry

type Listassetentry struct {
	// Alias
	Alias       *string           `form:"alias,omitempty" json:"alias,omitempty" yaml:"alias,omitempty" xml:"alias,omitempty"`
	Annotations map[string]string `form:"annotations,omitempty" json:"annotations,omitempty" yaml:"annotations,omitempty" xml:"annotations,omitempty"`
	// Classified At
	ClassifiedAt *string `form:"classified_at,omitempty" json:"classified_at,omitempty" yaml:"classified_at,omitempty" xml:"classified_at,omitempty"`
	// Environmental CVSS
	EnvironmentalCvss *string `` /* 142-byte string literal not displayed */
	// Groups
	Groups GroupWithoutAssetsCountCollection `form:"groups,omitempty" json:"groups,omitempty" yaml:"groups,omitempty" xml:"groups,omitempty"`
	// Asset ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Identifier
	Identifier *string `form:"identifier,omitempty" json:"identifier,omitempty" yaml:"identifier,omitempty" xml:"identifier,omitempty"`
	// Options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
	// Rolfp plus scope vector
	Rolfp *string `form:"rolfp,omitempty" json:"rolfp,omitempty" yaml:"rolfp,omitempty" xml:"rolfp,omitempty"`
	// Scannable
	Scannable *bool `form:"scannable,omitempty" json:"scannable,omitempty" yaml:"scannable,omitempty" xml:"scannable,omitempty"`
	// Type
	Type *Assettype `form:"type,omitempty" json:"type,omitempty" yaml:"type,omitempty" xml:"type,omitempty"`
}

List Asset Entry (default view)

Identifier: listassetentry; view=default

type ListassetentryCollection

type ListassetentryCollection []*Listassetentry

ListassetentryCollection is the media type for an array of Listassetentry (default view)

Identifier: listassetentry; type=collection; view=default

type Listassetgroup

type Listassetgroup struct {
	// Asset
	Assets AssetCollection `form:"assets,omitempty" json:"assets,omitempty" yaml:"assets,omitempty" xml:"assets,omitempty"`
	// Group
	Group *Group `form:"group,omitempty" json:"group,omitempty" yaml:"group,omitempty" xml:"group,omitempty"`
}

List asset group (default view)

Identifier: listassetgroup; view=default

type Mttr

type Mttr struct {
	// Stats for MTTR by severity
	Mttr *Statstotal `form:"mttr,omitempty" json:"mttr,omitempty" yaml:"mttr,omitempty" xml:"mttr,omitempty"`
}

MTTR stats (default view)

Identifier: mttr; view=default

type Pagination

type Pagination struct {
	// Limit of results for the list
	Limit *float64 `form:"limit,omitempty" json:"limit,omitempty" yaml:"limit,omitempty" xml:"limit,omitempty"`
	// Indicates if there are more results to query for the list
	More *bool `form:"more,omitempty" json:"more,omitempty" yaml:"more,omitempty" xml:"more,omitempty"`
	// Results list offset
	Offset *float64 `form:"offset,omitempty" json:"offset,omitempty" yaml:"offset,omitempty" xml:"offset,omitempty"`
	// Total number of results for the list
	Total *float64 `form:"total,omitempty" json:"total,omitempty" yaml:"total,omitempty" xml:"total,omitempty"`
}

Pagination info (default view)

Identifier: pagination; view=default

type Policy

type Policy struct {
	// Policy ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
	// Policy settings count
	SettingsCount *int `` /* 126-byte string literal not displayed */
}

Policy (default view)

Identifier: policy; view=default

type PolicyCollection

type PolicyCollection []*Policy

PolicyCollection is the media type for an array of Policy (default view)

Identifier: policy; type=collection; view=default

type PolicyPayload

type PolicyPayload struct {
	// name
	Name string `form:"name" json:"name" yaml:"name" xml:"name"`
}

PolicyPayload user type.

func (*PolicyPayload) Validate

func (ut *PolicyPayload) Validate() (err error)

Validate validates the PolicyPayload type instance.

type PolicySettingPayload

type PolicySettingPayload struct {
	// Check Type Name
	ChecktypeName string `form:"checktype_name" json:"checktype_name" yaml:"checktype_name" xml:"checktype_name"`
	// Options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
}

PolicySettingPayload user type.

func (*PolicySettingPayload) Validate

func (ut *PolicySettingPayload) Validate() (err error)

Validate validates the PolicySettingPayload type instance.

type PolicySettingUploadPayload

type PolicySettingUploadPayload struct {
	// Check Type Name
	ChecktypeName *string `` /* 126-byte string literal not displayed */
	// Options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
}

PolicySettingUploadPayload user type.

type PolicyUpdatePayload

type PolicyUpdatePayload struct {
	// name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
}

PolicyUpdatePayload user type.

type Policysetting

type Policysetting struct {
	// Check Type Name
	ChecktypeName *string `` /* 126-byte string literal not displayed */
	// Policy ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
}

Policy Setting (default view)

Identifier: policysetting; view=default

type PolicysettingCollection

type PolicysettingCollection []*Policysetting

PolicysettingCollection is the media type for an array of Policysetting (default view)

Identifier: policysetting; type=collection; view=default

type Program

type Program struct {
	// Autosend
	Autosend *bool `form:"autosend,omitempty" json:"autosend,omitempty" yaml:"autosend,omitempty" xml:"autosend,omitempty"`
	// Disabled
	Disabled *bool `form:"disabled,omitempty" json:"disabled,omitempty" yaml:"disabled,omitempty" xml:"disabled,omitempty"`
	// Global
	Global *bool `form:"global,omitempty" json:"global,omitempty" yaml:"global,omitempty" xml:"global,omitempty"`
	// Program ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
	// PolicyGroup
	PolicyGroups []*ProgramPolicyGroup `form:"policy_groups,omitempty" json:"policy_groups,omitempty" yaml:"policy_groups,omitempty" xml:"policy_groups,omitempty"`
	// Schedule
	Schedule *Schedule `form:"schedule,omitempty" json:"schedule,omitempty" yaml:"schedule,omitempty" xml:"schedule,omitempty"`
}

Program (default view)

Identifier: program; view=default

func (*Program) Validate

func (mt *Program) Validate() (err error)

Validate validates the Program media type instance.

type ProgramCollection

type ProgramCollection []*Program

ProgramCollection is the media type for an array of Program (default view)

Identifier: program; type=collection; view=default

func (ProgramCollection) Validate

func (mt ProgramCollection) Validate() (err error)

Validate validates the ProgramCollection media type instance.

type ProgramPayload

type ProgramPayload struct {
	// Autosend
	Autosend *bool `form:"autosend,omitempty" json:"autosend,omitempty" yaml:"autosend,omitempty" xml:"autosend,omitempty"`
	// Disabled
	Disabled *bool `form:"disabled,omitempty" json:"disabled,omitempty" yaml:"disabled,omitempty" xml:"disabled,omitempty"`
	// name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
	// PolicyGroups
	PolicyGroups []*ProgramPolicyGroupPayload `form:"policy_groups,omitempty" json:"policy_groups,omitempty" yaml:"policy_groups,omitempty" xml:"policy_groups,omitempty"`
}

ProgramPayload user type.

type ProgramPolicyGroup

type ProgramPolicyGroup struct {
	// group
	Group *Group `form:"group,omitempty" json:"group,omitempty" yaml:"group,omitempty" xml:"group,omitempty"`
	// policy
	Policy *Policy `form:"policy,omitempty" json:"policy,omitempty" yaml:"policy,omitempty" xml:"policy,omitempty"`
}

Program_policy_group media type (default view)

Identifier: program_policy_group; view=default

type ProgramPolicyGroupPayload

type ProgramPolicyGroupPayload struct {
	// group
	GroupID *string `form:"group_id,omitempty" json:"group_id,omitempty" yaml:"group_id,omitempty" xml:"group_id,omitempty"`
	// policy
	PolicyID *string `form:"policy_id,omitempty" json:"policy_id,omitempty" yaml:"policy_id,omitempty" xml:"policy_id,omitempty"`
}

ProgramPolicyGroupPayload user type.

type ProgramUpdatePayload

type ProgramUpdatePayload struct {
	// Autosend
	Autosend *bool `form:"autosend,omitempty" json:"autosend,omitempty" yaml:"autosend,omitempty" xml:"autosend,omitempty"`
	// Disabled
	Disabled *bool `form:"disabled,omitempty" json:"disabled,omitempty" yaml:"disabled,omitempty" xml:"disabled,omitempty"`
	// name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
	// PolicyGroups
	PolicyGroups []*ProgramPolicyGroupPayload `form:"policy_groups,omitempty" json:"policy_groups,omitempty" yaml:"policy_groups,omitempty" xml:"policy_groups,omitempty"`
}

ProgramUpdatePayload user type.

type Recipient

type Recipient struct {
	// email
	Email *string `form:"email,omitempty" json:"email,omitempty" yaml:"email,omitempty" xml:"email,omitempty"`
}

Recipient (default view)

Identifier: recipient; view=default

type RecipientCollection

type RecipientCollection []*Recipient

RecipientCollection is the media type for an array of Recipient (default view)

Identifier: recipient; type=collection; view=default

type RecipientsPayload

type RecipientsPayload struct {
	// Emails
	Emails []string `form:"emails" json:"emails" yaml:"emails" xml:"emails"`
}

RecipientsPayload user type.

func (*RecipientsPayload) Validate

func (ut *RecipientsPayload) Validate() (err error)

Validate validates the RecipientsPayload type instance.

type Resource

type Resource struct {
	// attributes of a resource
	Attributes []string `form:"attributes,omitempty" json:"attributes,omitempty" yaml:"attributes,omitempty" xml:"attributes,omitempty"`
	// Resource name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
	// values for attributes of a resource
	Resources []map[string]string `form:"resources,omitempty" json:"resources,omitempty" yaml:"resources,omitempty" xml:"resources,omitempty"`
}

resource (default view)

Identifier: resource; view=default

type Scan

type Scan struct {
	// Checks Count
	ChecksCount *int `form:"checks_count,omitempty" json:"checks_count,omitempty" yaml:"checks_count,omitempty" xml:"checks_count,omitempty"`
	// End Time
	EndTime *time.Time `form:"end_time,omitempty" json:"end_time,omitempty" yaml:"end_time,omitempty" xml:"end_time,omitempty"`
	// Scan ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Program
	Program *Program `form:"program,omitempty" json:"program,omitempty" yaml:"program,omitempty" xml:"program,omitempty"`
	// Progress
	Progress *float64 `form:"progress,omitempty" json:"progress,omitempty" yaml:"progress,omitempty" xml:"progress,omitempty"`
	// Requested By
	RequestedBy *string `form:"requested_by,omitempty" json:"requested_by,omitempty" yaml:"requested_by,omitempty" xml:"requested_by,omitempty"`
	// Scheduled Time
	ScheduledTime *time.Time `` /* 126-byte string literal not displayed */
	// Start Time
	StartTime *time.Time `form:"start_time,omitempty" json:"start_time,omitempty" yaml:"start_time,omitempty" xml:"start_time,omitempty"`
	// Status
	Status *string `form:"status,omitempty" json:"status,omitempty" yaml:"status,omitempty" xml:"status,omitempty"`
}

Scan (default view)

Identifier: scan; view=default

func (*Scan) Validate

func (mt *Scan) Validate() (err error)

Validate validates the Scan media type instance.

type ScanCollection

type ScanCollection []*Scan

ScanCollection is the media type for an array of Scan (default view)

Identifier: scan; type=collection; view=default

func (ScanCollection) Validate

func (mt ScanCollection) Validate() (err error)

Validate validates the ScanCollection media type instance.

type ScanPayload

type ScanPayload struct {
	// Program ID
	ProgramID string `form:"program_id" json:"program_id" yaml:"program_id" xml:"program_id"`
	// Group ID
	ScheduledTime *time.Time `` /* 126-byte string literal not displayed */
}

ScanPayload user type.

func (*ScanPayload) Validate

func (ut *ScanPayload) Validate() (err error)

Validate validates the ScanPayload type instance.

type Schedule

type Schedule struct {
	// Cron Expression
	Cron string `form:"cron" json:"cron" yaml:"cron" xml:"cron"`
}

Schedule (default view)

Identifier: schedule; view=default

func (*Schedule) Validate

func (mt *Schedule) Validate() (err error)

Validate validates the Schedule media type instance.

type SchedulePayload

type SchedulePayload struct {
	// Cron Expression
	Cron *string `form:"cron,omitempty" json:"cron,omitempty" yaml:"cron,omitempty" xml:"cron,omitempty"`
}

SchedulePayload user type.

type ScheduleUpdatePayload

type ScheduleUpdatePayload struct {
	// Cron Expression
	Cron *string `form:"cron,omitempty" json:"cron,omitempty" yaml:"cron,omitempty" xml:"cron,omitempty"`
}

ScheduleUpdatePayload user type.

type Source

type Source struct {
	// Source component
	Component *string `form:"component,omitempty" json:"component,omitempty" yaml:"component,omitempty" xml:"component,omitempty"`
	// Source ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Source instance ID
	Instance *string `form:"instance,omitempty" json:"instance,omitempty" yaml:"instance,omitempty" xml:"instance,omitempty"`
	// Source name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
	// Source options
	Options *string `form:"options,omitempty" json:"options,omitempty" yaml:"options,omitempty" xml:"options,omitempty"`
	// Source execution end time
	Time *string `form:"time,omitempty" json:"time,omitempty" yaml:"time,omitempty" xml:"time,omitempty"`
}

source (default view)

Identifier: source; view=default

type Stats

type Stats struct {
	// Stats for critical vulnerabilities
	Critical *float64 `form:"critical,omitempty" json:"critical,omitempty" yaml:"critical,omitempty" xml:"critical,omitempty"`
	// Stats for high vulnerabilities
	High *float64 `form:"high,omitempty" json:"high,omitempty" yaml:"high,omitempty" xml:"high,omitempty"`
	// Stats for informational vulnerabilities
	Informational *float64 `form:"informational,omitempty" json:"informational,omitempty" yaml:"informational,omitempty" xml:"informational,omitempty"`
	// Stats for low vulnerabilities
	Low *float64 `form:"low,omitempty" json:"low,omitempty" yaml:"low,omitempty" xml:"low,omitempty"`
	// Stats for medium vulnerabilities
	Medium *float64 `form:"medium,omitempty" json:"medium,omitempty" yaml:"medium,omitempty" xml:"medium,omitempty"`
}

Stats by severity (default view)

Identifier: stats; view=default

type Statsassets

type Statsassets struct {
	// Stats for assets by severity
	Assets *Statstotal `form:"assets,omitempty" json:"assets,omitempty" yaml:"assets,omitempty" xml:"assets,omitempty"`
}

Assets by severity stats (default view)

Identifier: statsassets; view=default

type Statsaverages

type Statsaverages struct {
	// Mean of the stats
	Mean *float64 `form:"mean,omitempty" json:"mean,omitempty" yaml:"mean,omitempty" xml:"mean,omitempty"`
	// Percentile 10 of the stats
	Percentile10 *float64 `form:"percentile_10,omitempty" json:"percentile_10,omitempty" yaml:"percentile_10,omitempty" xml:"percentile_10,omitempty"`
	// Percentile 25 of the stats
	Percentile25 *float64 `form:"percentile_25,omitempty" json:"percentile_25,omitempty" yaml:"percentile_25,omitempty" xml:"percentile_25,omitempty"`
	// Percentile 50 or median of the stats
	Percentile50 *float64 `form:"percentile_50,omitempty" json:"percentile_50,omitempty" yaml:"percentile_50,omitempty" xml:"percentile_50,omitempty"`
	// Percentile 75 or third quartile of the stats
	Percentile75 *float64 `form:"percentile_75,omitempty" json:"percentile_75,omitempty" yaml:"percentile_75,omitempty" xml:"percentile_75,omitempty"`
	// Percentile 90 of the stats
	Percentile90 *float64 `form:"percentile_90,omitempty" json:"percentile_90,omitempty" yaml:"percentile_90,omitempty" xml:"percentile_90,omitempty"`
}

Stats by different averages (default view)

Identifier: statsaverages; view=default

type Statscoverage

type Statscoverage struct {
	// Percentage of assets confirmed respect to discovered
	Coverage *float64 `form:"coverage,omitempty" json:"coverage,omitempty" yaml:"coverage,omitempty" xml:"coverage,omitempty"`
}

Asset Coverage: discovered vs. confirmed (default view)

Identifier: statscoverage; view=default

type Statsfixed

type Statsfixed struct {
	// Stats for fixed issues by severity
	FixedIssues *Stats `form:"fixed_issues,omitempty" json:"fixed_issues,omitempty" yaml:"fixed_issues,omitempty" xml:"fixed_issues,omitempty"`
}

Fixed issues stats (default view)

Identifier: statsfixed; view=default

type Statsopen

type Statsopen struct {
	// Stats for open issues by severity
	OpenIssues *Stats `form:"open_issues,omitempty" json:"open_issues,omitempty" yaml:"open_issues,omitempty" xml:"open_issues,omitempty"`
}

Open issues stats (default view)

Identifier: statsopen; view=default

type Statstotal

type Statstotal struct {
	// Stats for critical vulnerabilities
	Critical *float64 `form:"critical,omitempty" json:"critical,omitempty" yaml:"critical,omitempty" xml:"critical,omitempty"`
	// Stats for high vulnerabilities
	High *float64 `form:"high,omitempty" json:"high,omitempty" yaml:"high,omitempty" xml:"high,omitempty"`
	// Stats for informational vulnerabilities
	Informational *float64 `form:"informational,omitempty" json:"informational,omitempty" yaml:"informational,omitempty" xml:"informational,omitempty"`
	// Stats for low vulnerabilities
	Low *float64 `form:"low,omitempty" json:"low,omitempty" yaml:"low,omitempty" xml:"low,omitempty"`
	// Stats for medium vulnerabilities
	Medium *float64 `form:"medium,omitempty" json:"medium,omitempty" yaml:"medium,omitempty" xml:"medium,omitempty"`
	// Stats for all vulnerabilities
	Total *float64 `form:"total,omitempty" json:"total,omitempty" yaml:"total,omitempty" xml:"total,omitempty"`
}

Stats by severity (default view)

Identifier: statstotal; view=default

type Target

type Target struct {
	// Target ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Target identifier
	Identifier *string `form:"identifier,omitempty" json:"identifier,omitempty" yaml:"identifier,omitempty" xml:"identifier,omitempty"`
	// List of TeamIDs associated with target
	Teams []string `form:"teams,omitempty" json:"teams,omitempty" yaml:"teams,omitempty" xml:"teams,omitempty"`
}

target (default view)

Identifier: target; view=default

type Team

type Team struct {
	// Description
	Description *string `form:"description,omitempty" json:"description,omitempty" yaml:"description,omitempty" xml:"description,omitempty"`
	// Team ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// Name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
	// tag
	Tag *string `form:"tag,omitempty" json:"tag,omitempty" yaml:"tag,omitempty" xml:"tag,omitempty"`
	// If the team is Onboarded in Vulcan Tracker
	UsingTracker *bool `form:"using_tracker,omitempty" json:"using_tracker,omitempty" yaml:"using_tracker,omitempty" xml:"using_tracker,omitempty"`
}

Team (default view)

Identifier: team; view=default

type TeamCollection

type TeamCollection []*Team

TeamCollection is the media type for an array of Team (default view)

Identifier: team; type=collection; view=default

type TeamMemberPayload

type TeamMemberPayload struct {
	// Email
	Email *string `form:"email,omitempty" json:"email,omitempty" yaml:"email,omitempty" xml:"email,omitempty"`
	// Member role. Valid values are: owner, member
	Role *string `form:"role,omitempty" json:"role,omitempty" yaml:"role,omitempty" xml:"role,omitempty"`
	// User ID
	UserID *string `form:"user_id,omitempty" json:"user_id,omitempty" yaml:"user_id,omitempty" xml:"user_id,omitempty"`
}

TeamMemberPayload user type.

type TeamMemberUpdatePayload

type TeamMemberUpdatePayload struct {
	// Member role. Valid values are: owner, member
	Role *string `form:"role,omitempty" json:"role,omitempty" yaml:"role,omitempty" xml:"role,omitempty"`
}

TeamMemberUpdatePayload user type.

type TeamPayload

type TeamPayload struct {
	// description
	Description *string `form:"description,omitempty" json:"description,omitempty" yaml:"description,omitempty" xml:"description,omitempty"`
	// name
	Name string `form:"name" json:"name" yaml:"name" xml:"name"`
	// tag
	Tag string `form:"tag" json:"tag" yaml:"tag" xml:"tag"`
}

TeamPayload user type.

func (*TeamPayload) Validate

func (ut *TeamPayload) Validate() (err error)

Validate validates the TeamPayload type instance.

type TeamUpdatePayload

type TeamUpdatePayload struct {
	// description
	Description *string `form:"description,omitempty" json:"description,omitempty" yaml:"description,omitempty" xml:"description,omitempty"`
	// name
	Name *string `form:"name,omitempty" json:"name,omitempty" yaml:"name,omitempty" xml:"name,omitempty"`
	// tag
	Tag *string `form:"tag,omitempty" json:"tag,omitempty" yaml:"tag,omitempty" xml:"tag,omitempty"`
}

TeamUpdatePayload user type.

type Teammember

type Teammember struct {
	// Role
	Role *string `form:"role,omitempty" json:"role,omitempty" yaml:"role,omitempty" xml:"role,omitempty"`
	// User
	User *User `form:"user,omitempty" json:"user,omitempty" yaml:"user,omitempty" xml:"user,omitempty"`
}

Team Member (default view)

Identifier: teammember; view=default

type TeammemberCollection

type TeammemberCollection []*Teammember

TeammemberCollection is the media type for an array of Teammember (default view)

Identifier: teammember; type=collection; view=default

type Token

type Token struct {
	// Creation time
	CreationTime *string `form:"creation_time,omitempty" json:"creation_time,omitempty" yaml:"creation_time,omitempty" xml:"creation_time,omitempty"`
	// Email
	Email *string `form:"email,omitempty" json:"email,omitempty" yaml:"email,omitempty" xml:"email,omitempty"`
	// Hash
	Hash *string `form:"hash,omitempty" json:"hash,omitempty" yaml:"hash,omitempty" xml:"hash,omitempty"`
	// Token
	Token *string `form:"token,omitempty" json:"token,omitempty" yaml:"token,omitempty" xml:"token,omitempty"`
}

Token (default view)

Identifier: token; view=default

type TokenMetadata

type TokenMetadata struct {
	// Creation time
	CreationTime *string `form:"creation_time,omitempty" json:"creation_time,omitempty" yaml:"creation_time,omitempty" xml:"creation_time,omitempty"`
	// Email
	Email *string `form:"email,omitempty" json:"email,omitempty" yaml:"email,omitempty" xml:"email,omitempty"`
	// Hash
	Hash *string `form:"hash,omitempty" json:"hash,omitempty" yaml:"hash,omitempty" xml:"hash,omitempty"`
}

Token (metadata view)

Identifier: token; view=metadata

type User

type User struct {
	// Active
	Active *bool `form:"active,omitempty" json:"active,omitempty" yaml:"active,omitempty" xml:"active,omitempty"`
	// Admin
	Admin *bool `form:"admin,omitempty" json:"admin,omitempty" yaml:"admin,omitempty" xml:"admin,omitempty"`
	// Email
	Email *string `form:"email,omitempty" json:"email,omitempty" yaml:"email,omitempty" xml:"email,omitempty"`
	// First name
	Firstname *string `form:"firstname,omitempty" json:"firstname,omitempty" yaml:"firstname,omitempty" xml:"firstname,omitempty"`
	// User ID
	ID *string `form:"id,omitempty" json:"id,omitempty" yaml:"id,omitempty" xml:"id,omitempty"`
	// last_login
	LastLogin *time.Time `form:"last_login,omitempty" json:"last_login,omitempty" yaml:"last_login,omitempty" xml:"last_login,omitempty"`
	// Last name
	Lastname *string `form:"lastname,omitempty" json:"lastname,omitempty" yaml:"lastname,omitempty" xml:"lastname,omitempty"`
	// Observer
	Observer *bool `form:"observer,omitempty" json:"observer,omitempty" yaml:"observer,omitempty" xml:"observer,omitempty"`
}

User (default view)

Identifier: user; view=default

type UserCollection

type UserCollection []*User

UserCollection is the media type for an array of User (default view)

Identifier: user; type=collection; view=default

type UserPayload

type UserPayload struct {
	// Active (Default: true)
	Active *bool `form:"active,omitempty" json:"active,omitempty" yaml:"active,omitempty" xml:"active,omitempty"`
	// Admin
	Admin bool `form:"admin" json:"admin" yaml:"admin" xml:"admin"`
	// Email
	Email string `form:"email" json:"email" yaml:"email" xml:"email"`
	// First Name
	Firstname *string `form:"firstname,omitempty" json:"firstname,omitempty" yaml:"firstname,omitempty" xml:"firstname,omitempty"`
	// Last Name
	Lastname *string `form:"lastname,omitempty" json:"lastname,omitempty" yaml:"lastname,omitempty" xml:"lastname,omitempty"`
	// Observer
	Observer bool `form:"observer" json:"observer" yaml:"observer" xml:"observer"`
}

UserPayload user type.

func (*UserPayload) Validate

func (ut *UserPayload) Validate() (err error)

Validate validates the UserPayload type instance.

type UserUpdatePayload

type UserUpdatePayload struct {
	// Active (Default: true)
	Active *bool `form:"active,omitempty" json:"active,omitempty" yaml:"active,omitempty" xml:"active,omitempty"`
	// Admin
	Admin bool `form:"admin" json:"admin" yaml:"admin" xml:"admin"`
	// First Name
	Firstname *string `form:"firstname,omitempty" json:"firstname,omitempty" yaml:"firstname,omitempty" xml:"firstname,omitempty"`
	// Last Name
	Lastname *string `form:"lastname,omitempty" json:"lastname,omitempty" yaml:"lastname,omitempty" xml:"lastname,omitempty"`
}

UserUpdatePayload user type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL