Skip to content

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

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.184.0-01
  • Package version: 1.0.0
  • Generator version: 7.10.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
AutoPolicyWaiverRevocationsAPI AddAutoPolicyWaiverRevocation Post /api/v2/autoPolicyWaiverRevocations/{ownerType}/{ownerId}
AutoPolicyWaiverRevocationsAPI DeleteAutoPolicyWaiverRevocation Delete /api/v2/autoPolicyWaiverRevocations/{ownerType}/{ownerId}/{autoPolicyWaiverRevocationId}
AutoPolicyWaiversAPI AddAutoPolicyWaiver Post /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}
AutoPolicyWaiversAPI DeleteAutoPolicyWaiver Delete /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/{autoPolicyWaiverId}
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}
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
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}
ConfigArtifactoryConnectionAPI AddArtifactoryConnection Post /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
ConfigArtifactoryConnectionAPI DeleteArtifactoryConnection Delete /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
ConfigArtifactoryConnectionAPI GetArtifactoryConnection Get /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
ConfigArtifactoryConnectionAPI GetOwnerArtifactoryConnection Get /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
ConfigArtifactoryConnectionAPI TestArtifactoryConnection Post /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/test
ConfigArtifactoryConnectionAPI TestArtifactoryConnection1 Post /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}/test
ConfigArtifactoryConnectionAPI UpdateArtifactoryConnection Put /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
ConfigArtifactoryConnectionAPI UpdateOwnerArtifactoryConnectionStatus Put /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
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
ConfigSourceControlAPI DeleteConfiguration5 Delete /api/v2/config/sourceControl
ConfigSourceControlAPI GetConfiguration5 Get /api/v2/config/sourceControl
ConfigSourceControlAPI SetConfiguration5 Put /api/v2/config/sourceControl
ConfigurationAPI DeleteConfiguration Delete /api/v2/config
ConfigurationAPI GetConfiguration Get /api/v2/config
ConfigurationAPI SetConfiguration Put /api/v2/config
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 AddRepositoryManager Post /api/v2/firewall/repositoryManagers
FirewallAPI ConfigureRepositories Post /api/v2/firewall/repositories/configuration/{repositoryManagerId}
FirewallAPI DeleteRepositoryManager Delete /api/v2/firewall/repositoryManagers/{repositoryManagerId}
FirewallAPI EvaluateComponents1 Post /api/v2/firewall/components/{repositoryManagerId}/{repositoryId}/evaluate
FirewallAPI GetConfiguredRepositories Get /api/v2/firewall/repositories/configuration/{repositoryManagerId}
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 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 SetFirewallAutoUnquarantineConfig Put /api/v2/firewall/releaseQuarantine/configuration
FirewallAPI SetQuarantinedComponentViewAnonymousAccess Put /api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess/{enabled}
LabelsAPI AddLabel Post /api/v2/labels/{ownerType}/{ownerId}
LabelsAPI DeleteLabel Delete /api/v2/labels/{ownerType}/{ownerId}/{labelId}
LabelsAPI GetApplicableContexts Get /api/v2/labels/{ownerType}/{ownerId}/applicable/context/{labelId}
LabelsAPI GetApplicableLabels Get /api/v2/labels/{ownerType}/{ownerId}/applicable
LabelsAPI GetLabels Get /api/v2/labels/{ownerType}/{ownerId}
LabelsAPI UpdateLabel Put /api/v2/labels/{ownerType}/{ownerId}
LicenseLegalMetadataAPI DeleteAttributionReportTemplate Delete /api/v2/licenseLegalMetadata/report-template/{id}
LicenseLegalMetadataAPI GetAllAttributionReportTemplates Get /api/v2/licenseLegalMetadata/report-template
LicenseLegalMetadataAPI GetAttributionReportTemplateById Get /api/v2/licenseLegalMetadata/report-template/{id}
LicenseLegalMetadataAPI GetLicenseLegalApplicationHTMLReport Get /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report
LicenseLegalMetadataAPI GetLicenseLegalApplicationReport Get /api/v2/licenseLegalMetadata/application/{applicationId}
LicenseLegalMetadataAPI GetLicenseLegalApplicationReport1 Get /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}
LicenseLegalMetadataAPI GetLicenseLegalComponentReport Get /api/v2/licenseLegalMetadata/{ownerType}/{ownerId}/component
LicenseLegalMetadataAPI GetLicenseLegalCustomApplicationHTMLReport Post /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report
LicenseLegalMetadataAPI GetLicenseLegalCustomApplicationHTMLReport1 Post /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report/templateId/{templateId}
LicenseLegalMetadataAPI GetLicenseLegalCustomMultiApplicationHTMLReport1 Post /api/v2/licenseLegalMetadata/multiApplication/report/templateId/{templateId}
LicenseLegalMetadataAPI GetLicenseLegalMultiApplicationHTMLReport Post /api/v2/licenseLegalMetadata/multiApplication/report
LicenseLegalMetadataAPI GetLicenseLegalMultiApplicationReportFromActiveUserFilter Post /api/v2/licenseLegalMetadata/multiApplication/activeUserFilter/report/templateId/{templateId}
LicenseLegalMetadataAPI SaveAttributionReportTemplate Post /api/v2/licenseLegalMetadata/report-template
MalwareAPI EvaluateMalware Post /api/v2/malware/defense/evaluate
MalwareAPI GetMalwareDefenseMetrics Get /api/v2/malware/defense/metrics
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 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
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}
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 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
ScanAPI GetIdeUsersOverview Get /api/v2/scan/applications/ideUser/overview
ScanAPI GetScanStatus Get /api/v2/scan/applications/{applicationId}/status/{scanRequestId}
ScanAPI ScanComponents Post /api/v2/scan/applications/{applicationId}/sources/{source}
SearchAPI SearchComponent Get /api/v2/search/component
SecurityOverridesAPI GetSecurityVulnerabilityOverrides Get /api/v2/securityOverrides
SolutionsAPI GetLicensedSolutions Get /api/v2/solutions/licensed
SourceControlAPI AddSourceControl Post /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlAPI AutomaticRoleAssignment Post /api/v2/sourceControl/automaticRoleAssignment/{publicId}
SourceControlAPI DeleteSourceControl Delete /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlAPI GetSourceControl1 Get /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlAPI UpdateSourceControl Put /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlMetricsAPI GetSourceControl Get /api/v2/sourceControlMetrics/{ownerType}/{internalOwnerId}
SpdxAPI GetByScanId Get /api/v2/spdx/{applicationId}/reports/{scanId}
SpdxAPI GetLatestForStage Get /api/v2/spdx/{applicationId}/stages/{stageId}
TelemetryAPI PostExternalTelemetry Post /api/v2/telemetry
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}
VulnerabilitiesAPI GetSecurityVulnerabilityDetails 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

Author

About

Generated API Client in Go for Sonatype IQ Server

Topics

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Languages