Metadata-Version: 2.4
Name: credoxa-audit-sdk
Version: 1.0.0
Summary: Credoxa Audit API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
License-Expression: LicenseRef-Proprietary
Keywords: OpenAPI,OpenAPI-Generator,Credoxa Audit API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# 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](https://openapi-generator.tech) 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:

```sh
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:
```python
import credoxa_audit
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import credoxa_audit
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuditEventsApi* | [**get_audit_event**](docs/AuditEventsApi.md#get_audit_event) | **GET** /v1/audit/events/{event_id} | Retrieve the audit record for an event
*AuditEventsApi* | [**publish_audit_event**](docs/AuditEventsApi.md#publish_audit_event) | **POST** /v1/audit/events | Publish an audit event
*AuditIntegrityApi* | [**verify_audit_integrity_range**](docs/AuditIntegrityApi.md#verify_audit_integrity_range) | **GET** /v1/audit/integrity/ranges | Verify an audit integrity range
*AuditIntegrityApi* | [**verify_audit_record_integrity**](docs/AuditIntegrityApi.md#verify_audit_record_integrity) | **GET** /v1/audit/integrity/records/{record_id} | Verify integrity of an audit record
*AuditRecordsApi* | [**get_audit_record**](docs/AuditRecordsApi.md#get_audit_record) | **GET** /v1/audit/records/{record_id} | Retrieve an audit record
*AuditRecordsApi* | [**list_audit_records**](docs/AuditRecordsApi.md#list_audit_records) | **GET** /v1/audit/records | List audit records
*AuditSearchApi* | [**search_audit_records**](docs/AuditSearchApi.md#search_audit_records) | **GET** /v1/audit/search | Search audit records


## Documentation For Models

 - [ActorKind](docs/ActorKind.md)
 - [AuditOutcome](docs/AuditOutcome.md)
 - [AuditProvenance](docs/AuditProvenance.md)
 - [AuditRecord](docs/AuditRecord.md)
 - [AuditRecordPage](docs/AuditRecordPage.md)
 - [AuditRecordPageResponse](docs/AuditRecordPageResponse.md)
 - [AuditRecordResponse](docs/AuditRecordResponse.md)
 - [AuditTarget](docs/AuditTarget.md)
 - [ChainVerificationStatus](docs/ChainVerificationStatus.md)
 - [Error](docs/Error.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [EvidenceContinuityStatus](docs/EvidenceContinuityStatus.md)
 - [IntegrityPositionResult](docs/IntegrityPositionResult.md)
 - [IntegrityPositionStatus](docs/IntegrityPositionStatus.md)
 - [IntegrityRangeResponse](docs/IntegrityRangeResponse.md)
 - [IntegrityRangeResult](docs/IntegrityRangeResult.md)
 - [PublishAuditEventRequest](docs/PublishAuditEventRequest.md)
 - [RecordIntegrityResponse](docs/RecordIntegrityResponse.md)
 - [RecordIntegrityResult](docs/RecordIntegrityResult.md)
 - [RecordVerificationStatus](docs/RecordVerificationStatus.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication


## Author




