Skip to main content

sonatype-iq-api-client

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

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.204.1-01
  • Package version: 1.0.0
  • Generator version: 7.16.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/sonatype-nexus-community/nexus-iq-api-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/sonatype-nexus-community/nexus-iq-api-client.git)

Then import the package:

import sonatype_iq_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import sonatype_iq_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import sonatype_iq_api_client
from sonatype_iq_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = sonatype_iq_api_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = sonatype_iq_api_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): BearerAuth
configuration = sonatype_iq_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with sonatype_iq_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonatype_iq_api_client.AdvancedSearchApi(api_client)

    try:
        api_instance.create_search_index_async()
    except ApiException as e:
        print("Exception when calling AdvancedSearchApi->create_search_index_async: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AdvancedSearchApi create_search_index_async POST /api/v2/search/advanced/index
AdvancedSearchApi get_export_results GET /api/v2/search/advanced/export/csv
AdvancedSearchApi search_index GET /api/v2/search/advanced
ApplicationCategoriesApi add_tag POST /api/v2/applicationCategories/organization/{organizationId}
ApplicationCategoriesApi delete_tag DELETE /api/v2/applicationCategories/organization/{organizationId}/{tagId}
ApplicationCategoriesApi get_applicable_tags GET /api/v2/applicationCategories/organization/{organizationId}/applicable
ApplicationCategoriesApi get_applicable_tags_by_application_public_id GET /api/v2/applicationCategories/application/{applicationPublicId}/applicable
ApplicationCategoriesApi get_application_applicable_tags GET /api/v2/applicationCategories/application/{applicationPublicId}
ApplicationCategoriesApi get_applied_policy_tags GET /api/v2/applicationCategories/organization/{organizationId}/policy
ApplicationCategoriesApi get_applied_tags GET /api/v2/applicationCategories/organization/{organizationId}/applied
ApplicationCategoriesApi get_tags GET /api/v2/applicationCategories/organization/{organizationId}
ApplicationCategoriesApi get_tags_used_by_applications GET /api/v2/applicationCategories/application
ApplicationCategoriesApi update_tag PUT /api/v2/applicationCategories/organization/{organizationId}
ApplicationReportDataApi get_data GET /api/v2/applications/{applicationPublicId}/reports/{scanId}
ApplicationReportDataApi get_dependency_tree GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/dependencyTree
ApplicationReportDataApi get_policy_violation_diff GET /api/v2/applications/{applicationPublicId}/reports/policyViolations/diff
ApplicationReportDataApi get_policy_violations1 GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/policy
ApplicationReportDataApi get_raw_data GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/raw
ApplicationsApi add_application POST /api/v2/applications
ApplicationsApi clone_application POST /api/v2/applications/{sourceApplicationId}/clone
ApplicationsApi delete_application DELETE /api/v2/applications/{applicationId}
ApplicationsApi get_application GET /api/v2/applications/{applicationId}
ApplicationsApi get_applications GET /api/v2/applications
ApplicationsApi get_applications_by_organization_id GET /api/v2/applications/organization/{organizationId}
ApplicationsApi move_application POST /api/v2/applications/{applicationId}/move/organization/{organizationId}
ApplicationsApi update_application PUT /api/v2/applications/{applicationId}
AuditLogsApi get_audit_logs GET /api/v2/auditLogs
AutoPolicyWaiverExclusionsApi add_auto_policy_waive_exclusion POST /api/v2/autoPolicyWaiverExclusions/{ownerType}/{ownerId}
AutoPolicyWaiverExclusionsApi delete_auto_policy_waiver_exclusion DELETE /api/v2/autoPolicyWaiverExclusions/{ownerType}/{ownerId}/{autoPolicyWaiverId}/{autoPolicyWaiverExclusionId}
AutoPolicyWaiverExclusionsApi get_auto_policy_waiver_exclusions GET /api/v2/autoPolicyWaiverExclusions/{ownerType}/{ownerId}/{autoPolicyWaiverId}
AutoPolicyWaiversApi add_auto_policy_waiver POST /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}
AutoPolicyWaiversApi add_auto_policy_waivers POST /api/v2/autoPolicyWaivers/v2/{ownerType}/{ownerId}
AutoPolicyWaiversApi delete_auto_policy_waiver DELETE /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/{autoPolicyWaiverId}
AutoPolicyWaiversApi get_applicable_auto_waivers GET /api/v2/autoPolicyWaivers/v2/{ownerType}/{ownerId}/applicableAutoWaivers
AutoPolicyWaiversApi get_auto_policy_waiver GET /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/{autoPolicyWaiverId}
AutoPolicyWaiversApi get_auto_policy_waiver_status GET /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/status
AutoPolicyWaiversApi get_auto_policy_waivers GET /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}
AutoPolicyWaiversApi update_auto_policy_waiver PUT /api/v2/autoPolicyWaivers/{ownerType}/{ownerId}/{autoPolicyWaiverId}
CIConfigurationApi delete_configuration DELETE /api/v2/config/ci/{ownerType}/{ownerId}
CIConfigurationApi get_configuration GET /api/v2/config/ci/{ownerType}/{ownerId}
CIConfigurationApi set_configuration PUT /api/v2/config/ci/{ownerType}/{ownerId}
CPEMatchingConfigurationApi get_cpe_matching_configuration GET /api/v2/{ownerType}/{internalOwnerId}/configuration/publicSource/cpe
CPEMatchingConfigurationApi update_cpe_matching_configuration 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 get_all GET /api/v2/claim/components
ClaimComponentsApi set POST /api/v2/claim/components
ComponentLabelsApi add_label POST /api/v2/labels/{ownerType}/{ownerId}
ComponentLabelsApi delete_label DELETE /api/v2/labels/{ownerType}/{ownerId}/{labelId}
ComponentLabelsApi get_applicable_contexts GET /api/v2/labels/{ownerType}/{ownerId}/applicable/context/{labelId}
ComponentLabelsApi get_applicable_labels GET /api/v2/labels/{ownerType}/{ownerId}/applicable
ComponentLabelsApi get_labels GET /api/v2/labels/{ownerType}/{ownerId}
ComponentLabelsApi update_label PUT /api/v2/labels/{ownerType}/{ownerId}
ComponentSearchApi export_component_search_report GET /api/v2/componentSearch/downloadComponentSearchReport
ComponentSearchApi get_cve_affected_components GET /api/v2/componentSearch/cveAffectedComponents
ComponentSearchApi search_component GET /api/v2/search/component
ComponentsApi delete_component_label DELETE /api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}
ComponentsApi get_component_details POST /api/v2/components/details
ComponentsApi get_component_versions POST /api/v2/components/versions
ComponentsApi get_suggested_remediation_for_component POST /api/v2/components/remediation/{ownerType}/{ownerId}
ComponentsApi set_component_label POST /api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}
CompositeSourceControlApi get_composite_source_control_by_owner GET /api/v2/compositeSourceControl/{ownerType}/{internalOwnerId}
CompositeSourceControlValidatorApi validate_source_control_config GET /api/v2/compositeSourceControlConfigValidator/application/{applicationId}
ConfigCrowdApi delete_crowd_configuration DELETE /api/v2/config/crowd
ConfigCrowdApi get_crowd_configuration GET /api/v2/config/crowd
ConfigCrowdApi insert_or_update_crowd_configuration PUT /api/v2/config/crowd
ConfigCrowdApi test_crowd_configuration POST /api/v2/config/crowd/test
ConfigJiraApi delete_configuration2 DELETE /api/v2/config/jira
ConfigJiraApi get_configuration2 GET /api/v2/config/jira
ConfigJiraApi set_configuration2 PUT /api/v2/config/jira
ConfigMailApi delete_configuration3 DELETE /api/v2/config/mail
ConfigMailApi get_configuration3 GET /api/v2/config/mail
ConfigMailApi set_configuration3 PUT /api/v2/config/mail
ConfigMailApi test_configuration POST /api/v2/config/mail/test/{recipientEmail}
ConfigOIDCApi delete_oidc_configuration DELETE /api/v2/config/oidc
ConfigOIDCApi get_oidc_configuration GET /api/v2/config/oidc
ConfigOIDCApi insert_or_update_oidc_configuration PUT /api/v2/config/oidc
ConfigProxyServerApi delete_configuration4 DELETE /api/v2/config/httpProxyServer
ConfigProxyServerApi get_configuration4 GET /api/v2/config/httpProxyServer
ConfigProxyServerApi set_configuration4 PUT /api/v2/config/httpProxyServer
ConfigReverseProxyAuthenticationApi delete_configuration5 DELETE /api/v2/config/reverseProxyAuthentication
ConfigReverseProxyAuthenticationApi get_configuration5 GET /api/v2/config/reverseProxyAuthentication
ConfigReverseProxyAuthenticationApi set_configuration5 PUT /api/v2/config/reverseProxyAuthentication
ConfigSAMLApi delete_saml_configuration DELETE /api/v2/config/saml
ConfigSAMLApi get_metadata GET /api/v2/config/saml/metadata
ConfigSAMLApi get_saml_configuration GET /api/v2/config/saml
ConfigSAMLApi insert_or_update_saml_configuration PUT /api/v2/config/saml
ConfigSourceControlApi delete_configuration7 DELETE /api/v2/config/sourceControl
ConfigSourceControlApi get_configuration7 GET /api/v2/config/sourceControl
ConfigSourceControlApi set_configuration6 PUT /api/v2/config/sourceControl
ConfigZscalerApi delete_all_categories DELETE /api/v2/config/zscaler/update
ConfigZscalerApi delete_category DELETE /api/v2/config/zscaler/update/{format}
ConfigZscalerApi delete_configuration8 DELETE /api/v2/config/zscaler
ConfigZscalerApi get_configuration9 GET /api/v2/config/zscaler
ConfigZscalerApi get_quota GET /api/v2/config/zscaler/zscalerLimits
ConfigZscalerApi set_configuration7 PUT /api/v2/config/zscaler
ConfigZscalerApi test_configuration1 POST /api/v2/config/zscaler/testConfig
ConfigZscalerApi trigger_update POST /api/v2/config/zscaler/update/{format}
ConfigZscalerApi trigger_update_all POST /api/v2/config/zscaler/update
ConfigurationApi delete_configuration1 DELETE /api/v2/config
ConfigurationApi get_configuration1 GET /api/v2/config
ConfigurationApi invalidate_cache DELETE /api/v2/config/integrationVersions/cache
ConfigurationApi set_configuration1 PUT /api/v2/config
ConfigureArtifactoryConnectionApi add_artifactory_connection POST /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
ConfigureArtifactoryConnectionApi delete_artifactory_connection DELETE /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
ConfigureArtifactoryConnectionApi get_artifactory_connection GET /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
ConfigureArtifactoryConnectionApi get_owner_artifactory_connection GET /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
ConfigureArtifactoryConnectionApi test_artifactory_connection POST /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/test
ConfigureArtifactoryConnectionApi test_artifactory_connection1 POST /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}/test
ConfigureArtifactoryConnectionApi update_artifactory_connection PUT /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}
ConfigureArtifactoryConnectionApi update_owner_artifactory_connection_status PUT /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}
ConsumptionApi export_csv GET /api/v2/consumption/export
ConsumptionApi get_daily_history GET /api/v2/consumption/daily-history
ConsumptionApi get_history GET /api/v2/consumption/history
ConsumptionApi get_history_breakdown GET /api/v2/consumption/history/breakdown
ConsumptionApi get_history_by_source GET /api/v2/consumption/history/by-source
ConsumptionApi get_summary GET /api/v2/consumption/summary
ConsumptionApi get_top_apps GET /api/v2/consumption/top-apps
CycloneDXApi get_by_report_id GET /api/v2/cycloneDx/{cdxVersion}/{applicationId}/reports/{reportId}
CycloneDXApi get_latest GET /api/v2/cycloneDx/{cdxVersion}/{applicationId}/stages/{stageId}
DataRetentionPoliciesApi get_data_retention_policies GET /api/v2/dataRetentionPolicies/organizations/{organizationId}
DataRetentionPoliciesApi get_parent_data_retention_policies GET /api/v2/dataRetentionPolicies/organizations/{organizationId}/parent
DataRetentionPoliciesApi set_data_retention_policies PUT /api/v2/dataRetentionPolicies/organizations/{organizationId}
DeveloperPrioritiesApi get_priorities GET /api/v2/developer/priorities/{applicationId}/{scanId}
DeveloperPrioritiesApi get_priorities_export GET /api/v2/developer/priorities/{applicationId}/{scanId}/export
EndpointsApi get_open_api GET /api/v2/endpoints/{apiType}
FeatureConfigurationApi disable_feature DELETE /api/v2/config/features/{feature}
FeatureConfigurationApi enabled_feature POST /api/v2/config/features/{feature}
FirewallApi add_bulk_waivers POST /api/v2/firewall/repositories/{ownerType}/{ownerId}/waivers/bulk
FirewallApi add_proprietary_component_names POST /api/v2/firewall/namespace_confusion/{format}
FirewallApi add_repository_manager POST /api/v2/firewall/repositoryManagers
FirewallApi add_waiver POST /api/v2/firewall/container-image/{containerImageId}/policyWaiver
FirewallApi configure_repositories POST /api/v2/firewall/repositories/configuration/{repositoryManagerId}
FirewallApi delete_container_image_policy_waiver DELETE /api/v2/firewall/container-image/{containerImageId}/policyWaiver
FirewallApi delete_repository_manager DELETE /api/v2/firewall/repositoryManagers/{repositoryManagerId}
FirewallApi evaluate_components1 POST /api/v2/firewall/components/{repositoryManagerId}/{repositoryId}/evaluate
FirewallApi evaluate_malware POST /api/v2/malware-defense/evaluate
FirewallApi get_cascade_status GET /api/v2/firewall/repositories/cascade-reevaluate/status/{requestId}
FirewallApi get_configured_repositories GET /api/v2/firewall/repositories/configuration/{repositoryManagerId}
FirewallApi get_container_images_in_quarantine GET /api/v2/firewall/container-image/policyViolations/quarantined
FirewallApi get_firewall_auto_unquarantine_config GET /api/v2/firewall/releaseQuarantine/configuration
FirewallApi get_firewall_metrics GET /api/v2/firewall/metrics/embedded
FirewallApi get_firewall_unquarantine_summary GET /api/v2/firewall/releaseQuarantine/summary
FirewallApi get_malware_defense_metrics GET /api/v2/malware-defense/metrics
FirewallApi get_quarantine_list GET /api/v2/firewall/components/quarantined
FirewallApi get_quarantine_summary GET /api/v2/firewall/quarantine/summary
FirewallApi get_quarantined_component_view_anonymous_access GET /api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess
FirewallApi get_repository_container GET /api/v2/firewall/repositoryContainer
FirewallApi get_repository_manager GET /api/v2/firewall/repositoryManagers/{repositoryManagerId}
FirewallApi get_repository_managers GET /api/v2/firewall/repositoryManagers
FirewallApi get_unquarantine_list GET /api/v2/firewall/components/autoReleasedFromQuarantine
FirewallApi get_waivers GET /api/v2/firewall/container-image/policyWaiver
FirewallApi initiate_cascade_reevaluation POST /api/v2/firewall/repositories/cascade-reevaluate/componentHash/{componentHash}
FirewallApi remove_proprietary_component_names DELETE /api/v2/firewall/namespace_confusion/{format}
FirewallApi set_firewall_auto_unquarantine_config PUT /api/v2/firewall/releaseQuarantine/configuration
FirewallApi set_quarantined_component_view_anonymous_access PUT /api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess/{enabled}
FirewallApi verify_connection_and_get_applications GET /api/v2/firewall/connection/verify
GitHubAppApi delete_git_hub_app DELETE /api/v2/githubApp/{githubAppId} Delete a GitHub App
GitHubAppApi list_git_hub_apps GET /api/v2/githubApp List GitHub Apps for an owner
GitHubAppConfigurationApi delete_git_hub_app DELETE /api/v2/githubApp/{githubAppId} Delete a GitHub App
GitHubAppConfigurationApi generate_manifest POST /api/v2/githubApp/manifest Generate GitHub App manifest
GitHubAppConfigurationApi handle_installation_setup GET /api/v2/githubApp/setupInstallation Handle GitHub App installation setup callback with OAuth + PKCE
GitHubAppConfigurationApi handle_redirect GET /api/v2/githubApp/redirect GitHub App registration redirect callback
GitHubAppConfigurationApi list_git_hub_apps GET /api/v2/githubApp List GitHub Apps for an owner
LicenseLegalMetadataReportApi get_license_legal_application_html_report GET /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report
LicenseLegalMetadataReportApi get_license_legal_application_report GET /api/v2/licenseLegalMetadata/application/{applicationId}
LicenseLegalMetadataReportApi get_license_legal_application_report1 GET /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}
LicenseLegalMetadataReportApi get_license_legal_component_report GET /api/v2/licenseLegalMetadata/{ownerType}/{ownerId}/component
LicenseLegalMetadataReportApi get_license_legal_custom_application_html_report POST /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report
LicenseLegalMetadataReportApi get_license_legal_custom_application_html_report1 POST /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report/templateId/{templateId}
LicenseLegalMetadataReportApi get_license_legal_custom_multi_application_html_report1 POST /api/v2/licenseLegalMetadata/multiApplication/report/templateId/{templateId}
LicenseLegalMetadataReportApi get_license_legal_multi_application_html_report POST /api/v2/licenseLegalMetadata/multiApplication/report
LicenseLegalMetadataReportApi get_license_legal_multi_application_report_from_active_user_filter POST /api/v2/licenseLegalMetadata/multiApplication/activeUserFilter/report/templateId/{templateId}
LicenseLegalMetadataTemplateApi delete_attribution_report_template DELETE /api/v2/licenseLegalMetadata/report-template/{id}
LicenseLegalMetadataTemplateApi get_all_attribution_report_templates GET /api/v2/licenseLegalMetadata/report-template
LicenseLegalMetadataTemplateApi get_attribution_report_template_by_id GET /api/v2/licenseLegalMetadata/report-template/{id}
LicenseLegalMetadataTemplateApi save_attribution_report_template POST /api/v2/licenseLegalMetadata/report-template
LicenseOverridesApi add_license_override POST /api/v2/licenseOverrides/{ownerType}/{ownerId}
LicenseOverridesApi delete_license_override DELETE /api/v2/licenseOverrides/{ownerType}/{ownerId}/{licenseOverrideId}
LicenseOverridesApi get_applied_license_overrides GET /api/v2/licenseOverrides/{ownerType}/{ownerId}
LicenseOverridesApi get_applied_license_overrides_for_legal_reviewer GET /api/v2/licenseOverrides/{ownerType}/{ownerId}/legalReviewer
OrganizationsApi add_organization POST /api/v2/organizations
OrganizationsApi delete_organization DELETE /api/v2/organizations/{organizationId}
OrganizationsApi get_organization GET /api/v2/organizations/{organizationId}
OrganizationsApi get_organizations GET /api/v2/organizations
OrganizationsApi get_organizations_by_ids GET /api/v2/organizations/byid
OrganizationsApi move_organization PUT /api/v2/organizations/{organizationId}/move/destination/{destinationId}
PoliciesApi get_policies GET /api/v2/policies
PolicyEvaluationApi evaluate_components POST /api/v2/evaluation/applications/{applicationId}
PolicyEvaluationApi evaluate_source_control POST /api/v2/evaluation/applications/{applicationId}/sourceControlEvaluation
PolicyEvaluationApi get_application_evaluation_status GET /api/v2/evaluation/applications/{applicationId}/status/{statusId}
PolicyEvaluationApi get_component_evaluation GET /api/v2/evaluation/applications/{applicationId}/results/{resultId}
PolicyEvaluationApi promote_scan POST /api/v2/evaluation/applications/{applicationId}/promoteScan
PolicyExportApi export_policies GET /api/v2/policy/{ownerType}/{ownerId}/export Export policy configuration
PolicyViolationDetailsApi get_applicable_auto_waiver GET /api/v2/policyViolations/{violationId}/applicableAutoWaiver
PolicyViolationDetailsApi get_applicable_waiver_requests GET /api/v2/policyViolations/{violationId}/applicableWaiverRequests
PolicyViolationDetailsApi get_applicable_waivers GET /api/v2/policyViolations/{violationId}/applicableWaivers
PolicyViolationDetailsApi get_cross_stage_policy_violation_by_constituent_id GET /api/v2/policyViolations/crossStage
PolicyViolationDetailsApi get_cross_stage_policy_violation_by_id GET /api/v2/policyViolations/crossStage/{violationId}
PolicyViolationDetailsApi get_policy_violations GET /api/v2/policyViolations
PolicyViolationDetailsApi get_similar_waivers GET /api/v2/policyViolations/{violationId}/similarWaivers
PolicyViolationDetailsApi get_transitive_policy_violations_by_app_scan_component GET /api/v2/policyViolations/transitive/{ownerType}/{ownerId}/{scanId}
PolicyViolationDetailsApi get_transitive_policy_violations_by_owner_stage_component GET /api/v2/policyViolations/transitive/{ownerType}/{ownerId}/stages/{stageId}
PolicyWaiverReasonsApi get_policy_waiver_reasons GET /api/v2/policyWaiverReasons
PolicyWaiverRequestsApi add_policy_waiver_request_by_policy_violation_id POST /api/v2/policyWaiverRequests/{ownerType}/{ownerId}/policyViolation/{policyViolationId}
PolicyWaiverRequestsApi get_policy_waiver_request GET /api/v2/policyWaiverRequests/{ownerType}/{ownerId}/{policyWaiverRequestId}
PolicyWaiverRequestsApi review_policy_waiver_request POST /api/v2/policyWaiverRequests/{ownerType}/{ownerId}/review/{policyWaiverRequestId}
PolicyWaiverRequestsApi update_policy_waiver_request PUT /api/v2/policyWaiverRequests/{ownerType}/{ownerId}/{policyWaiverRequestId}
PolicyWaiversApi add_bulk_policy_waivers POST /api/v2/policyWaivers/{ownerType}/{ownerId}
PolicyWaiversApi add_policy_waiver_by_policy_violation_id POST /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyViolationId}
PolicyWaiversApi add_waiver_to_transitive_policy_violations_by_app_scan_component POST /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}
PolicyWaiversApi add_waiver_to_transitive_policy_violations_by_owner_stage_component POST /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/stages/{stageId}
PolicyWaiversApi delete_policy_waiver DELETE /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}
PolicyWaiversApi get_policy_waiver GET /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}
PolicyWaiversApi get_policy_waivers GET /api/v2/policyWaivers/{ownerType}/{ownerId}
PolicyWaiversApi get_transitive_policy_waivers_by_app_scan_component GET /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}
PolicyWaiversApi request_policy_waiver POST /api/v2/policyWaivers/waiverRequests/{policyViolationId}
PolicyWaiversApi update_policy_waiver PUT /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}
ProductLicenseApi install_license POST /api/v2/product/license
ProductLicenseApi uninstall_license DELETE /api/v2/product/license
ReportsApi get_all1 GET /api/v2/reports/applications
ReportsApi get_by_application_id GET /api/v2/reports/applications/{applicationId}
ReportsApi get_components_in_quarantine GET /api/v2/reports/components/quarantined
ReportsApi get_components_with_waivers GET /api/v2/reports/components/waivers
ReportsApi get_metrics POST /api/v2/reports/metrics
ReportsApi get_report_history_for_application GET /api/v2/reports/applications/{applicationId}/history
ReportsApi get_stale_waivers GET /api/v2/reports/waivers/stale
RepositoriesApi get_quarantined_by_path POST /api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames
RepositoriesApi release_quarantine_without_re_eval POST /api/v2/repositories/quarantine/{quarantineId}/release
RepositoriesApi upload_scan POST /api/v2/repositories/{repositoryManagerId}/{repositoryId}/components
RoleMembershipsApi get_bulk_role_memberships_global_or_repository_container GET /api/v2/roleMemberships/{ownerType}/roles
RoleMembershipsApi get_bulk_role_memberships_non_global GET /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/roles
RoleMembershipsApi get_role_memberships_application_or_organization GET /api/v2/roleMemberships/{ownerType}/{internalOwnerId}
RoleMembershipsApi get_role_memberships_global_or_repository_container GET /api/v2/roleMemberships/{ownerType}
RoleMembershipsApi grant_role_membership_application_or_organization PUT /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}
RoleMembershipsApi grant_role_membership_global_or_repository_container PUT /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}
RoleMembershipsApi revoke_role_membership_application_or_organization DELETE /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}
RoleMembershipsApi revoke_role_membership_global_or_repository_container DELETE /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}
RoleMembershipsApi set_bulk_role_members_global_or_repository_container PUT /api/v2/roleMemberships/{ownerType}/role/{roleId}/members
RoleMembershipsApi set_bulk_role_members_non_global PUT /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/members
RolesApi add_role POST /api/v2/roles
RolesApi delete_role DELETE /api/v2/roles/{roleId}
RolesApi get_role_by_id GET /api/v2/roles/{roleId}
RolesApi get_roles GET /api/v2/roles
RolesApi get_template_for_new_role GET /api/v2/roles/new
RolesApi update_role PUT /api/v2/roles/{roleId}
SPDXApi get_by_scan_id GET /api/v2/spdx/{applicationId}/reports/{scanId}
SPDXApi get_latest_for_stage GET /api/v2/spdx/{applicationId}/stages/{stageId}
ScanHealthConfigurationApi delete_configuration6 DELETE /api/v2/config/scanHealth/{ownerType}/{ownerId}
ScanHealthConfigurationApi get_configuration6 GET /api/v2/config/scanHealth/{ownerType}/{ownerId}
ScanHealthConfigurationApi save_configuration PUT /api/v2/config/scanHealth/{ownerType}/{ownerId}
SecurityVulnerabilityOverridesApi get_security_vulnerability_overrides GET /api/v2/securityOverrides
SolutionsApi get_licensed_solutions GET /api/v2/solutions/licensed
SourceControlApi add_source_control POST /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlApi add_user_mappings POST /api/v2/sourceControl/automaticRoleAssignment/userMappings/{organizationId}
SourceControlApi automatic_role_assignment POST /api/v2/sourceControl/automaticRoleAssignment/{publicId}
SourceControlApi delete_source_control DELETE /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlApi delete_user_mappings DELETE /api/v2/sourceControl/automaticRoleAssignment/userMappings/{organizationId}
SourceControlApi get_source_control1 GET /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlApi get_user_mappings_by_owner GET /api/v2/sourceControl/automaticRoleAssignment/userMappings/{ownerType}/{internalOwnerId}
SourceControlApi update_source_control PUT /api/v2/sourceControl/{ownerType}/{internalOwnerId}
SourceControlMetricsApi get_source_control GET /api/v2/sourceControlMetrics/{ownerType}/{internalOwnerId}
ThirdPartyAnalysisApi get_scan_status GET /api/v2/scan/applications/{applicationId}/status/{scanRequestId}
ThirdPartyAnalysisApi scan_components POST /api/v2/scan/applications/{applicationId}/sources/{source}
UserTokenConfigurationApi get_configuration8 GET /api/v2/config/userTokens
UserTokenConfigurationApi reset_configuration DELETE /api/v2/config/userTokens
UserTokenConfigurationApi update_configuration PUT /api/v2/config/userTokens
UserTokensApi create_user_token POST /api/v2/userTokens/currentUser
UserTokensApi delete_current_user_token DELETE /api/v2/userTokens/currentUser
UserTokensApi delete_user_token_by_user_code DELETE /api/v2/userTokens/userCode/{userCode}
UserTokensApi get_current_user_token_create_time GET /api/v2/userTokens/currentUser/createTime
UserTokensApi get_user_token_by_username_and_realm_id GET /api/v2/userTokens/{username}
UserTokensApi get_user_token_exists_for_current_user GET /api/v2/userTokens/currentUser/hasToken
UserTokensApi get_user_tokens_by_created_between_and_realm_id GET /api/v2/userTokens
UserTokensApi purge_user_tokens 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 get_all2 GET /api/v2/users
UsersApi update PUT /api/v2/users/{username}
VulnerabilityDetailsApi get_security_vulnerability_details POST /api/v2/vulnerabilities
VulnerabilityDetailsApi get_security_vulnerability_details1 GET /api/v2/vulnerabilities/{refId}

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BasicAuth

  • Type: HTTP basic authentication

