Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/sonatype-nexus-community/nexus-iq-api-client-go

Generated API Client in Go for Sonatype IQ Server
https://github.com/sonatype-nexus-community/nexus-iq-api-client-go
go-library sonatype sonatype-iq
Last synced: about 2 months ago
JSON representation
Generated API Client in Go for Sonatype IQ Server
Host: GitHub
URL: https://github.com/sonatype-nexus-community/nexus-iq-api-client-go
Owner: sonatype-nexus-community
Created: 2023-07-18T07:54:22.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-11-20T17:32:25.000Z (2 months ago)
Last Synced: 2024-11-20T18:33:17.344Z (2 months ago)
Topics: go-library, sonatype, sonatype-iq
Language: Shell
Homepage:
Size: 1.67 MB
Stars: 1
Watchers: 7
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
- Security: docs/SecurityOverridesAPI.md
Awesome Lists containing this project

README

        # 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](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) 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:

```sh

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:

```go

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

```

To use a proxy, set the environment variable `HTTP_PROXY`:

```go

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`.

```go

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`.

```go

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.

```go

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**](docs/AdvancedSearchAPI.md#createsearchindexasync) | **Post** /api/v2/search/advanced/index | 

*AdvancedSearchAPI* | [**GetExportResults**](docs/AdvancedSearchAPI.md#getexportresults) | **Get** /api/v2/search/advanced/export/csv | 

*AdvancedSearchAPI* | [**SearchIndex**](docs/AdvancedSearchAPI.md#searchindex) | **Get** /api/v2/search/advanced | 

*ApplicationCategoriesAPI* | [**AddTag**](docs/ApplicationCategoriesAPI.md#addtag) | **Post** /api/v2/applicationCategories/organization/{organizationId} | 

*ApplicationCategoriesAPI* | [**DeleteTag**](docs/ApplicationCategoriesAPI.md#deletetag) | **Delete** /api/v2/applicationCategories/organization/{organizationId}/{tagId} | 

*ApplicationCategoriesAPI* | [**GetApplicableTags**](docs/ApplicationCategoriesAPI.md#getapplicabletags) | **Get** /api/v2/applicationCategories/organization/{organizationId}/applicable | 

*ApplicationCategoriesAPI* | [**GetApplicableTagsByApplicationPublicId**](docs/ApplicationCategoriesAPI.md#getapplicabletagsbyapplicationpublicid) | **Get** /api/v2/applicationCategories/application/{applicationPublicId}/applicable | 

*ApplicationCategoriesAPI* | [**GetApplicationApplicableTags**](docs/ApplicationCategoriesAPI.md#getapplicationapplicabletags) | **Get** /api/v2/applicationCategories/application/{applicationPublicId} | 

*ApplicationCategoriesAPI* | [**GetAppliedPolicyTags**](docs/ApplicationCategoriesAPI.md#getappliedpolicytags) | **Get** /api/v2/applicationCategories/organization/{organizationId}/policy | 

*ApplicationCategoriesAPI* | [**GetAppliedTags**](docs/ApplicationCategoriesAPI.md#getappliedtags) | **Get** /api/v2/applicationCategories/organization/{organizationId}/applied | 

*ApplicationCategoriesAPI* | [**GetTags**](docs/ApplicationCategoriesAPI.md#gettags) | **Get** /api/v2/applicationCategories/organization/{organizationId} | 

*ApplicationCategoriesAPI* | [**GetTagsUsedByApplications**](docs/ApplicationCategoriesAPI.md#gettagsusedbyapplications) | **Get** /api/v2/applicationCategories/application | 

*ApplicationCategoriesAPI* | [**UpdateTag**](docs/ApplicationCategoriesAPI.md#updatetag) | **Put** /api/v2/applicationCategories/organization/{organizationId} | 

*ApplicationReportDataAPI* | [**GetData**](docs/ApplicationReportDataAPI.md#getdata) | **Get** /api/v2/applications/{applicationPublicId}/reports/{scanId} | 

*ApplicationReportDataAPI* | [**GetDependencyTree**](docs/ApplicationReportDataAPI.md#getdependencytree) | **Get** /api/v2/applications/{applicationPublicId}/reports/{scanId}/dependencyTree | 

*ApplicationReportDataAPI* | [**GetPolicyViolationDiff**](docs/ApplicationReportDataAPI.md#getpolicyviolationdiff) | **Get** /api/v2/applications/{applicationPublicId}/reports/policyViolations/diff | 

*ApplicationReportDataAPI* | [**GetPolicyViolations1**](docs/ApplicationReportDataAPI.md#getpolicyviolations1) | **Get** /api/v2/applications/{applicationPublicId}/reports/{scanId}/policy | 

*ApplicationReportDataAPI* | [**GetRawData**](docs/ApplicationReportDataAPI.md#getrawdata) | **Get** /api/v2/applications/{applicationPublicId}/reports/{scanId}/raw | 

*ApplicationsAPI* | [**AddApplication**](docs/ApplicationsAPI.md#addapplication) | **Post** /api/v2/applications | 

*ApplicationsAPI* | [**CloneApplication**](docs/ApplicationsAPI.md#cloneapplication) | **Post** /api/v2/applications/{sourceApplicationId}/clone | 

*ApplicationsAPI* | [**DeleteApplication**](docs/ApplicationsAPI.md#deleteapplication) | **Delete** /api/v2/applications/{applicationId} | 

*ApplicationsAPI* | [**GetApplication**](docs/ApplicationsAPI.md#getapplication) | **Get** /api/v2/applications/{applicationId} | 

*ApplicationsAPI* | [**GetApplications**](docs/ApplicationsAPI.md#getapplications) | **Get** /api/v2/applications | 

*ApplicationsAPI* | [**GetApplicationsByOrganizationId**](docs/ApplicationsAPI.md#getapplicationsbyorganizationid) | **Get** /api/v2/applications/organization/{organizationId} | 

*ApplicationsAPI* | [**MoveApplication**](docs/ApplicationsAPI.md#moveapplication) | **Post** /api/v2/applications/{applicationId}/move/organization/{organizationId} | 

*ApplicationsAPI* | [**UpdateApplication**](docs/ApplicationsAPI.md#updateapplication) | **Put** /api/v2/applications/{applicationId} | 

*AuditLogsAPI* | [**GetAuditLogs**](docs/AuditLogsAPI.md#getauditlogs) | **Get** /api/v2/auditLogs | 

*AutoPolicyWaiverRevocationsAPI* | [**AddAutoPolicyWaiverRevocation**](docs/AutoPolicyWaiverRevocationsAPI.md#addautopolicywaiverrevocation) | **Post** /api/v2/autoPolicyWaiverRevocations/{ownerType}/{ownerId} | 

*AutoPolicyWaiverRevocationsAPI* | [**DeleteAutoPolicyWaiverRevocation**](docs/AutoPolicyWaiverRevocationsAPI.md#deleteautopolicywaiverrevocation) | **Delete** /api/v2/autoPolicyWaiverRevocations/{ownerType}/{ownerId}/{autoPolicyWaiverRevocationId} | 

*AutoPolicyWaiversAPI* | [**AddAutoPolicyWaiver**](docs/AutoPolicyWaiversAPI.md#addautopolicywaiver) | **Post** /api/v2/autoPolicyWaivers/{ownerType}/{ownerId} | 

*AutoPolicyWaiversAPI* | [**DeleteAutoPolicyWaiver**](docs/AutoPolicyWaiversAPI.md#deleteautopolicywaiver) | **Delete** /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/{autoPolicyWaiverId} | 

*AutoPolicyWaiversAPI* | [**GetAutoPolicyWaiver**](docs/AutoPolicyWaiversAPI.md#getautopolicywaiver) | **Get** /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/{autoPolicyWaiverId} | 

*AutoPolicyWaiversAPI* | [**GetAutoPolicyWaiverStatus**](docs/AutoPolicyWaiversAPI.md#getautopolicywaiverstatus) | **Get** /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/status | 

*AutoPolicyWaiversAPI* | [**GetAutoPolicyWaivers**](docs/AutoPolicyWaiversAPI.md#getautopolicywaivers) | **Get** /api/v2/autoPolicyWaivers/{ownerType}/{ownerId} | 

*AutoPolicyWaiversAPI* | [**UpdateAutoPolicyWaiver**](docs/AutoPolicyWaiversAPI.md#updateautopolicywaiver) | **Put** /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/{autoPolicyWaiverId} | 

*ClaimComponentsAPI* | [**Delete**](docs/ClaimComponentsAPI.md#delete) | **Delete** /api/v2/claim/components/{hash} | 

*ClaimComponentsAPI* | [**Get**](docs/ClaimComponentsAPI.md#get) | **Get** /api/v2/claim/components/{hash} | 

*ClaimComponentsAPI* | [**GetAll**](docs/ClaimComponentsAPI.md#getall) | **Get** /api/v2/claim/components | 

*ClaimComponentsAPI* | [**Set**](docs/ClaimComponentsAPI.md#set) | **Post** /api/v2/claim/components | 

*ComponentsAPI* | [**DeleteComponentLabel**](docs/ComponentsAPI.md#deletecomponentlabel) | **Delete** /api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId} | 

*ComponentsAPI* | [**GetComponentDetails**](docs/ComponentsAPI.md#getcomponentdetails) | **Post** /api/v2/components/details | 

*ComponentsAPI* | [**GetComponentVersions**](docs/ComponentsAPI.md#getcomponentversions) | **Post** /api/v2/components/versions | 

*ComponentsAPI* | [**GetSuggestedRemediationForComponent**](docs/ComponentsAPI.md#getsuggestedremediationforcomponent) | **Post** /api/v2/components/remediation/{ownerType}/{ownerId} | 

*ComponentsAPI* | [**SetComponentLabel**](docs/ComponentsAPI.md#setcomponentlabel) | **Post** /api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId} | 

*CompositeSourceControlAPI* | [**GetCompositeSourceControlByOwner**](docs/CompositeSourceControlAPI.md#getcompositesourcecontrolbyowner) | **Get** /api/v2/compositeSourceControl/{ownerType}/{internalOwnerId} | 

*CompositeSourceControlValidatorAPI* | [**ValidateSourceControlConfig**](docs/CompositeSourceControlValidatorAPI.md#validatesourcecontrolconfig) | **Get** /api/v2/compositeSourceControlConfigValidator/application/{applicationId} | 

*ConfigArtifactoryConnectionAPI* | [**AddArtifactoryConnection**](docs/ConfigArtifactoryConnectionAPI.md#addartifactoryconnection) | **Post** /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId} | 

*ConfigArtifactoryConnectionAPI* | [**DeleteArtifactoryConnection**](docs/ConfigArtifactoryConnectionAPI.md#deleteartifactoryconnection) | **Delete** /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId} | 

*ConfigArtifactoryConnectionAPI* | [**GetArtifactoryConnection**](docs/ConfigArtifactoryConnectionAPI.md#getartifactoryconnection) | **Get** /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId} | 

*ConfigArtifactoryConnectionAPI* | [**GetOwnerArtifactoryConnection**](docs/ConfigArtifactoryConnectionAPI.md#getownerartifactoryconnection) | **Get** /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId} | 

*ConfigArtifactoryConnectionAPI* | [**TestArtifactoryConnection**](docs/ConfigArtifactoryConnectionAPI.md#testartifactoryconnection) | **Post** /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/test | 

*ConfigArtifactoryConnectionAPI* | [**TestArtifactoryConnection1**](docs/ConfigArtifactoryConnectionAPI.md#testartifactoryconnection1) | **Post** /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}/test | 

*ConfigArtifactoryConnectionAPI* | [**UpdateArtifactoryConnection**](docs/ConfigArtifactoryConnectionAPI.md#updateartifactoryconnection) | **Put** /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId} | 

*ConfigArtifactoryConnectionAPI* | [**UpdateOwnerArtifactoryConnectionStatus**](docs/ConfigArtifactoryConnectionAPI.md#updateownerartifactoryconnectionstatus) | **Put** /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId} | 

*ConfigCrowdAPI* | [**DeleteCrowdConfiguration**](docs/ConfigCrowdAPI.md#deletecrowdconfiguration) | **Delete** /api/v2/config/crowd | 

*ConfigCrowdAPI* | [**GetCrowdConfiguration**](docs/ConfigCrowdAPI.md#getcrowdconfiguration) | **Get** /api/v2/config/crowd | 

*ConfigCrowdAPI* | [**InsertOrUpdateCrowdConfiguration**](docs/ConfigCrowdAPI.md#insertorupdatecrowdconfiguration) | **Put** /api/v2/config/crowd | 

*ConfigCrowdAPI* | [**TestCrowdConfiguration**](docs/ConfigCrowdAPI.md#testcrowdconfiguration) | **Post** /api/v2/config/crowd/test | 

*ConfigJIRAAPI* | [**DeleteConfiguration1**](docs/ConfigJIRAAPI.md#deleteconfiguration1) | **Delete** /api/v2/config/jira | 

*ConfigJIRAAPI* | [**GetConfiguration1**](docs/ConfigJIRAAPI.md#getconfiguration1) | **Get** /api/v2/config/jira | 

*ConfigJIRAAPI* | [**SetConfiguration1**](docs/ConfigJIRAAPI.md#setconfiguration1) | **Put** /api/v2/config/jira | 

*ConfigMailAPI* | [**DeleteConfiguration2**](docs/ConfigMailAPI.md#deleteconfiguration2) | **Delete** /api/v2/config/mail | 

*ConfigMailAPI* | [**GetConfiguration2**](docs/ConfigMailAPI.md#getconfiguration2) | **Get** /api/v2/config/mail | 

*ConfigMailAPI* | [**SetConfiguration2**](docs/ConfigMailAPI.md#setconfiguration2) | **Put** /api/v2/config/mail | 

*ConfigMailAPI* | [**TestConfiguration**](docs/ConfigMailAPI.md#testconfiguration) | **Post** /api/v2/config/mail/test/{recipientEmail} | 

*ConfigProxyServerAPI* | [**DeleteConfiguration3**](docs/ConfigProxyServerAPI.md#deleteconfiguration3) | **Delete** /api/v2/config/httpProxyServer | 

*ConfigProxyServerAPI* | [**GetConfiguration3**](docs/ConfigProxyServerAPI.md#getconfiguration3) | **Get** /api/v2/config/httpProxyServer | 

*ConfigProxyServerAPI* | [**SetConfiguration3**](docs/ConfigProxyServerAPI.md#setconfiguration3) | **Put** /api/v2/config/httpProxyServer | 

*ConfigReverseProxyAuthenticationAPI* | [**DeleteConfiguration4**](docs/ConfigReverseProxyAuthenticationAPI.md#deleteconfiguration4) | **Delete** /api/v2/config/reverseProxyAuthentication | 

*ConfigReverseProxyAuthenticationAPI* | [**GetConfiguration4**](docs/ConfigReverseProxyAuthenticationAPI.md#getconfiguration4) | **Get** /api/v2/config/reverseProxyAuthentication | 

*ConfigReverseProxyAuthenticationAPI* | [**SetConfiguration4**](docs/ConfigReverseProxyAuthenticationAPI.md#setconfiguration4) | **Put** /api/v2/config/reverseProxyAuthentication | 

*ConfigSAMLAPI* | [**DeleteSamlConfiguration**](docs/ConfigSAMLAPI.md#deletesamlconfiguration) | **Delete** /api/v2/config/saml | 

*ConfigSAMLAPI* | [**GetMetadata**](docs/ConfigSAMLAPI.md#getmetadata) | **Get** /api/v2/config/saml/metadata | 

*ConfigSAMLAPI* | [**GetSamlConfiguration**](docs/ConfigSAMLAPI.md#getsamlconfiguration) | **Get** /api/v2/config/saml | 

*ConfigSourceControlAPI* | [**DeleteConfiguration5**](docs/ConfigSourceControlAPI.md#deleteconfiguration5) | **Delete** /api/v2/config/sourceControl | 

*ConfigSourceControlAPI* | [**GetConfiguration5**](docs/ConfigSourceControlAPI.md#getconfiguration5) | **Get** /api/v2/config/sourceControl | 

*ConfigSourceControlAPI* | [**SetConfiguration5**](docs/ConfigSourceControlAPI.md#setconfiguration5) | **Put** /api/v2/config/sourceControl | 

*ConfigurationAPI* | [**DeleteConfiguration**](docs/ConfigurationAPI.md#deleteconfiguration) | **Delete** /api/v2/config | 

*ConfigurationAPI* | [**GetConfiguration**](docs/ConfigurationAPI.md#getconfiguration) | **Get** /api/v2/config | 

*ConfigurationAPI* | [**SetConfiguration**](docs/ConfigurationAPI.md#setconfiguration) | **Put** /api/v2/config | 

*CycloneDXAPI* | [**GetByReportId**](docs/CycloneDXAPI.md#getbyreportid) | **Get** /api/v2/cycloneDx/{cdxVersion}/{applicationId}/reports/{reportId} | 

*CycloneDXAPI* | [**GetLatest**](docs/CycloneDXAPI.md#getlatest) | **Get** /api/v2/cycloneDx/{cdxVersion}/{applicationId}/stages/{stageId} | 

*DataRetentionPoliciesAPI* | [**GetDataRetentionPolicies**](docs/DataRetentionPoliciesAPI.md#getdataretentionpolicies) | **Get** /api/v2/dataRetentionPolicies/organizations/{organizationId} | 

*DataRetentionPoliciesAPI* | [**GetParentDataRetentionPolicies**](docs/DataRetentionPoliciesAPI.md#getparentdataretentionpolicies) | **Get** /api/v2/dataRetentionPolicies/organizations/{organizationId}/parent | 

*DataRetentionPoliciesAPI* | [**SetDataRetentionPolicies**](docs/DataRetentionPoliciesAPI.md#setdataretentionpolicies) | **Put** /api/v2/dataRetentionPolicies/organizations/{organizationId} | 

*DeveloperPrioritiesAPI* | [**GetPriorities**](docs/DeveloperPrioritiesAPI.md#getpriorities) | **Get** /api/v2/developer/priorities/{applicationId}/{scanId} | 

*DeveloperPrioritiesAPI* | [**GetPrioritiesExport**](docs/DeveloperPrioritiesAPI.md#getprioritiesexport) | **Get** /api/v2/developer/priorities/{applicationId}/{scanId}/export | 

*EndpointsAPI* | [**GetOpenAPI**](docs/EndpointsAPI.md#getopenapi) | **Get** /api/v2/endpoints/{apiType} | 

*FeatureConfigurationAPI* | [**DisableFeature**](docs/FeatureConfigurationAPI.md#disablefeature) | **Delete** /api/v2/config/features/{feature} | 

*FeatureConfigurationAPI* | [**EnabledFeature**](docs/FeatureConfigurationAPI.md#enabledfeature) | **Post** /api/v2/config/features/{feature} | 

*FirewallAPI* | [**AddRepositoryManager**](docs/FirewallAPI.md#addrepositorymanager) | **Post** /api/v2/firewall/repositoryManagers | 

*FirewallAPI* | [**ConfigureRepositories**](docs/FirewallAPI.md#configurerepositories) | **Post** /api/v2/firewall/repositories/configuration/{repositoryManagerId} | 

*FirewallAPI* | [**DeleteRepositoryManager**](docs/FirewallAPI.md#deleterepositorymanager) | **Delete** /api/v2/firewall/repositoryManagers/{repositoryManagerId} | 

*FirewallAPI* | [**EvaluateComponents1**](docs/FirewallAPI.md#evaluatecomponents1) | **Post** /api/v2/firewall/components/{repositoryManagerId}/{repositoryId}/evaluate | 

*FirewallAPI* | [**GetConfiguredRepositories**](docs/FirewallAPI.md#getconfiguredrepositories) | **Get** /api/v2/firewall/repositories/configuration/{repositoryManagerId} | 

*FirewallAPI* | [**GetFirewallAutoUnquarantineConfig**](docs/FirewallAPI.md#getfirewallautounquarantineconfig) | **Get** /api/v2/firewall/releaseQuarantine/configuration | 

*FirewallAPI* | [**GetFirewallMetrics**](docs/FirewallAPI.md#getfirewallmetrics) | **Get** /api/v2/firewall/metrics/embedded | 

*FirewallAPI* | [**GetFirewallUnquarantineSummary**](docs/FirewallAPI.md#getfirewallunquarantinesummary) | **Get** /api/v2/firewall/releaseQuarantine/summary | 

*FirewallAPI* | [**GetQuarantineList**](docs/FirewallAPI.md#getquarantinelist) | **Get** /api/v2/firewall/components/quarantined | 

*FirewallAPI* | [**GetQuarantineSummary**](docs/FirewallAPI.md#getquarantinesummary) | **Get** /api/v2/firewall/quarantine/summary | 

*FirewallAPI* | [**GetQuarantinedComponentViewAnonymousAccess**](docs/FirewallAPI.md#getquarantinedcomponentviewanonymousaccess) | **Get** /api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess | 

*FirewallAPI* | [**GetRepositoryContainer**](docs/FirewallAPI.md#getrepositorycontainer) | **Get** /api/v2/firewall/repositoryContainer | 

*FirewallAPI* | [**GetRepositoryManager**](docs/FirewallAPI.md#getrepositorymanager) | **Get** /api/v2/firewall/repositoryManagers/{repositoryManagerId} | 

*FirewallAPI* | [**GetRepositoryManagers**](docs/FirewallAPI.md#getrepositorymanagers) | **Get** /api/v2/firewall/repositoryManagers | 

*FirewallAPI* | [**GetUnquarantineList**](docs/FirewallAPI.md#getunquarantinelist) | **Get** /api/v2/firewall/components/autoReleasedFromQuarantine | 

*FirewallAPI* | [**SetFirewallAutoUnquarantineConfig**](docs/FirewallAPI.md#setfirewallautounquarantineconfig) | **Put** /api/v2/firewall/releaseQuarantine/configuration | 

*FirewallAPI* | [**SetQuarantinedComponentViewAnonymousAccess**](docs/FirewallAPI.md#setquarantinedcomponentviewanonymousaccess) | **Put** /api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess/{enabled} | 

*LabelsAPI* | [**AddLabel**](docs/LabelsAPI.md#addlabel) | **Post** /api/v2/labels/{ownerType}/{ownerId} | 

*LabelsAPI* | [**DeleteLabel**](docs/LabelsAPI.md#deletelabel) | **Delete** /api/v2/labels/{ownerType}/{ownerId}/{labelId} | 

*LabelsAPI* | [**GetApplicableContexts**](docs/LabelsAPI.md#getapplicablecontexts) | **Get** /api/v2/labels/{ownerType}/{ownerId}/applicable/context/{labelId} | 

*LabelsAPI* | [**GetApplicableLabels**](docs/LabelsAPI.md#getapplicablelabels) | **Get** /api/v2/labels/{ownerType}/{ownerId}/applicable | 

*LabelsAPI* | [**GetLabels**](docs/LabelsAPI.md#getlabels) | **Get** /api/v2/labels/{ownerType}/{ownerId} | 

*LabelsAPI* | [**UpdateLabel**](docs/LabelsAPI.md#updatelabel) | **Put** /api/v2/labels/{ownerType}/{ownerId} | 

*LicenseLegalMetadataAPI* | [**DeleteAttributionReportTemplate**](docs/LicenseLegalMetadataAPI.md#deleteattributionreporttemplate) | **Delete** /api/v2/licenseLegalMetadata/report-template/{id} | 

*LicenseLegalMetadataAPI* | [**GetAllAttributionReportTemplates**](docs/LicenseLegalMetadataAPI.md#getallattributionreporttemplates) | **Get** /api/v2/licenseLegalMetadata/report-template | 

*LicenseLegalMetadataAPI* | [**GetAttributionReportTemplateById**](docs/LicenseLegalMetadataAPI.md#getattributionreporttemplatebyid) | **Get** /api/v2/licenseLegalMetadata/report-template/{id} | 

*LicenseLegalMetadataAPI* | [**GetLicenseLegalApplicationHTMLReport**](docs/LicenseLegalMetadataAPI.md#getlicenselegalapplicationhtmlreport) | **Get** /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report | 

*LicenseLegalMetadataAPI* | [**GetLicenseLegalApplicationReport**](docs/LicenseLegalMetadataAPI.md#getlicenselegalapplicationreport) | **Get** /api/v2/licenseLegalMetadata/application/{applicationId} | 

*LicenseLegalMetadataAPI* | [**GetLicenseLegalApplicationReport1**](docs/LicenseLegalMetadataAPI.md#getlicenselegalapplicationreport1) | **Get** /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId} | 

*LicenseLegalMetadataAPI* | [**GetLicenseLegalComponentReport**](docs/LicenseLegalMetadataAPI.md#getlicenselegalcomponentreport) | **Get** /api/v2/licenseLegalMetadata/{ownerType}/{ownerId}/component | 

*LicenseLegalMetadataAPI* | [**GetLicenseLegalCustomApplicationHTMLReport**](docs/LicenseLegalMetadataAPI.md#getlicenselegalcustomapplicationhtmlreport) | **Post** /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report | 

*LicenseLegalMetadataAPI* | [**GetLicenseLegalCustomApplicationHTMLReport1**](docs/LicenseLegalMetadataAPI.md#getlicenselegalcustomapplicationhtmlreport1) | **Post** /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report/templateId/{templateId} | 

*LicenseLegalMetadataAPI* | [**GetLicenseLegalCustomMultiApplicationHTMLReport1**](docs/LicenseLegalMetadataAPI.md#getlicenselegalcustommultiapplicationhtmlreport1) | **Post** /api/v2/licenseLegalMetadata/multiApplication/report/templateId/{templateId} | 

*LicenseLegalMetadataAPI* | [**GetLicenseLegalMultiApplicationHTMLReport**](docs/LicenseLegalMetadataAPI.md#getlicenselegalmultiapplicationhtmlreport) | **Post** /api/v2/licenseLegalMetadata/multiApplication/report | 

*LicenseLegalMetadataAPI* | [**GetLicenseLegalMultiApplicationReportFromActiveUserFilter**](docs/LicenseLegalMetadataAPI.md#getlicenselegalmultiapplicationreportfromactiveuserfilter) | **Post** /api/v2/licenseLegalMetadata/multiApplication/activeUserFilter/report/templateId/{templateId} | 

*LicenseLegalMetadataAPI* | [**SaveAttributionReportTemplate**](docs/LicenseLegalMetadataAPI.md#saveattributionreporttemplate) | **Post** /api/v2/licenseLegalMetadata/report-template | 

*MalwareAPI* | [**EvaluateMalware**](docs/MalwareAPI.md#evaluatemalware) | **Post** /api/v2/malware/defense/evaluate | 

*MalwareAPI* | [**GetMalwareDefenseMetrics**](docs/MalwareAPI.md#getmalwaredefensemetrics) | **Get** /api/v2/malware/defense/metrics | 

*OrganizationsAPI* | [**AddOrganization**](docs/OrganizationsAPI.md#addorganization) | **Post** /api/v2/organizations | 

*OrganizationsAPI* | [**DeleteOrganization**](docs/OrganizationsAPI.md#deleteorganization) | **Delete** /api/v2/organizations/{organizationId} | 

*OrganizationsAPI* | [**GetOrganization**](docs/OrganizationsAPI.md#getorganization) | **Get** /api/v2/organizations/{organizationId} | 

*OrganizationsAPI* | [**GetOrganizations**](docs/OrganizationsAPI.md#getorganizations) | **Get** /api/v2/organizations | 

*OrganizationsAPI* | [**MoveOrganization**](docs/OrganizationsAPI.md#moveorganization) | **Put** /api/v2/organizations/{organizationId}/move/destination/{destinationId} | 

*PoliciesAPI* | [**GetPolicies**](docs/PoliciesAPI.md#getpolicies) | **Get** /api/v2/policies | 

*PolicyEvaluationAPI* | [**EvaluateComponents**](docs/PolicyEvaluationAPI.md#evaluatecomponents) | **Post** /api/v2/evaluation/applications/{applicationId} | 

*PolicyEvaluationAPI* | [**EvaluateSourceControl**](docs/PolicyEvaluationAPI.md#evaluatesourcecontrol) | **Post** /api/v2/evaluation/applications/{applicationId}/sourceControlEvaluation | 

*PolicyEvaluationAPI* | [**GetApplicationEvaluationStatus**](docs/PolicyEvaluationAPI.md#getapplicationevaluationstatus) | **Get** /api/v2/evaluation/applications/{applicationId}/status/{statusId} | 

*PolicyEvaluationAPI* | [**GetComponentEvaluation**](docs/PolicyEvaluationAPI.md#getcomponentevaluation) | **Get** /api/v2/evaluation/applications/{applicationId}/results/{resultId} | 

*PolicyEvaluationAPI* | [**PromoteScan**](docs/PolicyEvaluationAPI.md#promotescan) | **Post** /api/v2/evaluation/applications/{applicationId}/promoteScan | 

*PolicyViolationDetailsAPI* | [**GetApplicableAutoWaiver**](docs/PolicyViolationDetailsAPI.md#getapplicableautowaiver) | **Get** /api/v2/policyViolations/{violationId}/applicableAutoWaiver | 

*PolicyViolationDetailsAPI* | [**GetApplicableWaivers**](docs/PolicyViolationDetailsAPI.md#getapplicablewaivers) | **Get** /api/v2/policyViolations/{violationId}/applicableWaivers | 

*PolicyViolationDetailsAPI* | [**GetCrossStagePolicyViolationByConstituentId**](docs/PolicyViolationDetailsAPI.md#getcrossstagepolicyviolationbyconstituentid) | **Get** /api/v2/policyViolations/crossStage | 

*PolicyViolationDetailsAPI* | [**GetCrossStagePolicyViolationById**](docs/PolicyViolationDetailsAPI.md#getcrossstagepolicyviolationbyid) | **Get** /api/v2/policyViolations/crossStage/{violationId} | 

*PolicyViolationDetailsAPI* | [**GetPolicyViolations**](docs/PolicyViolationDetailsAPI.md#getpolicyviolations) | **Get** /api/v2/policyViolations | 

*PolicyViolationDetailsAPI* | [**GetSimilarWaivers**](docs/PolicyViolationDetailsAPI.md#getsimilarwaivers) | **Get** /api/v2/policyViolations/{violationId}/similarWaivers | 

*PolicyViolationDetailsAPI* | [**GetTransitivePolicyViolationsByAppScanComponent**](docs/PolicyViolationDetailsAPI.md#gettransitivepolicyviolationsbyappscancomponent) | **Get** /api/v2/policyViolations/transitive/{ownerType}/{ownerId}/{scanId} | 

*PolicyViolationDetailsAPI* | [**GetTransitivePolicyViolationsByOwnerStageComponent**](docs/PolicyViolationDetailsAPI.md#gettransitivepolicyviolationsbyownerstagecomponent) | **Get** /api/v2/policyViolations/transitive/{ownerType}/{ownerId}/stages/{stageId} | 

*PolicyWaiverReasonsAPI* | [**GetPolicyWaiverReasons**](docs/PolicyWaiverReasonsAPI.md#getpolicywaiverreasons) | **Get** /api/v2/policyWaiverReasons | 

*PolicyWaiversAPI* | [**AddPolicyWaiverByPolicyViolationId**](docs/PolicyWaiversAPI.md#addpolicywaiverbypolicyviolationid) | **Post** /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyViolationId} | 

*PolicyWaiversAPI* | [**AddWaiverToTransitivePolicyViolationsByAppScanComponent**](docs/PolicyWaiversAPI.md#addwaivertotransitivepolicyviolationsbyappscancomponent) | **Post** /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId} | 

*PolicyWaiversAPI* | [**AddWaiverToTransitivePolicyViolationsByOwnerStageComponent**](docs/PolicyWaiversAPI.md#addwaivertotransitivepolicyviolationsbyownerstagecomponent) | **Post** /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/stages/{stageId} | 

*PolicyWaiversAPI* | [**DeletePolicyWaiver**](docs/PolicyWaiversAPI.md#deletepolicywaiver) | **Delete** /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId} | 

*PolicyWaiversAPI* | [**GetPolicyWaiver**](docs/PolicyWaiversAPI.md#getpolicywaiver) | **Get** /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId} | 

*PolicyWaiversAPI* | [**GetPolicyWaivers**](docs/PolicyWaiversAPI.md#getpolicywaivers) | **Get** /api/v2/policyWaivers/{ownerType}/{ownerId} | 

*PolicyWaiversAPI* | [**GetTransitivePolicyWaiversByAppScanComponent**](docs/PolicyWaiversAPI.md#gettransitivepolicywaiversbyappscancomponent) | **Get** /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId} | 

*PolicyWaiversAPI* | [**RequestPolicyWaiver**](docs/PolicyWaiversAPI.md#requestpolicywaiver) | **Post** /api/v2/policyWaivers/waiverRequests/{policyViolationId} | 

*ReportsAPI* | [**GetAll1**](docs/ReportsAPI.md#getall1) | **Get** /api/v2/reports/applications | 

*ReportsAPI* | [**GetByApplicationId**](docs/ReportsAPI.md#getbyapplicationid) | **Get** /api/v2/reports/applications/{applicationId} | 

*ReportsAPI* | [**GetComponentsInQuarantine**](docs/ReportsAPI.md#getcomponentsinquarantine) | **Get** /api/v2/reports/components/quarantined | 

*ReportsAPI* | [**GetComponentsWithWaivers**](docs/ReportsAPI.md#getcomponentswithwaivers) | **Get** /api/v2/reports/components/waivers | 

*ReportsAPI* | [**GetMetrics**](docs/ReportsAPI.md#getmetrics) | **Post** /api/v2/reports/metrics | 

*ReportsAPI* | [**GetReportHistoryForApplication**](docs/ReportsAPI.md#getreporthistoryforapplication) | **Get** /api/v2/reports/applications/{applicationId}/history | 

*ReportsAPI* | [**GetStaleWaivers**](docs/ReportsAPI.md#getstalewaivers) | **Get** /api/v2/reports/waivers/stale | 

*RepositoriesAPI* | [**GetQuarantinedByPath**](docs/RepositoriesAPI.md#getquarantinedbypath) | **Post** /api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames | 

*RepositoriesAPI* | [**ReleaseQuarantineWithoutReEval**](docs/RepositoriesAPI.md#releasequarantinewithoutreeval) | **Post** /api/v2/repositories/quarantine/{quarantineId}/release | 

*RoleMembershipsAPI* | [**GetRoleMembershipsApplicationOrOrganization**](docs/RoleMembershipsAPI.md#getrolemembershipsapplicationororganization) | **Get** /api/v2/roleMemberships/{ownerType}/{internalOwnerId} | 

*RoleMembershipsAPI* | [**GetRoleMembershipsGlobalOrRepositoryContainer**](docs/RoleMembershipsAPI.md#getrolemembershipsglobalorrepositorycontainer) | **Get** /api/v2/roleMemberships/{ownerType} | 

*RoleMembershipsAPI* | [**GrantRoleMembershipApplicationOrOrganization**](docs/RoleMembershipsAPI.md#grantrolemembershipapplicationororganization) | **Put** /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName} | 

*RoleMembershipsAPI* | [**GrantRoleMembershipGlobalOrRepositoryContainer**](docs/RoleMembershipsAPI.md#grantrolemembershipglobalorrepositorycontainer) | **Put** /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName} | 

*RoleMembershipsAPI* | [**RevokeRoleMembershipApplicationOrOrganization**](docs/RoleMembershipsAPI.md#revokerolemembershipapplicationororganization) | **Delete** /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName} | 

*RoleMembershipsAPI* | [**RevokeRoleMembershipGlobalOrRepositoryContainer**](docs/RoleMembershipsAPI.md#revokerolemembershipglobalorrepositorycontainer) | **Delete** /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName} | 

*RolesAPI* | [**GetRoles**](docs/RolesAPI.md#getroles) | **Get** /api/v2/roles | 

*SbomAPI* | [**DeleteSbomVersion**](docs/SbomAPI.md#deletesbomversion) | **Delete** /api/v2/sbom/applications/{applicationId}/versions/{version} | Delete sbom version

*SbomAPI* | [**DeleteVulnerabilityAnalysis**](docs/SbomAPI.md#deletevulnerabilityanalysis) | **Delete** /api/v2/sbom/applications/{applicationId}/versions/{version}/vulnerability/{refId}/analysis | Deletes a Vulnerability analysis for a given component.

*SbomAPI* | [**GetActiveSbomVersionListByApplication**](docs/SbomAPI.md#getactivesbomversionlistbyapplication) | **Get** /api/v2/sbom/applications/{applicationId}/versions | Gets a list of active sbom versions by application id

*SbomAPI* | [**GetImportStatus**](docs/SbomAPI.md#getimportstatus) | **Get** /api/v2/sbom/applications/{applicationId}/status/{importRequestId} | Get sbom import status

*SbomAPI* | [**GetSbomComponents**](docs/SbomAPI.md#getsbomcomponents) | **Get** /api/v2/sbom/applications/{applicationId}/versions/{version}/components | Gets the components found in a specific sbom version

*SbomAPI* | [**GetSbomMetadataSummaryForApplication**](docs/SbomAPI.md#getsbommetadatasummaryforapplication) | **Get** /api/v2/sbom/applications/{applicationId} | Gets a paginated list of SBOMs for an application

*SbomAPI* | [**GetSbomVersion**](docs/SbomAPI.md#getsbomversion) | **Get** /api/v2/sbom/applications/{applicationId}/versions/{version} | Gets a sbom version

*SbomAPI* | [**ImportSbom**](docs/SbomAPI.md#importsbom) | **Post** /api/v2/sbom/import | Import a new sbom version

*SbomAPI* | [**SaveVulnerabilityAnalysis**](docs/SbomAPI.md#savevulnerabilityanalysis) | **Put** /api/v2/sbom/applications/{applicationId}/versions/{version}/vulnerability/{refId}/analysis | Updates a vulnerability analysis annotation for a specific SBOM vulnerability

*ScanAPI* | [**GetIdeUsersOverview**](docs/ScanAPI.md#getideusersoverview) | **Get** /api/v2/scan/applications/ideUser/overview | 

*ScanAPI* | [**GetScanStatus**](docs/ScanAPI.md#getscanstatus) | **Get** /api/v2/scan/applications/{applicationId}/status/{scanRequestId} | 

*ScanAPI* | [**ScanComponents**](docs/ScanAPI.md#scancomponents) | **Post** /api/v2/scan/applications/{applicationId}/sources/{source} | 

*SearchAPI* | [**SearchComponent**](docs/SearchAPI.md#searchcomponent) | **Get** /api/v2/search/component | 

*SecurityOverridesAPI* | [**GetSecurityVulnerabilityOverrides**](docs/SecurityOverridesAPI.md#getsecurityvulnerabilityoverrides) | **Get** /api/v2/securityOverrides | 

*SolutionsAPI* | [**GetLicensedSolutions**](docs/SolutionsAPI.md#getlicensedsolutions) | **Get** /api/v2/solutions/licensed | 

*SourceControlAPI* | [**AddSourceControl**](docs/SourceControlAPI.md#addsourcecontrol) | **Post** /api/v2/sourceControl/{ownerType}/{internalOwnerId} | 

*SourceControlAPI* | [**AutomaticRoleAssignment**](docs/SourceControlAPI.md#automaticroleassignment) | **Post** /api/v2/sourceControl/automaticRoleAssignment/{publicId} | 

*SourceControlAPI* | [**DeleteSourceControl**](docs/SourceControlAPI.md#deletesourcecontrol) | **Delete** /api/v2/sourceControl/{ownerType}/{internalOwnerId} | 

*SourceControlAPI* | [**GetSourceControl1**](docs/SourceControlAPI.md#getsourcecontrol1) | **Get** /api/v2/sourceControl/{ownerType}/{internalOwnerId} | 

*SourceControlAPI* | [**UpdateSourceControl**](docs/SourceControlAPI.md#updatesourcecontrol) | **Put** /api/v2/sourceControl/{ownerType}/{internalOwnerId} | 

*SourceControlMetricsAPI* | [**GetSourceControl**](docs/SourceControlMetricsAPI.md#getsourcecontrol) | **Get** /api/v2/sourceControlMetrics/{ownerType}/{internalOwnerId} | 

*SpdxAPI* | [**GetByScanId**](docs/SpdxAPI.md#getbyscanid) | **Get** /api/v2/spdx/{applicationId}/reports/{scanId} | 

*SpdxAPI* | [**GetLatestForStage**](docs/SpdxAPI.md#getlatestforstage) | **Get** /api/v2/spdx/{applicationId}/stages/{stageId} | 

*TelemetryAPI* | [**PostExternalTelemetry**](docs/TelemetryAPI.md#postexternaltelemetry) | **Post** /api/v2/telemetry | 

*UserTokensAPI* | [**CreateUserToken**](docs/UserTokensAPI.md#createusertoken) | **Post** /api/v2/userTokens/currentUser | 

*UserTokensAPI* | [**DeleteCurrentUserToken**](docs/UserTokensAPI.md#deletecurrentusertoken) | **Delete** /api/v2/userTokens/currentUser | 

*UserTokensAPI* | [**DeleteUserTokenByUserCode**](docs/UserTokensAPI.md#deleteusertokenbyusercode) | **Delete** /api/v2/userTokens/userCode/{userCode} | 

*UserTokensAPI* | [**GetUserTokenByUsernameAndRealmId**](docs/UserTokensAPI.md#getusertokenbyusernameandrealmid) | **Get** /api/v2/userTokens/{username} | 

*UserTokensAPI* | [**GetUserTokenExistsForCurrentUser**](docs/UserTokensAPI.md#getusertokenexistsforcurrentuser) | **Get** /api/v2/userTokens/currentUser/hasToken | 

*UserTokensAPI* | [**GetUserTokensByCreatedBetweenAndRealmId**](docs/UserTokensAPI.md#getusertokensbycreatedbetweenandrealmid) | **Get** /api/v2/userTokens | 

*UserTokensAPI* | [**PurgeUserTokens**](docs/UserTokensAPI.md#purgeusertokens) | **Delete** /api/v2/userTokens/purge | 

*UsersAPI* | [**Add**](docs/UsersAPI.md#add) | **Post** /api/v2/users | 

*UsersAPI* | [**Delete1**](docs/UsersAPI.md#delete1) | **Delete** /api/v2/users/{username} | 

*UsersAPI* | [**Get1**](docs/UsersAPI.md#get1) | **Get** /api/v2/users/{username} | 

*UsersAPI* | [**GetAll2**](docs/UsersAPI.md#getall2) | **Get** /api/v2/users | 

*UsersAPI* | [**Update**](docs/UsersAPI.md#update) | **Put** /api/v2/users/{username} | 

*VulnerabilitiesAPI* | [**GetSecurityVulnerabilityDetails**](docs/VulnerabilitiesAPI.md#getsecurityvulnerabilitydetails) | **Get** /api/v2/vulnerabilities/{refId} | 

## Documentation For Models

 - [Action](docs/Action.md)

 - [ApiApplicationBaseDTO](docs/ApiApplicationBaseDTO.md)

 - [ApiApplicationCategoryDTO](docs/ApiApplicationCategoryDTO.md)

 - [ApiApplicationDTO](docs/ApiApplicationDTO.md)

 - [ApiApplicationEvaluationCommitDTO](docs/ApiApplicationEvaluationCommitDTO.md)

 - [ApiApplicationEvaluationResultDTOV2](docs/ApiApplicationEvaluationResultDTOV2.md)

 - [ApiApplicationEvaluationStatusDTOV2](docs/ApiApplicationEvaluationStatusDTOV2.md)

 - [ApiApplicationListDTO](docs/ApiApplicationListDTO.md)

 - [ApiApplicationReportDTOV2](docs/ApiApplicationReportDTOV2.md)

 - [ApiApplicationTagDTO](docs/ApiApplicationTagDTO.md)

 - [ApiApplicationViolationDTOV2](docs/ApiApplicationViolationDTOV2.md)

 - [ApiApplicationViolationListDTOV2](docs/ApiApplicationViolationListDTOV2.md)

 - [ApiApplicationWaiverDTO](docs/ApiApplicationWaiverDTO.md)

 - [ApiArtifactoryConnectionDTO](docs/ApiArtifactoryConnectionDTO.md)

 - [ApiArtifactoryConnectionStatusRequestDTO](docs/ApiArtifactoryConnectionStatusRequestDTO.md)

 - [ApiArtifactoryConnectionStatusResponseDTO](docs/ApiArtifactoryConnectionStatusResponseDTO.md)

 - [ApiAutoPolicyWaiverDTO](docs/ApiAutoPolicyWaiverDTO.md)

 - [ApiAutoPolicyWaiverRevocationDTO](docs/ApiAutoPolicyWaiverRevocationDTO.md)

 - [ApiAutoPolicyWaiverStatusDTO](docs/ApiAutoPolicyWaiverStatusDTO.md)

 - [ApiComponentChangeActionDTO](docs/ApiComponentChangeActionDTO.md)

 - [ApiComponentDTOV2](docs/ApiComponentDTOV2.md)

 - [ApiComponentDetailsDTOV2](docs/ApiComponentDetailsDTOV2.md)

 - [ApiComponentDetailsRequestDTOV2](docs/ApiComponentDetailsRequestDTOV2.md)

 - [ApiComponentDetailsResultDTOV2](docs/ApiComponentDetailsResultDTOV2.md)

 - [ApiComponentEvaluationRequestDTOV2](docs/ApiComponentEvaluationRequestDTOV2.md)

 - [ApiComponentEvaluationResultDTOV2](docs/ApiComponentEvaluationResultDTOV2.md)

 - [ApiComponentEvaluationTicketDTOV2](docs/ApiComponentEvaluationTicketDTOV2.md)

 - [ApiComponentIdentifierDTOV2](docs/ApiComponentIdentifierDTOV2.md)

 - [ApiComponentOrPurlIdentifierDTOV2](docs/ApiComponentOrPurlIdentifierDTOV2.md)

 - [ApiComponentPolicyViolationDTO](docs/ApiComponentPolicyViolationDTO.md)

 - [ApiComponentPolicyViolationListDTOV2](docs/ApiComponentPolicyViolationListDTOV2.md)

 - [ApiComponentPolicyWaiversDTO](docs/ApiComponentPolicyWaiversDTO.md)

 - [ApiComponentProjectDataDTO](docs/ApiComponentProjectDataDTO.md)

 - [ApiComponentProjectMetadataDTO](docs/ApiComponentProjectMetadataDTO.md)

 - [ApiComponentProjectScmDTO](docs/ApiComponentProjectScmDTO.md)

 - [ApiComponentProjectScmDetailsDTO](docs/ApiComponentProjectScmDetailsDTO.md)

 - [ApiComponentProjectScmMetadataDTO](docs/ApiComponentProjectScmMetadataDTO.md)

 - [ApiComponentReleasedFromQuarantineDTO](docs/ApiComponentReleasedFromQuarantineDTO.md)

 - [ApiComponentRemediationDTO](docs/ApiComponentRemediationDTO.md)

 - [ApiComponentRemediationValueDTO](docs/ApiComponentRemediationValueDTO.md)

 - [ApiComponentTransitivePolicyViolationsDTO](docs/ApiComponentTransitivePolicyViolationsDTO.md)

 - [ApiComponentWaiversDTO](docs/ApiComponentWaiversDTO.md)

 - [ApiComponentsInQuarantineDTO](docs/ApiComponentsInQuarantineDTO.md)

 - [ApiCompositeSourceControlDTO](docs/ApiCompositeSourceControlDTO.md)

 - [ApiCompositeValueDTOBoolean](docs/ApiCompositeValueDTOBoolean.md)

 - [ApiCompositeValueDTOString](docs/ApiCompositeValueDTOString.md)

 - [ApiConditionFactReasonDTO](docs/ApiConditionFactReasonDTO.md)

 - [ApiConstraintFactDTO](docs/ApiConstraintFactDTO.md)

 - [ApiConstraintViolationDTO](docs/ApiConstraintViolationDTO.md)

 - [ApiConstraintViolationReasonDTO](docs/ApiConstraintViolationReasonDTO.md)

 - [ApiCrossStageViolationDTOV2](docs/ApiCrossStageViolationDTOV2.md)

 - [ApiCrowdConfigurationDTO](docs/ApiCrowdConfigurationDTO.md)

 - [ApiDataRetentionPoliciesDTO](docs/ApiDataRetentionPoliciesDTO.md)

 - [ApiDependencyDataDTO](docs/ApiDependencyDataDTO.md)

 - [ApiDependencyTreeNodeDTO](docs/ApiDependencyTreeNodeDTO.md)

 - [ApiDependencyTreeResponseDTO](docs/ApiDependencyTreeResponseDTO.md)

 - [ApiEnhancedPolicyViolationDTOV2](docs/ApiEnhancedPolicyViolationDTOV2.md)

 - [ApiEvaluationResultCounterDTO](docs/ApiEvaluationResultCounterDTO.md)

 - [ApiFirewallMetricsResultDTO](docs/ApiFirewallMetricsResultDTO.md)

 - [ApiFirewallQuarantineSummaryDTO](docs/ApiFirewallQuarantineSummaryDTO.md)

 - [ApiFirewallReleaseQuarantineConfigDTO](docs/ApiFirewallReleaseQuarantineConfigDTO.md)

 - [ApiFirewallReleaseQuarantineSummaryDTO](docs/ApiFirewallReleaseQuarantineSummaryDTO.md)

 - [ApiGlobalInformationDTOV2](docs/ApiGlobalInformationDTOV2.md)

 - [ApiHashComponentIdentifierDTO](docs/ApiHashComponentIdentifierDTO.md)

 - [ApiHashComponentIdentifiersDTO](docs/ApiHashComponentIdentifiersDTO.md)

 - [ApiJiraConfigurationDTO](docs/ApiJiraConfigurationDTO.md)

 - [ApiLabelDTO](docs/ApiLabelDTO.md)

 - [ApiLicenseDTO](docs/ApiLicenseDTO.md)

 - [ApiLicenseDataDTO](docs/ApiLicenseDataDTO.md)

 - [ApiLicenseDataDTOV2](docs/ApiLicenseDataDTOV2.md)

 - [ApiLicenseLegalApplicationReportDTO](docs/ApiLicenseLegalApplicationReportDTO.md)

 - [ApiLicenseLegalComponentDTO](docs/ApiLicenseLegalComponentDTO.md)

 - [ApiLicenseLegalComponentReportDTO](docs/ApiLicenseLegalComponentReportDTO.md)

 - [ApiLicenseLegalCopyrightDTO](docs/ApiLicenseLegalCopyrightDTO.md)

 - [ApiLicenseLegalDataDTO](docs/ApiLicenseLegalDataDTO.md)

 - [ApiLicenseLegalFileDTO](docs/ApiLicenseLegalFileDTO.md)

 - [ApiLicenseLegalMetadataDTO](docs/ApiLicenseLegalMetadataDTO.md)

 - [ApiLicenseLegalObligationDTO](docs/ApiLicenseLegalObligationDTO.md)

 - [ApiLicenseLegalStageScanDTO](docs/ApiLicenseLegalStageScanDTO.md)

 - [ApiLicenseThreatDTOV2](docs/ApiLicenseThreatDTOV2.md)

 - [ApiLicensedSolutionDTO](docs/ApiLicensedSolutionDTO.md)

 - [ApiMailConfigurationDTO](docs/ApiMailConfigurationDTO.md)

 - [ApiMalwareComponentEvaluationRequest](docs/ApiMalwareComponentEvaluationRequest.md)

 - [ApiMalwareComponentEvaluationRequestList](docs/ApiMalwareComponentEvaluationRequestList.md)

 - [ApiMatchStateSummaryDTOV2](docs/ApiMatchStateSummaryDTOV2.md)

 - [ApiMemberDTO](docs/ApiMemberDTO.md)

 - [ApiMetricsReportingQueryDTOV2](docs/ApiMetricsReportingQueryDTOV2.md)

 - [ApiMoveApplicationResponseDTOV2](docs/ApiMoveApplicationResponseDTOV2.md)

 - [ApiOrganizationDTO](docs/ApiOrganizationDTO.md)

 - [ApiOrganizationListDTO](docs/ApiOrganizationListDTO.md)

 - [ApiOwnerArtifactoryConnectionDTO](docs/ApiOwnerArtifactoryConnectionDTO.md)

 - [ApiOwnerDTO](docs/ApiOwnerDTO.md)

 - [ApiPageResultPrioritizedComponent](docs/ApiPageResultPrioritizedComponent.md)

 - [ApiPolicyDTO](docs/ApiPolicyDTO.md)

 - [ApiPolicyListDTO](docs/ApiPolicyListDTO.md)

 - [ApiPolicyViolationDTOV2](docs/ApiPolicyViolationDTOV2.md)

 - [ApiPolicyViolationDiffDTO](docs/ApiPolicyViolationDiffDTO.md)

 - [ApiPolicyViolationForDiffDTO](docs/ApiPolicyViolationForDiffDTO.md)

 - [ApiPolicyViolationStageDTO](docs/ApiPolicyViolationStageDTO.md)

 - [ApiPolicyWaiverDTO](docs/ApiPolicyWaiverDTO.md)

 - [ApiPolicyWaiverReasonDTO](docs/ApiPolicyWaiverReasonDTO.md)

 - [ApiPolicyWaiversApplicableToViolationDTO](docs/ApiPolicyWaiversApplicableToViolationDTO.md)

 - [ApiPromoteScanRequestDTOV2](docs/ApiPromoteScanRequestDTOV2.md)

 - [ApiProxyServerConfigurationDTO](docs/ApiProxyServerConfigurationDTO.md)

 - [ApiPullRequestResult](docs/ApiPullRequestResult.md)

 - [ApiPullRequestResults](docs/ApiPullRequestResults.md)

 - [ApiReportComponentDTOV2](docs/ApiReportComponentDTOV2.md)

 - [ApiReportComponentPolicyViolationsDTOV2](docs/ApiReportComponentPolicyViolationsDTOV2.md)

 - [ApiReportConstraintConditionDTOV2](docs/ApiReportConstraintConditionDTOV2.md)

 - [ApiReportConstraintViolationDTOV2](docs/ApiReportConstraintViolationDTOV2.md)

 - [ApiReportHistoryDTO](docs/ApiReportHistoryDTO.md)

 - [ApiReportPolicyDataDTOV2](docs/ApiReportPolicyDataDTOV2.md)

 - [ApiReportPolicyViolationDTOV2](docs/ApiReportPolicyViolationDTOV2.md)

 - [ApiReportRawDataDTOV2](docs/ApiReportRawDataDTOV2.md)

 - [ApiReportResultsDTO](docs/ApiReportResultsDTO.md)

 - [ApiReportRetentionPoliciesDTO](docs/ApiReportRetentionPoliciesDTO.md)

 - [ApiReportRetentionPolicyDTO](docs/ApiReportRetentionPolicyDTO.md)

 - [ApiRepositoryComponentDTO](docs/ApiRepositoryComponentDTO.md)

 - [ApiRepositoryComponentEvaluationRequest](docs/ApiRepositoryComponentEvaluationRequest.md)

 - [ApiRepositoryComponentEvaluationRequestList](docs/ApiRepositoryComponentEvaluationRequestList.md)

 - [ApiRepositoryComponentEvaluationResult](docs/ApiRepositoryComponentEvaluationResult.md)

 - [ApiRepositoryComponentEvaluationResultList](docs/ApiRepositoryComponentEvaluationResultList.md)

 - [ApiRepositoryComponentPath](docs/ApiRepositoryComponentPath.md)

 - [ApiRepositoryComponentPolicyViolationDTO](docs/ApiRepositoryComponentPolicyViolationDTO.md)

 - [ApiRepositoryComponentsInQuarantineDTO](docs/ApiRepositoryComponentsInQuarantineDTO.md)

 - [ApiRepositoryContainerDTO](docs/ApiRepositoryContainerDTO.md)

 - [ApiRepositoryDTO](docs/ApiRepositoryDTO.md)

 - [ApiRepositoryListDTO](docs/ApiRepositoryListDTO.md)

 - [ApiRepositoryManagerDTO](docs/ApiRepositoryManagerDTO.md)

 - [ApiRepositoryManagerListDTO](docs/ApiRepositoryManagerListDTO.md)

 - [ApiRepositoryPathResponseDTO](docs/ApiRepositoryPathResponseDTO.md)

 - [ApiRepositoryPathVersions](docs/ApiRepositoryPathVersions.md)

 - [ApiRepositoryWaiverDTO](docs/ApiRepositoryWaiverDTO.md)

 - [ApiRequestPolicyWaiverDTO](docs/ApiRequestPolicyWaiverDTO.md)

 - [ApiReverseProxyAuthenticationConfigurationDTO](docs/ApiReverseProxyAuthenticationConfigurationDTO.md)

 - [ApiRoleDTO](docs/ApiRoleDTO.md)

 - [ApiRoleListDTO](docs/ApiRoleListDTO.md)

 - [ApiRoleMemberMappingDTO](docs/ApiRoleMemberMappingDTO.md)

 - [ApiRoleMemberMappingListDTO](docs/ApiRoleMemberMappingListDTO.md)

 - [ApiSamlConfigurationDTO](docs/ApiSamlConfigurationDTO.md)

 - [ApiSamlConfigurationResponseDTO](docs/ApiSamlConfigurationResponseDTO.md)

 - [ApiSbomStatusDTO](docs/ApiSbomStatusDTO.md)

 - [ApiSearchCriteriaDTOV2](docs/ApiSearchCriteriaDTOV2.md)

 - [ApiSearchResultDTOV2](docs/ApiSearchResultDTOV2.md)

 - [ApiSearchResultsDTOV2](docs/ApiSearchResultsDTOV2.md)

 - [ApiSecurityDataDTO](docs/ApiSecurityDataDTO.md)

 - [ApiSecurityIssueAnalysisDTO](docs/ApiSecurityIssueAnalysisDTO.md)

 - [ApiSecurityIssueDTO](docs/ApiSecurityIssueDTO.md)

 - [ApiSecurityVulnerabilityOverrideDTOV2](docs/ApiSecurityVulnerabilityOverrideDTOV2.md)

 - [ApiSecurityVulnerabilityOverrideResponseDTOV2](docs/ApiSecurityVulnerabilityOverrideResponseDTOV2.md)

 - [ApiSourceControlConfigurationDTO](docs/ApiSourceControlConfigurationDTO.md)

 - [ApiSourceControlDTO](docs/ApiSourceControlDTO.md)

 - [ApiSourceControlEvaluationRequestDTO](docs/ApiSourceControlEvaluationRequestDTO.md)

 - [ApiStagePolicyViolationComponentDTO](docs/ApiStagePolicyViolationComponentDTO.md)

 - [ApiStaleApplicationEvaluationDTO](docs/ApiStaleApplicationEvaluationDTO.md)

 - [ApiStaleEvaluationStageDTO](docs/ApiStaleEvaluationStageDTO.md)

 - [ApiStaleEvaluationsDTO](docs/ApiStaleEvaluationsDTO.md)

 - [ApiStaleRepositoryEvaluationDTO](docs/ApiStaleRepositoryEvaluationDTO.md)

 - [ApiStaleWaiverDTO](docs/ApiStaleWaiverDTO.md)

 - [ApiStaleWaiversResponseDTO](docs/ApiStaleWaiversResponseDTO.md)

 - [ApiStatusDTO](docs/ApiStatusDTO.md)

 - [ApiSuccessMetricsRetentionPolicyDTO](docs/ApiSuccessMetricsRetentionPolicyDTO.md)

 - [ApiSuggestedVersionChangeOptionDTO](docs/ApiSuggestedVersionChangeOptionDTO.md)

 - [ApiTagDTO](docs/ApiTagDTO.md)

 - [ApiThirdPartyScanResultDTO](docs/ApiThirdPartyScanResultDTO.md)

 - [ApiThirdPartyScanTicketDTO](docs/ApiThirdPartyScanTicketDTO.md)

 - [ApiUserDTO](docs/ApiUserDTO.md)

 - [ApiUserListDTO](docs/ApiUserListDTO.md)

 - [ApiUserTokenDTO](docs/ApiUserTokenDTO.md)

 - [ApiUserTokenExistsDTO](docs/ApiUserTokenExistsDTO.md)

 - [ApiVersionChangeOptionDTO](docs/ApiVersionChangeOptionDTO.md)

 - [ApiWaivedPolicyViolationDTO](docs/ApiWaivedPolicyViolationDTO.md)

 - [ApiWaiverOptionsDTO](docs/ApiWaiverOptionsDTO.md)

 - [ApplicableContext](docs/ApplicableContext.md)

 - [ApplicableLabels](docs/ApplicableLabels.md)

 - [ApplicableTagsDTO](docs/ApplicableTagsDTO.md)

 - [ApplicationTag](docs/ApplicationTag.md)

 - [ApplicationTagsByOwnerDTO](docs/ApplicationTagsByOwnerDTO.md)

 - [AppliedTagsDTO](docs/AppliedTagsDTO.md)

 - [AttachmentText](docs/AttachmentText.md)

 - [AttributionReportTemplateDTO](docs/AttributionReportTemplateDTO.md)

 - [ComponentDisplayName](docs/ComponentDisplayName.md)

 - [ComponentDisplayNamePart](docs/ComponentDisplayNamePart.md)

 - [ComponentFact](docs/ComponentFact.md)

 - [ComponentIdentifier](docs/ComponentIdentifier.md)

 - [ComponentLocator](docs/ComponentLocator.md)

 - [ComponentObligationAttributionDTO](docs/ComponentObligationAttributionDTO.md)

 - [ConditionFact](docs/ConditionFact.md)

 - [ConfigurationValidationResult](docs/ConfigurationValidationResult.md)

 - [ConstraintFact](docs/ConstraintFact.md)

 - [CweId](docs/CweId.md)

 - [DevelopmentPrioritizationResults](docs/DevelopmentPrioritizationResults.md)

 - [FormDataContentDisposition](docs/FormDataContentDisposition.md)

 - [GetSuggestedRemediationForComponent200Response](docs/GetSuggestedRemediationForComponent200Response.md)

 - [GroupingByDTO](docs/GroupingByDTO.md)

 - [IdeUsersOverviewDTO](docs/IdeUsersOverviewDTO.md)

 - [ImportSbomRequest](docs/ImportSbomRequest.md)

 - [InnerSourceData](docs/InnerSourceData.md)

 - [LabelsByOwner](docs/LabelsByOwner.md)

 - [LegalSourceLinkDTO](docs/LegalSourceLinkDTO.md)

 - [License](docs/License.md)

 - [LicenseObligationDTO](docs/LicenseObligationDTO.md)

 - [LicenseThreatGroupDTO](docs/LicenseThreatGroupDTO.md)

 - [MalwareDefenseData](docs/MalwareDefenseData.md)

 - [MalwareDefenseResponseList](docs/MalwareDefenseResponseList.md)

 - [PolicyAlert](docs/PolicyAlert.md)

 - [PolicyEvaluationResult](docs/PolicyEvaluationResult.md)

 - [PolicyFact](docs/PolicyFact.md)

 - [PolicyOwner](docs/PolicyOwner.md)

 - [PolicyTag](docs/PolicyTag.md)

 - [PrioritizedComponent](docs/PrioritizedComponent.md)

 - [ReferenceLink](docs/ReferenceLink.md)

 - [RootCause](docs/RootCause.md)

 - [SBOMVulnerabilityAnalysisRequest](docs/SBOMVulnerabilityAnalysisRequest.md)

 - [SbomComponentDTO](docs/SbomComponentDTO.md)

 - [SbomComponentListDTO](docs/SbomComponentListDTO.md)

 - [SearchResultDTO](docs/SearchResultDTO.md)

 - [SearchResultItemDTO](docs/SearchResultItemDTO.md)

 - [SecurityVulnerabilityCustomData](docs/SecurityVulnerabilityCustomData.md)

 - [SecurityVulnerabilityData](docs/SecurityVulnerabilityData.md)

 - [SecurityVulnerabilitySeverity](docs/SecurityVulnerabilitySeverity.md)

 - [SecurityVulnerabilityWeakness](docs/SecurityVulnerabilityWeakness.md)

 - [StageData](docs/StageData.md)

 - [Swid](docs/Swid.md)

 - [SystemConfig](docs/SystemConfig.md)

 - [SystemConfigProperty](docs/SystemConfigProperty.md)

 - [TagsByOwnerDTO](docs/TagsByOwnerDTO.md)

 - [ThirdPartySbomMetadataSummaryDTO](docs/ThirdPartySbomMetadataSummaryDTO.md)

 - [ThirdPartySbomMetadataSummaryListDTO](docs/ThirdPartySbomMetadataSummaryListDTO.md)

 - [TriggerReference](docs/TriggerReference.md)

 - [ValidationResult](docs/ValidationResult.md)

 - [VulnerabilityAnalysis](docs/VulnerabilityAnalysis.md)

 - [VulnerabilitySource](docs/VulnerabilitySource.md)

## Documentation For Authorization

Authentication schemes defined for the API:

### BasicAuth

- **Type**: HTTP basic authentication

Example

```go

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