sonatype-guide-api-client 1.202606.1

Sonatype Guide API

sonatype-guide-api-client

REST API into Sonatype Guide.

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

• API version: 202606
• 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.BillingApi(api_client)

    try:
        # Get billing information
        api_response = api_instance.get_billing()
        print("The response of BillingApi->get_billing:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BillingApi->get_billing: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
BillingApi	get_billing	GET /billing	Get billing information
BillingApi	get_invoice_pdf	GET /billing/invoices/{invoiceId}/pdf	Download invoice PDF
BillingApi	get_plans	GET /billing/plans	Get all available plans
BillingApi	get_user_invoice_history	GET /billing/invoices	Get user invoice history
ComponentsApi	get_component_dependencies_by_purl_query_param	GET /components/dependencies	Get dependencies for a component by coordinates (query parameters)
ComponentsApi	get_component_detail_by_purl_query_param	GET /components/detail	Get component detail by coordinates (query parameters)
ComponentsApi	get_component_versions_by_purl_query_param	GET /components/versions	Get all component versions by coordinates (query parameters)
ComponentsApi	get_component_vulnerabilities_by_purl_query_param	GET /components/vulnerabilities	Get vulnerabilities for a component by coordinates (query parameters)
ComponentsApi	get_latest_version	POST /components/latest-version	Get latest version of a component
CurrentUserOrganizationApi	accept_invitation	POST /users/me/organization/invitations/{invitationToken}/accept	Accept organization invitation
CurrentUserOrganizationApi	bulk_remove_members_or_invitations	DELETE /users/me/organization/members	Bulk remove members or invitations from organization
CurrentUserOrganizationApi	dismiss_onboarding_banner	DELETE /users/me/organization/onboarding-banner	Dismiss onboarding banner
CurrentUserOrganizationApi	get_current_user_organization	GET /users/me/organization	Get current user's organization
CurrentUserOrganizationApi	get_onboarding_banner_status	GET /users/me/organization/onboarding-banner	Get onboarding banner status
CurrentUserOrganizationApi	invite_users	POST /users/me/organization/members/invite	Invite users to current user's an organization
CurrentUserOrganizationApi	leave_organization	DELETE /users/me/organization/membership	Leave organization
CurrentUserOrganizationApi	remove_member_or_invitation	DELETE /users/me/organization/members/{email}	Remove member or invitation from organization
CurrentUserOrganizationApi	retrieve_organization_members_as_csv	GET /users/me/organization/members	Retrieve current user's organization members and invitees
CurrentUserOrganizationApi	update_organization	PUT /users/me/organization	Update current user's organization
CurrentUserTokensApi	create_token	POST /users/me/tokens	Create a new Personal Access Token
CurrentUserTokensApi	get_token_by_id	GET /users/me/tokens/{tokenId}	Get a Personal Access Token by ID
CurrentUserTokensApi	list_tokens	GET /users/me/tokens	List all Personal Access Tokens
CurrentUserTokensApi	revoke_token	DELETE /users/me/tokens/{tokenId}	Revoke a Personal Access Token
OSSIndexCompatibilityApi	get_component_report	GET /api/v3/authorized/component-report/**	Get component report by PURL
OSSIndexCompatibilityApi	get_component_report1	GET /api/v3/component-report/**	Get component report by PURL
OSSIndexCompatibilityApi	get_component_reports	POST /api/v3/component-report	Get component reports for multiple PURLs
OSSIndexCompatibilityApi	get_component_reports1	POST /api/v3/authorized/component-report	Get component reports for multiple PURLs
OSSIndexCompatibilityApi	get_version	GET /api/v3/version	Get API version
RecommendationsApi	get_recommendations	POST /recommendations	Get version upgrade recommendations
UsageApi	get_credit_periods	GET /usage/credit-periods	Get credit periods
UsageApi	get_cumulative_usage	GET /usage/cumulative	Get cumulative credit usage for a billing period
UsageApi	get_ossi_usage_history	GET /usage/ossi-history	Get historical OSSI usage
UsageApi	get_usage	GET /usage	Get usage information
VulnerabilitiesApi	get_vulnerability_affected_components	GET /vulnerabilities/{id}/components	Get affected components for a vulnerability
VulnerabilitiesApi	get_vulnerability_by_ref_id	GET /vulnerabilities/{id}	Get vulnerability by ID

Documentation For Models

• ApiSearchResponse
• ApiSearchResponseAffectedComponentVersion
• ApiSearchResponseComponentDetailDocument
• ApiSearchResponseComponentDocument
• ApiSearchResponseVulnerabilityDocument
• BillingDTO
• BulkRemoveMembersRequest
• ComponentDetailDocument
• ComponentDocument
• ComponentReportGet
• ComponentReportPost
• CreateTokenRequest
• CumulativeCreditUsage
• DailyCreditUsage
• DtsDimensions
• FromVersion
• InviteUsersRequest
• Invoice
• LatestVersionRequest
• MethodSignature
• OnboardingBannerStatusDTO
• OrganizationDTO
• OrganizationMembersResponse
• OssiMonthlyUsage
• OssiUsageDataRange
• OssiUsageHistoryDTO
• OssiUsageSummary
• OssiVulnerabilityGet
• OssiVulnerabilityPost
• PeriodDTO
• PlanDTO
• PolicyCompliance
• PolicyConditionResult
• PurlRequestPost
• RecommendationRequest
• RecommendationResponse
• RecommendationVulnerableMethod
• RecommendedVersion
• Reference
• 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

[e-mail]