BearerAuth

  • Type: Bearer authentication (JWT)

Author

community@sonatype.com

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sonatype_iq_api_client-0.204.1.tar.gz (350.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sonatype_iq_api_client-0.204.1-py3-none-any.whl (747.3 kB view details)

Uploaded Python 3

File details

Details for the file sonatype_iq_api_client-0.204.1.tar.gz.

File metadata

  • Download URL: sonatype_iq_api_client-0.204.1.tar.gz
  • Upload date:
  • Size: 350.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.13 Linux/6.17.0-1018-azure

File hashes

Hashes for sonatype_iq_api_client-0.204.1.tar.gz
Algorithm Hash digest
SHA256 6d7636656669852c4ef5f91dcdf764293aad8a2d997ac458e58922a0c242aaac
MD5 fe1f78a88c2f132a36dd71d4d6826b04
BLAKE2b-256 90cef4cfd25d96ba7edcaff68b1d5c893edac5baf086bc8448e68c8ed996c8c5

See more details on using hashes here.

File details

Details for the file sonatype_iq_api_client-0.204.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sonatype_iq_api_client-0.204.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d5afa0cac8d9e93508a4cde6ab555f174641d63d133946c855c0a71d05c1df71
MD5 e2f9046ff555e663fca34514893e56ec
BLAKE2b-256 f8830bf78f83e93a391cb781cb7103beb62167484e85275a6eac1448b6628373

See more details on using hashes here.

Release history Release notifications | RSS feed

0.204.2

2 files

This release

0.204.1 This release

2 files

0.204.0

2 files

0.203.2

2 files

0.203.0

2 files

0.201.0

2 files

0.200.0

2 files

0.199.0

2 files

0.198.0

2 files

0.197.3

2 files

0.197.2

2 files

0.197.1

2 files

0.197.0

2 files

0.196.5

2 files

0.196.4

2 files

0.196.3

2 files

0.196.2

2 files

0.196.1

2 files

0.196.0

2 files

0.195.1

2 files

0.195.0

2 files

0.193.3

2 files

0.193.2

2 files

0.193.1

2 files

0.193.0

2 files

0.192.1

2 files

0.192.0

2 files

0.184.3

2 files

0.184.2

2 files

0.184.1

2 files

0.184.0

2 files

0.183.0

2 files

0.177.1

2 files

0.177.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page