# AuditControllerApi

All URIs are relative to *http://localhost:8081*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**auditIntegrityStatus**](#auditintegritystatus) | **GET** /api/v1/audit/verify/status | Last scheduled audit chain verification|
|[**getAuditTrail**](#getaudittrail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource|
|[**searchAuditTrail**](#searchaudittrail) | **POST** /api/v1/audit/search | Search for audit trails|
|[**verifyChain**](#verifychain) | **GET** /api/v1/audit/verify | Verify audit chain integrity|

# **auditIntegrityStatus**
> AuditIntegrityStatusResponse auditIntegrityStatus()

Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.

### Example

```typescript
import {
    AuditControllerApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new AuditControllerApi(configuration);

const { status, data } = await apiInstance.auditIntegrityStatus();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**AuditIntegrityStatusResponse**

### Authorization

[keycloak_auth](../README.md#keycloak_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: */*


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getAuditTrail**
> Array<AuditLog> getAuditTrail()

Retrieves the audit trail for a given resource.

### Example

```typescript
import {
    AuditControllerApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new AuditControllerApi(configuration);

let id: string; //ID of the resource to get the audit trail for (default to undefined)
let sort: 'ASC' | 'DESC'; //Sort order for the audit trail. Can be \'ASC\' or \'DESC\'. Default is \'DESC\' (optional) (default to undefined)

const { status, data } = await apiInstance.getAuditTrail(
    id,
    sort
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | ID of the resource to get the audit trail for | defaults to undefined|
| **sort** | [**&#39;ASC&#39; | &#39;DESC&#39;**]**Array<&#39;ASC&#39; &#124; &#39;DESC&#39;>** | Sort order for the audit trail. Can be \&#39;ASC\&#39; or \&#39;DESC\&#39;. Default is \&#39;DESC\&#39; | (optional) defaults to undefined|


### Return type

**Array<AuditLog>**

### Authorization

[keycloak_auth](../README.md#keycloak_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: */*


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **searchAuditTrail**
> Array<AuditLog> searchAuditTrail(searchByAuditLogRequest)

Retrieves the audit trail according to the search parameters

### Example

```typescript
import {
    AuditControllerApi,
    Configuration,
    SearchByAuditLogRequest
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new AuditControllerApi(configuration);

let searchByAuditLogRequest: SearchByAuditLogRequest; //

const { status, data } = await apiInstance.searchAuditTrail(
    searchByAuditLogRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **searchByAuditLogRequest** | **SearchByAuditLogRequest**|  | |


### Return type

**Array<AuditLog>**

### Authorization

[keycloak_auth](../README.md#keycloak_auth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: */*


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **verifyChain**
> AuditVerificationResult verifyChain()

Verifies the cryptographic hash chain of the audit log to detect any tampering.

### Example

```typescript
import {
    AuditControllerApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new AuditControllerApi(configuration);

const { status, data } = await apiInstance.verifyChain();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**AuditVerificationResult**

### Authorization

[keycloak_auth](../README.md#keycloak_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: */*


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)