credoxa-audit-sdk

Public API contract for the Credoxa Audit service.

Authentication is provider-neutral. Consumers present an external bearer credential which is verified by the configured authentication adapter before Credoxa Audit establishes tenant/platform, actor, and capability authority.

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

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.14.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/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import credoxa_audit

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 credoxa_audit

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import credoxa_audit
from credoxa_audit.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 = credoxa_audit.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 Bearer authorization: bearerAuth
configuration = credoxa_audit.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with credoxa_audit.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = credoxa_audit.AuditEventsApi(api_client)
    event_id = 'event_id_example' # str | 

    try:
        # Retrieve the audit record for an event
        api_response = api_instance.get_audit_event(event_id)
        print("The response of AuditEventsApi->get_audit_event:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuditEventsApi->get_audit_event: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• ActorKind
• AuditOutcome
• AuditProvenance
• AuditRecord
• AuditRecordPage
• AuditRecordPageResponse
• AuditRecordResponse
• AuditTarget
• ChainVerificationStatus
• Error
• ErrorResponse
• EvidenceContinuityStatus
• IntegrityPositionResult
• IntegrityPositionStatus
• IntegrityRangeResponse
• IntegrityRangeResult
• PublishAuditEventRequest
• RecordIntegrityResponse
• RecordIntegrityResult
• RecordVerificationStatus

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication

Author