Go API client for sonatypeiq

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 1.196.0-01
Package version: 1.0.0
Generator version: 7.16.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sonatypeiq.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sonatypeiq.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sonatypeiq.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sonatypeiq.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sonatypeiq.ContextOperationServerIndices and sonatypeiq.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sonatypeiq.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sonatypeiq.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AdvancedSearchAPI	CreateSearchIndexAsync	Post /api/v2/search/advanced/index
AdvancedSearchAPI	GetExportResults	Get /api/v2/search/advanced/export/csv
AdvancedSearchAPI	SearchIndex	Get /api/v2/search/advanced
ApplicationCategoriesAPI	AddTag	Post /api/v2/applicationCategories/organization/{organizationId}
ApplicationCategoriesAPI	DeleteTag	Delete /api/v2/applicationCategories/organization/{organizationId}/{tagId}
ApplicationCategoriesAPI	GetApplicableTags	Get /api/v2/applicationCategories/organization/{organizationId}/applicable
ApplicationCategoriesAPI	GetApplicableTagsByApplicationPublicId	Get /api/v2/applicationCategories/application/{applicationPublicId}/applicable
ApplicationCategoriesAPI	GetApplicationApplicableTags	Get /api/v2/applicationCategories/application/{applicationPublicId}
ApplicationCategoriesAPI	GetAppliedPolicyTags	Get /api/v2/applicationCategories/organization/{organizationId}/policy
ApplicationCategoriesAPI	GetAppliedTags	Get /api/v2/applicationCategories/organization/{organizationId}/applied
ApplicationCategoriesAPI	GetTags	Get /api/v2/applicationCategories/organization/{organizationId}
ApplicationCategoriesAPI	GetTagsUsedByApplications	Get /api/v2/applicationCategories/application
ApplicationCategoriesAPI	UpdateTag	Put /api/v2/applicationCategories/organization/{organizationId}
ApplicationReportDataAPI	GetData	Get /api/v2/applications/{applicationPublicId}/reports/{scanId}
ApplicationReportDataAPI	GetDependencyTree	Get /api/v2/applications/{applicationPublicId}/reports/{scanId}/dependencyTree
ApplicationReportDataAPI	GetPolicyViolationDiff	Get /api/v2/applications/{applicationPublicId}/reports/policyViolations/diff
ApplicationReportDataAPI	GetPolicyViolations1	Get /api/v2/applications/{applicationPublicId}/reports/{scanId}/policy
ApplicationReportDataAPI	GetRawData	Get /api/v2/applications/{applicationPublicId}/reports/{scanId}/raw
ApplicationsAPI	AddApplication	Post /api/v2/applications
ApplicationsAPI	CloneApplication	Post /api/v2/applications/{sourceApplicationId}/clone
ApplicationsAPI	DeleteApplication	Delete /api/v2/applications/{applicationId}
ApplicationsAPI	GetApplication	Get /api/v2/applications/{applicationId}
ApplicationsAPI	GetApplications	Get /api/v2/applications
ApplicationsAPI	GetApplicationsByOrganizationId	Get /api/v2/applications/organization/{organizationId}
ApplicationsAPI	MoveApplication	Post /api/v2/applications/{applicationId}/move/organization/{organizationId}
ApplicationsAPI	UpdateApplication	Put /api/v2/applications/{applicationId}
AuditLogsAPI	GetAuditLogs	Get /api/v2/auditLogs
AutoPolicyWaiverExclusionsAPI	AddAutoPolicyWaiveExclusion	Post /api/v2/autoPolicyWaiverExclusions/{ownerType}/{ownerId}
AutoPolicyWaiverExclusionsAPI	DeleteAutoPolicyWaiverExclusion	Delete /api/v2/autoPolicyWaiverExclusions/{ownerType}/{ownerId}/{autoPolicyWaiverId}/{autoPolicyWaiverExclusionId}
AutoPolicyWaiverExclusionsAPI	GetAutoPolicyWaiverExclusions	Get /api/v2/autoPolicyWaiverExclusions/{ownerType}/{ownerId}/{autoPolicyWaiverId}
AutoPolicyWaiversAPI	AddAutoPolicyWaiver	Post /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}
AutoPolicyWaiversAPI	AddAutoPolicyWaivers	Post /api/v2/autoPolicyWaivers/v2/{ownerType}/{ownerId}
AutoPolicyWaiversAPI	DeleteAutoPolicyWaiver	Delete /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/{autoPolicyWaiverId}
AutoPolicyWaiversAPI	GetApplicableAutoWaivers	Get /api/v2/autoPolicyWaivers/v2/{ownerType}/{ownerId}/applicableAutoWaivers
AutoPolicyWaiversAPI	GetAutoPolicyWaiver	Get /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/{autoPolicyWaiverId}
AutoPolicyWaiversAPI	GetAutoPolicyWaiverStatus	Get /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/status
AutoPolicyWaiversAPI	GetAutoPolicyWaivers	Get /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}
AutoPolicyWaiversAPI	UpdateAutoPolicyWaiver	Put /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/{autoPolicyWaiverId}
CPEMatchingConfigurationAPI	GetCpeMatchingConfiguration	Get /api/v2/{ownerType}/{internalOwnerId}/configuration/publicSource/cpe
CPEMatchingConfigurationAPI	UpdateCpeMatchingConfiguration	Put /api/v2/{ownerType}/{internalOwnerId}/configuration/publicSource/cpe
ClaimComponentsAPI	Delete	Delete /api/v2/claim/components/{hash}
ClaimComponentsAPI	Get	Get /api/v2/claim/components/{hash}
ClaimComponentsAPI	GetAll	Get /api/v2/claim/components
ClaimComponentsAPI	Set	Post /api/v2/claim/components
ComponentLabelsAPI	AddLabel	Post /api/v2/labels/{ownerType}/{ownerId}
ComponentLabelsAPI	DeleteLabel	Delete /api/v2/labels/{ownerType}/{ownerId}/{labelId}
ComponentLabelsAPI	GetApplicableContexts	Get /api/v2/labels/{ownerType}/{ownerId}/applicable/context/{labelId}
ComponentLabelsAPI	GetApplicableLabels	Get /api/v2/labels/{ownerType}/{ownerId}/applicable
ComponentLabelsAPI	GetLabels	Get /api/v2/labels/{ownerType}/{ownerId}
ComponentLabelsAPI	UpdateLabel	Put /api/v2/labels/{ownerType}/{ownerId}
ComponentSearchAPI	SearchComponent	Get /api/v2/search/component
ComponentsAPI	DeleteComponentLabel	Delete /api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}
ComponentsAPI	GetComponentDetails	Post /api/v2/components/details
ComponentsAPI	GetComponentVersions	Post /api/v2/components/versions
ComponentsAPI	GetSuggestedRemediationForComponent	Post /api/v2/components/remediation/{ownerType}/{ownerId}
ComponentsAPI	SetComponentLabel	Post /api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}
CompositeSourceControlAPI	GetCompositeSourceControlByOwner	Get /api/v2/compositeSourceControl/{ownerType}/{internalOwnerId}
CompositeSourceControlValidatorAPI	ValidateSourceControlConfig	Get /api/v2/compositeSourceControlConfigValidator/application/{applicationId}
ConfigCrowdAPI	DeleteCrowdConfiguration	Delete /api/v2/config/crowd
ConfigCrowdAPI	GetCrowdConfiguration	Get /api/v2/config/crowd
ConfigCrowdAPI	InsertOrUpdateCrowdConfiguration	Put /api/v2/config/crowd
ConfigCrowdAPI	TestCrowdConfiguration	Post /api/v2/config/crowd/test
ConfigJiraAPI	DeleteConfiguration1	Delete /api/v2/config/jira
ConfigJiraAPI	GetConfiguration1	Get /api/v2/config/jira
ConfigJiraAPI	SetConfiguration1	Put /api/v2/config/jira
ConfigMailAPI	DeleteConfiguration2	Delete /api/v2/config/mail
ConfigMailAPI	GetConfiguration2	Get /api/v2/config/mail
ConfigMailAPI	SetConfiguration2	Put /api/v2/config/mail
ConfigMailAPI	TestConfiguration	Post /api/v2/config/mail/test/{recipientEmail}
ConfigProxyServerAPI	DeleteConfiguration3	Delete /api/v2/config/httpProxyServer
ConfigProxyServerAPI	GetConfiguration3	Get /api/v2/config/httpProxyServer
ConfigProxyServerAPI	SetConfiguration3	Put /api/v2/config/httpProxyServer
ConfigReverseProxyAuthenticationAPI	DeleteConfiguration4	Delete /api/v2/config/reverseProxyAuthentication
ConfigReverseProxyAuthenticationAPI	GetConfiguration4	Get /api/v2/config/reverseProxyAuthentication
ConfigReverseProxyAuthenticationAPI	SetConfiguration4	Put /api/v2/config/reverseProxyAuthentication
ConfigSAMLAPI	DeleteSamlConfiguration	Delete /api/v2/config/saml
ConfigSAMLAPI	GetMetadata	Get /api/v2/config/saml/metadata
ConfigSAMLAPI	GetSamlConfiguration	Get /api/v2/config/saml
ConfigSAMLAPI	InsertOrUpdateSamlConfiguration	Put /api/v2/config/saml
ConfigSourceControlAPI	DeleteConfiguration5	Delete /api/v2/config/sourceControl
ConfigSourceControlAPI	GetConfiguration5	Get /api/v2/config/sourceControl
ConfigSourceControlAPI	SetConfiguration5	Put /api/v2/config/sourceControl
ConfigZscalerAPI	DeleteAllCategories	Delete /api/v2/config/zscaler/update
ConfigZscalerAPI	DeleteCategory	Delete /api/v2/config/zscaler/update/{format}
ConfigZscalerAPI	DeleteConfiguration6	Delete /api/v2/config/zscaler
ConfigZscalerAPI	GetConfiguration6	Get /api/v2/config/zscaler
ConfigZscalerAPI	GetQuota	Get /api/v2/config/zscaler/zscalerLimits
ConfigZscalerAPI	SetConfiguration6	Put /api/v2/config/zscaler
ConfigZscalerAPI	TestConfiguration1	Post /api/v2/config/zscaler/testConfig
ConfigZscalerAPI	TriggerUpdate	Post /api/v2/config/zscaler/update/{format}
ConfigZscalerAPI	TriggerUpdateAll	Post /api/v2/config/zscaler/update
ConfigurationAPI	DeleteConfiguration	Delete /api/v2/config
ConfigurationAPI	GetConfiguration	Get /api/v2/config
ConfigurationAPI	SetConfiguration	Put /api/v2/config
ConfigureArtifactoryConnectionAPI	AddArtifactoryConnection	Post /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
ConfigureArtifactoryConnectionAPI	DeleteArtifactoryConnection	Delete /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
ConfigureArtifactoryConnectionAPI	GetArtifactoryConnection	Get /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
ConfigureArtifactoryConnectionAPI	GetOwnerArtifactoryConnection	Get /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
ConfigureArtifactoryConnectionAPI	TestArtifactoryConnection	Post /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/test
ConfigureArtifactoryConnectionAPI	TestArtifactoryConnection1	Post /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}/test
ConfigureArtifactoryConnectionAPI	UpdateArtifactoryConnection	Put /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
ConfigureArtifactoryConnectionAPI	UpdateOwnerArtifactoryConnectionStatus	Put /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
CycloneDXAPI	GetByReportId	Get /api/v2/cycloneDx/{cdxVersion}/{applicationId}/reports/{reportId}
CycloneDXAPI	GetLatest	Get /api/v2/cycloneDx/{cdxVersion}/{applicationId}/stages/{stageId}
DataRetentionPoliciesAPI	GetDataRetentionPolicies	Get /api/v2/dataRetentionPolicies/organizations/{organizationId}
DataRetentionPoliciesAPI	GetParentDataRetentionPolicies	Get /api/v2/dataRetentionPolicies/organizations/{organizationId}/parent
DataRetentionPoliciesAPI	SetDataRetentionPolicies	Put /api/v2/dataRetentionPolicies/organizations/{organizationId}
DeveloperPrioritiesAPI	GetPriorities	Get /api/v2/developer/priorities/{applicationId}/{scanId}
DeveloperPrioritiesAPI	GetPrioritiesExport	Get /api/v2/developer/priorities/{applicationId}/{scanId}/export
EndpointsAPI	GetOpenAPI	Get /api/v2/endpoints/{apiType}
FeatureConfigurationAPI	DisableFeature	Delete /api/v2/config/features/{feature}
FeatureConfigurationAPI	EnabledFeature	Post /api/v2/config/features/{feature}
FirewallAPI	AddProprietaryComponentNames	Post /api/v2/firewall/namespace_confusion/{format}
FirewallAPI	AddRepositoryManager	Post /api/v2/firewall/repositoryManagers
FirewallAPI	AddWaiver	Post /api/v2/firewall/container-image/{containerImageId}/policyWaiver
FirewallAPI	ConfigureRepositories	Post /api/v2/firewall/repositories/configuration/{repositoryManagerId}
FirewallAPI	DeleteContainerImagePolicyWaiver	Delete /api/v2/firewall/container-image/{containerImageId}/policyWaiver
FirewallAPI	DeleteRepositoryManager	Delete /api/v2/firewall/repositoryManagers/{repositoryManagerId}
FirewallAPI	EvaluateComponents1	Post /api/v2/firewall/components/{repositoryManagerId}/{repositoryId}/evaluate
FirewallAPI	EvaluateMalware	Post /api/v2/malware-defense/evaluate
FirewallAPI	GetConfiguredRepositories	Get /api/v2/firewall/repositories/configuration/{repositoryManagerId}
FirewallAPI	GetContainerImagesInQuarantine	Get /api/v2/firewall/container-image/policyViolations/quarantined
FirewallAPI	GetFirewallAutoUnquarantineConfig	Get /api/v2/firewall/releaseQuarantine/configuration
FirewallAPI	GetFirewallMetrics	Get /api/v2/firewall/metrics/embedded
FirewallAPI	GetFirewallUnquarantineSummary	Get /api/v2/firewall/releaseQuarantine/summary
FirewallAPI	GetMalwareDefenseMetrics	Get /api/v2/malware-defense/metrics
FirewallAPI	GetQuarantineList	Get /api/v2/firewall/components/quarantined
FirewallAPI	GetQuarantineSummary	Get /api/v2/firewall/quarantine/summary
FirewallAPI	GetQuarantinedComponentViewAnonymousAccess	Get /api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess
FirewallAPI	GetRepositoryContainer	Get /api/v2/firewall/repositoryContainer
FirewallAPI	GetRepositoryManager	Get /api/v2/firewall/repositoryManagers/{repositoryManagerId}
FirewallAPI	GetRepositoryManagers	Get /api/v2/firewall/repositoryManagers
FirewallAPI	GetUnquarantineList	Get /api/v2/firewall/components/autoReleasedFromQuarantine
FirewallAPI	GetWaivers	Get /api/v2/firewall/container-image/policyWaiver
FirewallAPI	RemoveProprietaryComponentNames	Delete /api/v2/firewall/namespace_confusion/{format}
FirewallAPI	SetFirewallAutoUnquarantineConfig	Put /api/v2/firewall/releaseQuarantine/configuration
FirewallAPI	SetQuarantinedComponentViewAnonymousAccess	Put /api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess/{enabled}
LicenseLegalMetadataReportAPI	GetLicenseLegalApplicationHTMLReport	Get /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report
LicenseLegalMetadataReportAPI	GetLicenseLegalApplicationReport	Get /api/v2/licenseLegalMetadata/application/{applicationId}
LicenseLegalMetadataReportAPI	GetLicenseLegalApplicationReport1	Get /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}
LicenseLegalMetadataReportAPI	GetLicenseLegalComponentReport	Get /api/v2/licenseLegalMetadata/{ownerType}/{ownerId}/component
LicenseLegalMetadataReportAPI	GetLicenseLegalCustomApplicationHTMLReport	Post /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report
LicenseLegalMetadataReportAPI	GetLicenseLegalCustomApplicationHTMLReport1	Post /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report/templateId/{templateId}
LicenseLegalMetadataReportAPI	GetLicenseLegalCustomMultiApplicationHTMLReport1	Post /api/v2/licenseLegalMetadata/multiApplication/report/templateId/{templateId}
LicenseLegalMetadataReportAPI	GetLicenseLegalMultiApplicationHTMLReport	Post /api/v2/licenseLegalMetadata/multiApplication/report
LicenseLegalMetadataReportAPI	GetLicenseLegalMultiApplicationReportFromActiveUserFilter	Post /api/v2/licenseLegalMetadata/multiApplication/activeUserFilter/report/templateId/{templateId}
LicenseLegalMetadataTemplateAPI	DeleteAttributionReportTemplate	Delete /api/v2/licenseLegalMetadata/report-template/{id}
LicenseLegalMetadataTemplateAPI	GetAllAttributionReportTemplates	Get /api/v2/licenseLegalMetadata/report-template
LicenseLegalMetadataTemplateAPI	GetAttributionReportTemplateById	Get /api/v2/licenseLegalMetadata/report-template/{id}
LicenseLegalMetadataTemplateAPI	SaveAttributionReportTemplate	Post /api/v2/licenseLegalMetadata/report-template
LicenseOverridesAPI	AddLicenseOverride	Post /api/v2/licenseOverrides/{ownerType}/{ownerId}
LicenseOverridesAPI	DeleteLicenseOverride	Delete /api/v2/licenseOverrides/{ownerType}/{ownerId}/{licenseOverrideId}
LicenseOverridesAPI	GetAppliedLicenseOverrides	Get /api/v2/licenseOverrides/{ownerType}/{ownerId}
LicenseOverridesAPI	GetAppliedLicenseOverridesForLegalReviewer	Get /api/v2/licenseOverrides/{ownerType}/{ownerId}/legalReviewer
OrganizationsAPI	AddOrganization	Post /api/v2/organizations
OrganizationsAPI	DeleteOrganization	Delete /api/v2/organizations/{organizationId}
OrganizationsAPI	GetOrganization	Get /api/v2/organizations/{organizationId}
OrganizationsAPI	GetOrganizations	Get /api/v2/organizations
OrganizationsAPI	MoveOrganization	Put /api/v2/organizations/{organizationId}/move/destination/{destinationId}
PoliciesAPI	GetPolicies	Get /api/v2/policies
PolicyEvaluationAPI	EvaluateComponents	Post /api/v2/evaluation/applications/{applicationId}
PolicyEvaluationAPI	EvaluateSourceControl	Post /api/v2/evaluation/applications/{applicationId}/sourceControlEvaluation
PolicyEvaluationAPI	GetApplicationEvaluationStatus	Get /api/v2/evaluation/applications/{applicationId}/status/{statusId}
PolicyEvaluationAPI	GetComponentEvaluation	Get /api/v2/evaluation/applications/{applicationId}/results/{resultId}
PolicyEvaluationAPI	PromoteScan	Post /api/v2/evaluation/applications/{applicationId}/promoteScan
PolicyViolationDetailsAPI	GetApplicableAutoWaiver	Get /api/v2/policyViolations/{violationId}/applicableAutoWaiver
PolicyViolationDetailsAPI	GetApplicableWaiverRequests	Get /api/v2/policyViolations/{violationId}/applicableWaiverRequests
PolicyViolationDetailsAPI	GetApplicableWaivers	Get /api/v2/policyViolations/{violationId}/applicableWaivers
PolicyViolationDetailsAPI	GetCrossStagePolicyViolationByConstituentId	Get /api/v2/policyViolations/crossStage
PolicyViolationDetailsAPI	GetCrossStagePolicyViolationById	Get /api/v2/policyViolations/crossStage/{violationId}
PolicyViolationDetailsAPI	GetPolicyViolations	Get /api/v2/policyViolations
PolicyViolationDetailsAPI	GetSimilarWaivers	Get /api/v2/policyViolations/{violationId}/similarWaivers
PolicyViolationDetailsAPI	GetTransitivePolicyViolationsByAppScanComponent	Get /api/v2/policyViolations/transitive/{ownerType}/{ownerId}/{scanId}
PolicyViolationDetailsAPI	GetTransitivePolicyViolationsByOwnerStageComponent	Get /api/v2/policyViolations/transitive/{ownerType}/{ownerId}/stages/{stageId}
PolicyWaiverReasonsAPI	GetPolicyWaiverReasons	Get /api/v2/policyWaiverReasons
PolicyWaiverRequestsAPI	AddPolicyWaiverRequestByPolicyViolationId	Post /api/v2/policyWaiverRequests/{ownerType}/{ownerId}/policyViolation/{policyViolationId}
PolicyWaiverRequestsAPI	GetPolicyWaiverRequest	Get /api/v2/policyWaiverRequests/{ownerType}/{ownerId}/{policyWaiverRequestId}
PolicyWaiverRequestsAPI	ReviewPolicyWaiverRequest	Post /api/v2/policyWaiverRequests/{ownerType}/{ownerId}/review/{policyWaiverRequestId}
PolicyWaiverRequestsAPI	UpdatePolicyWaiverRequest	Put /api/v2/policyWaiverRequests/{ownerType}/{ownerId}/{policyWaiverRequestId}
PolicyWaiversAPI	AddBulkPolicyWaivers	Post /api/v2/policyWaivers/{ownerType}/{ownerId}
PolicyWaiversAPI	AddPolicyWaiverByPolicyViolationId	Post /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyViolationId}
PolicyWaiversAPI	AddWaiverToTransitivePolicyViolationsByAppScanComponent	Post /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}
PolicyWaiversAPI	AddWaiverToTransitivePolicyViolationsByOwnerStageComponent	Post /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/stages/{stageId}
PolicyWaiversAPI	DeletePolicyWaiver	Delete /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}
PolicyWaiversAPI	GetPolicyWaiver	Get /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}
PolicyWaiversAPI	GetPolicyWaivers	Get /api/v2/policyWaivers/{ownerType}/{ownerId}
PolicyWaiversAPI	GetTransitivePolicyWaiversByAppScanComponent	Get /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}
PolicyWaiversAPI	RequestPolicyWaiver	Post /api/v2/policyWaivers/waiverRequests/{policyViolationId}
PolicyWaiversAPI	UpdatePolicyWaiver	Put /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}
ProductLicenseAPI	InstallLicense	Post /api/v2/product/license
ProductLicenseAPI	UninstallLicense	Delete /api/v2/product/license
ReportsAPI	GetAll1	Get /api/v2/reports/applications
ReportsAPI	GetByApplicationId	Get /api/v2/reports/applications/{applicationId}
ReportsAPI	GetComponentsInQuarantine	Get /api/v2/reports/components/quarantined
ReportsAPI	GetComponentsWithWaivers	Get /api/v2/reports/components/waivers
ReportsAPI	GetMetrics	Post /api/v2/reports/metrics
ReportsAPI	GetReportHistoryForApplication	Get /api/v2/reports/applications/{applicationId}/history
ReportsAPI	GetStaleWaivers	Get /api/v2/reports/waivers/stale
RepositoriesAPI	GetQuarantinedByPath	Post /api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames
RepositoriesAPI	ReleaseQuarantineWithoutReEval	Post /api/v2/repositories/quarantine/{quarantineId}/release
RoleMembershipsAPI	GetRoleMembershipsApplicationOrOrganization	Get /api/v2/roleMemberships/{ownerType}/{internalOwnerId}
RoleMembershipsAPI	GetRoleMembershipsGlobalOrRepositoryContainer	Get /api/v2/roleMemberships/{ownerType}
RoleMembershipsAPI	GrantRoleMembershipApplicationOrOrganization	Put /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}
RoleMembershipsAPI	GrantRoleMembershipGlobalOrRepositoryContainer	Put /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}
RoleMembershipsAPI	RevokeRoleMembershipApplicationOrOrganization	Delete /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}
RoleMembershipsAPI	RevokeRoleMembershipGlobalOrRepositoryContainer	Delete /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}
RolesAPI	GetRoles	Get /api/v2/roles
SBOMAPI	DeleteSbomVersion	Delete /api/v2/sbom/applications/{applicationId}/versions/{version}	Delete sbom version
SBOMAPI	DeleteVulnerabilityAnalysis	Delete /api/v2/sbom/applications/{applicationId}/versions/{version}/vulnerability/{refId}/analysis	Deletes a Vulnerability analysis for a given component.
SBOMAPI	GetActiveSbomVersionListByApplication	Get /api/v2/sbom/applications/{applicationId}/versions	Gets a list of active sbom versions by application id
SBOMAPI	GetImportStatus	Get /api/v2/sbom/applications/{applicationId}/status/{importRequestId}	Get sbom import status
SBOMAPI	GetSbomComponents	Get /api/v2/sbom/applications/{applicationId}/versions/{version}/components	Gets the components found in a specific sbom version
SBOMAPI	GetSbomMetadataSummaryForApplication	Get /api/v2/sbom/applications/{applicationId}	Gets a paginated list of SBOMs for an application
SBOMAPI	GetSbomVersion	Get /api/v2/sbom/applications/{applicationId}/versions/{version}	Gets a sbom version
SBOMAPI	GetVulnerabilityDetails	Get /api/v2/sbom/applications/{applicationId}/versions/{version}/vulnerability/{refId}
SBOMAPI	ImportSbom	Post /api/v2/sbom/import	Import a new sbom version
SBOMAPI	SaveVulnerabilityAnalysis	Put /api/v2/sbom/applications/{applicationId}/versions/{version}/vulnerability/{refId}/analysis	Updates a vulnerability analysis annotation for a specific SBOM vulnerability
SPDXAPI	GetByScanId	Get /api/v2/spdx/{applicationId}/reports/{scanId}
SPDXAPI	GetLatestForStage	Get /api/v2/spdx/{applicationId}/stages/{stageId}
SecurityVulnerabilityOverridesAPI	GetSecurityVulnerabilityOverrides	Get /api/v2/securityOverrides
SolutionsAPI	GetLicensedSolutions	Get /api/v2/solutions/licensed
SourceControlAPI	AddSourceControl	Post /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlAPI	AddUserMappings	Post /api/v2/sourceControl/automaticRoleAssignment/userMappings/{organizationId}
SourceControlAPI	AutomaticRoleAssignment	Post /api/v2/sourceControl/automaticRoleAssignment/{publicId}
SourceControlAPI	DeleteSourceControl	Delete /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlAPI	DeleteUserMappings	Delete /api/v2/sourceControl/automaticRoleAssignment/userMappings/{organizationId}
SourceControlAPI	GetSourceControl1	Get /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlAPI	GetUserMappingsByOwner	Get /api/v2/sourceControl/automaticRoleAssignment/userMappings/{ownerType}/{internalOwnerId}
SourceControlAPI	UpdateSourceControl	Put /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlMetricsAPI	GetSourceControl	Get /api/v2/sourceControlMetrics/{ownerType}/{internalOwnerId}
ThirdPartyAnalysisAPI	GetScanStatus	Get /api/v2/scan/applications/{applicationId}/status/{scanRequestId}
ThirdPartyAnalysisAPI	ScanComponents	Post /api/v2/scan/applications/{applicationId}/sources/{source}
UserTokensAPI	CreateUserToken	Post /api/v2/userTokens/currentUser
UserTokensAPI	DeleteCurrentUserToken	Delete /api/v2/userTokens/currentUser
UserTokensAPI	DeleteUserTokenByUserCode	Delete /api/v2/userTokens/userCode/{userCode}
UserTokensAPI	GetUserTokenByUsernameAndRealmId	Get /api/v2/userTokens/{username}
UserTokensAPI	GetUserTokenExistsForCurrentUser	Get /api/v2/userTokens/currentUser/hasToken
UserTokensAPI	GetUserTokensByCreatedBetweenAndRealmId	Get /api/v2/userTokens
UserTokensAPI	PurgeUserTokens	Delete /api/v2/userTokens/purge
UsersAPI	Add	Post /api/v2/users
UsersAPI	Delete1	Delete /api/v2/users/{username}
UsersAPI	Get1	Get /api/v2/users/{username}
UsersAPI	GetAll2	Get /api/v2/users
UsersAPI	Update	Put /api/v2/users/{username}
VulnerabilityDetailsAPI	GetSecurityVulnerabilityDetails	Post /api/v2/vulnerabilities
VulnerabilityDetailsAPI	GetSecurityVulnerabilityDetails1	Get /api/v2/vulnerabilities/{refId}

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BasicAuth

Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sonatypeiq.ContextBasicAuth, sonatypeiq.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Name		Name	Last commit message	Last commit date
Latest commit History 35 Commits
.github		.github
api		api
docs		docs
test		test
GIT_VERSION		GIT_VERSION
LICENSE		LICENSE
README.md		README.md
api_advanced_search.go		api_advanced_search.go
api_application_categories.go		api_application_categories.go
api_application_report_data.go		api_application_report_data.go
api_applications.go		api_applications.go
api_audit_logs.go		api_audit_logs.go
api_auto_policy_waiver_exclusions.go		api_auto_policy_waiver_exclusions.go
api_auto_policy_waivers.go		api_auto_policy_waivers.go
api_claim_components.go		api_claim_components.go
api_component_labels.go		api_component_labels.go
api_component_search.go		api_component_search.go
api_components.go		api_components.go
api_composite_source_control.go		api_composite_source_control.go
api_composite_source_control_validator.go		api_composite_source_control_validator.go
api_config_crowd.go		api_config_crowd.go
api_config_jira.go		api_config_jira.go
api_config_mail.go		api_config_mail.go
api_config_proxy_server.go		api_config_proxy_server.go
api_config_reverse_proxy_authentication.go		api_config_reverse_proxy_authentication.go
api_config_saml.go		api_config_saml.go
api_config_source_control.go		api_config_source_control.go
api_config_zscaler.go		api_config_zscaler.go
api_configuration.go		api_configuration.go
api_configure_artifactory_connection.go		api_configure_artifactory_connection.go
api_cpe_matching_configuration.go		api_cpe_matching_configuration.go
api_cyclone_dx.go		api_cyclone_dx.go
api_data_retention_policies.go		api_data_retention_policies.go
api_developer_priorities.go		api_developer_priorities.go
api_endpoints.go		api_endpoints.go
api_feature_configuration.go		api_feature_configuration.go
api_firewall.go		api_firewall.go
api_license_legal_metadata_report.go		api_license_legal_metadata_report.go
api_license_legal_metadata_template.go		api_license_legal_metadata_template.go
api_license_overrides.go		api_license_overrides.go
api_organizations.go		api_organizations.go
api_policies.go		api_policies.go
api_policy_evaluation.go		api_policy_evaluation.go
api_policy_violation_details.go		api_policy_violation_details.go
api_policy_waiver_reasons.go		api_policy_waiver_reasons.go
api_policy_waiver_requests.go		api_policy_waiver_requests.go
api_policy_waivers.go		api_policy_waivers.go
api_product_license.go		api_product_license.go
api_reports.go		api_reports.go
api_repositories.go		api_repositories.go
api_role_memberships.go		api_role_memberships.go
api_roles.go		api_roles.go
api_sbom.go		api_sbom.go
api_security_vulnerability_overrides.go		api_security_vulnerability_overrides.go
api_solutions.go		api_solutions.go
api_source_control.go		api_source_control.go
api_source_control_metrics.go		api_source_control_metrics.go
api_spdx.go		api_spdx.go
api_third_party_analysis.go		api_third_party_analysis.go
api_user_tokens.go		api_user_tokens.go
api_users.go		api_users.go
api_vulnerability_details.go		api_vulnerability_details.go
client.go		client.go
configuration.go		configuration.go
git_push.sh		git_push.sh
go.mod		go.mod
go.sum		go.sum
model_action.go		model_action.go
model_api_application_base_dto.go		model_api_application_base_dto.go
model_api_application_categories_dto.go		model_api_application_categories_dto.go
model_api_application_categories_list_dto.go		model_api_application_categories_list_dto.go
model_api_application_category_dto.go		model_api_application_category_dto.go
model_api_application_dto.go		model_api_application_dto.go
model_api_application_evaluation_commit_dto.go		model_api_application_evaluation_commit_dto.go
model_api_application_evaluation_result_dtov2.go		model_api_application_evaluation_result_dtov2.go
model_api_application_evaluation_status_dtov2.go		model_api_application_evaluation_status_dtov2.go
model_api_application_list_dto.go		model_api_application_list_dto.go
model_api_application_report_dtov2.go		model_api_application_report_dtov2.go
model_api_application_tag_dto.go		model_api_application_tag_dto.go
model_api_application_violation_dtov2.go		model_api_application_violation_dtov2.go
model_api_application_violation_list_dtov2.go		model_api_application_violation_list_dtov2.go
model_api_application_waiver_dto.go		model_api_application_waiver_dto.go
model_api_applied_license_overrides_dto.go		model_api_applied_license_overrides_dto.go
model_api_artifactory_connection_dto.go		model_api_artifactory_connection_dto.go
model_api_artifactory_connection_status_request_dto.go		model_api_artifactory_connection_status_request_dto.go
model_api_artifactory_connection_status_response_dto.go		model_api_artifactory_connection_status_response_dto.go
model_api_auto_policy_waiver_dto.go		model_api_auto_policy_waiver_dto.go
model_api_auto_policy_waiver_exclusion_request_dto.go		model_api_auto_policy_waiver_exclusion_request_dto.go
model_api_auto_policy_waiver_exclusion_response_dto.go		model_api_auto_policy_waiver_exclusion_response_dto.go
model_api_auto_policy_waiver_status_dto.go		model_api_auto_policy_waiver_status_dto.go
model_api_bulk_waivers_dto.go		model_api_bulk_waivers_dto.go
model_api_component_change_action_dto.go		model_api_component_change_action_dto.go
model_api_component_details_dtov2.go		model_api_component_details_dtov2.go
model_api_component_details_request_dtov2.go		model_api_component_details_request_dtov2.go
model_api_component_details_result_dtov2.go		model_api_component_details_result_dtov2.go
model_api_component_dtov2.go		model_api_component_dtov2.go
model_api_component_evaluation_request_dtov2.go		model_api_component_evaluation_request_dtov2.go
model_api_component_evaluation_result_dtov2.go		model_api_component_evaluation_result_dtov2.go
model_api_component_evaluation_ticket_dtov2.go		model_api_component_evaluation_ticket_dtov2.go
model_api_component_identifier_dtov2.go		model_api_component_identifier_dtov2.go

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

Go API client for sonatypeiq

Overview

Installation

Configuration of Server URL

Select Server Configuration

Templated Server URL

URLs Configuration per Operation

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

BasicAuth

Documentation for Utility Methods

Author

About

Uh oh!

Releases

Uh oh!

Languages

License

sonatype-nexus-community/nexus-iq-api-client-go

Folders and files

Latest commit

History

Repository files navigation

Go API client for sonatypeiq

Overview

Installation

Configuration of Server URL

Select Server Configuration

Templated Server URL

URLs Configuration per Operation

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

BasicAuth

Documentation for Utility Methods

Author

About

Topics

Resources

License

Code of conduct

Security policy

Uh oh!

Stars

Watchers

Forks

Releases

Uh oh!

Languages