sonatype-guide-api-client

REST API into Sonatype Guide.

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

• API version: 202609
• Package version: 1.0.0
• Generator version: 7.16.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/sonatype-nexus-community

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/sonatype-guide-api-client.git

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

Then import the package:

import sonatype_guide_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_guide_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import sonatype_guide_api_client
from sonatype_guide_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.guide.sonatype.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sonatype_guide_api_client.Configuration(
    host = "https://api.guide.sonatype.com"
)

# 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 Bearer authorization (JWT): bearer-jwt
configuration = sonatype_guide_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


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

    try:
        # Get the caller's currently-running bulk onboarding job, if any
        api_response = api_instance.active()
        print("The response of AGPBulkOnboardingApi->active:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AGPBulkOnboardingApi->active: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.guide.sonatype.com

Documentation For Models

• AgenticModeAccessResponse
• ApiSearchResponse
• ApiSearchResponseAffectedComponentVersion
• ApiSearchResponseComponentDetailDocument
• ApiSearchResponseComponentDocument
• ApiSearchResponseVulnerabilityDocument
• BillingDTO
• BulkOnboardRequest
• BulkOnboardResponse
• BulkRemoveMembersRequest
• ComponentDetailDocument
• ComponentDocument
• ComponentReportGet
• ComponentReportPost
• CreateTokenRequest
• CumulativeCreditUsage
• DailyCreditUsage
• DashboardPageResponse
• DashboardRowResponse
• DtsDimensions
• EffectiveConfigYamlResponse
• FromVersion
• GovernanceWriteResponse
• InviteUsersRequest
• Invoice
• ItemProgress
• JobProgress
• LatestVersionRequest
• MethodSignature
• OnboardingAccessResponse
• OnboardingBannerStatusDTO
• OrgActivityLogEntry
• OrgActivityLogResponse
• OrgConfigRequest
• OrgGovernanceView
• OrgOnboardingActivity
• OrganizationDTO
• OrganizationMembersResponse
• OssiMonthlyUsage
• OssiUsageDataRange
• OssiUsageHistoryDTO
• OssiUsageSummary
• OssiVulnerabilityGet
• OssiVulnerabilityPost
• PeriodDTO
• PlanDTO
• PolicyCompliance
• PolicyConditionResult
• PurlRequestPost
• RecommendationRequest
• RecommendationResponse
• RecommendationVulnerableMethod
• RecommendedVersion
• Reference
• RemovalPrResult
• RepoConfigRequest
• RepoGovernanceView
• RotateTokenRequest
• SecurityEventDetailDocument
• UpdateOrganizationRequest
• UsageDTO
• UserTokenDTO
• UserTokenWithPlaintextDTO
• VulnerabilityDetailDocument
• VulnerabilityDocument
• VulnerableMethod

Documentation For Authorization

Authentication schemes defined for the API:

bearer-jwt

• Type: Bearer authentication (JWT)

ossi-basic-auth

• Type: HTTP basic authentication

user-token

• Type: Bearer authentication

Author

community@sonatype.com