Skip to content

Files

Latest commit

 

History

History
389 lines (309 loc) · 18 KB

AuditLogApi.md

File metadata and controls

389 lines (309 loc) · 18 KB

AuditLogApi

All URIs are relative to https://192.168.78.139/KeyfactorAPI

Method HTTP request Description
auditLogDownloadCSV GET /Audit/Download Returns a Comma Separated file containing the audit log entries according to the provided filter
auditLogGetAuditLog GET /Audit/{id} Returns the audit log entry associated with the provided identifier
auditLogGetAuditLogs GET /Audit Returns all audit log entries according to the provided filter and output parameters
auditLogGetRelatedEntities GET /Audit/RelatedEntities Returns the audit log entry associated with the provided keyfactor id
auditLogValidateAuditLog GET /Audit/{id}/Validate Validates the audit log entry associated with the provided keyfactor id

auditLogDownloadCSV

String auditLogDownloadCSV(xKeyfactorRequestedWith, xKeyfactorApiVersion, pqQueryString, pqPageReturned, pqReturnLimit, pqSortField, pqSortAscending)

Returns a Comma Separated file containing the audit log entries according to the provided filter

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.AuditLogApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    AuditLogApi apiInstance = new AuditLogApi(defaultClient);
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    String pqQueryString = "pqQueryString_example"; // String | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2)
    Integer pqPageReturned = 56; // Integer | The current page within the result set to be returned
    Integer pqReturnLimit = 56; // Integer | Maximum number of records to be returned in a single call
    String pqSortField = "pqSortField_example"; // String | Field by which the results should be sorted (view results via Management Portal for sortable columns)
    Integer pqSortAscending = 0; // Integer | Field sort direction [0=ascending, 1=descending]
    try {
      String result = apiInstance.auditLogDownloadCSV(xKeyfactorRequestedWith, xKeyfactorApiVersion, pqQueryString, pqPageReturned, pqReturnLimit, pqSortField, pqSortAscending);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AuditLogApi#auditLogDownloadCSV");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
xKeyfactorRequestedWith String Type of the request [XMLHttpRequest, APIClient] [default to APIClient]
xKeyfactorApiVersion String Desired version of the api, if not provided defaults to v1 [optional] [default to 1]
pqQueryString String Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) [optional]
pqPageReturned Integer The current page within the result set to be returned [optional]
pqReturnLimit Integer Maximum number of records to be returned in a single call [optional]
pqSortField String Field by which the results should be sorted (view results via Management Portal for sortable columns) [optional]
pqSortAscending Integer Field sort direction [0=ascending, 1=descending] [optional] [enum: 0, 1]

Return type

String

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code Description Response headers
200 OK -

auditLogGetAuditLog

Object auditLogGetAuditLog(id, xKeyfactorRequestedWith, xKeyfactorApiVersion)

Returns the audit log entry associated with the provided identifier

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.AuditLogApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    AuditLogApi apiInstance = new AuditLogApi(defaultClient);
    Integer id = 56; // Integer | Keyfactor identifer of the audit entry to be returned
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      Object result = apiInstance.auditLogGetAuditLog(id, xKeyfactorRequestedWith, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AuditLogApi#auditLogGetAuditLog");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id Integer Keyfactor identifer of the audit entry to be returned
xKeyfactorRequestedWith String Type of the request [XMLHttpRequest, APIClient] [default to APIClient]
xKeyfactorApiVersion String Desired version of the api, if not provided defaults to v1 [optional] [default to 1]

Return type

Object

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code Description Response headers
200 OK -

auditLogGetAuditLogs

List<KeyfactorAuditingQueryingAuditLogEntry> auditLogGetAuditLogs(xKeyfactorRequestedWith, xKeyfactorApiVersion, pqQueryString, pqPageReturned, pqReturnLimit, pqSortField, pqSortAscending)

Returns all audit log entries according to the provided filter and output parameters

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.AuditLogApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    AuditLogApi apiInstance = new AuditLogApi(defaultClient);
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    String pqQueryString = "pqQueryString_example"; // String | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2)
    Integer pqPageReturned = 56; // Integer | The current page within the result set to be returned
    Integer pqReturnLimit = 56; // Integer | Maximum number of records to be returned in a single call
    String pqSortField = "pqSortField_example"; // String | Field by which the results should be sorted (view results via Management Portal for sortable columns)
    Integer pqSortAscending = 0; // Integer | Field sort direction [0=ascending, 1=descending]
    try {
      List<KeyfactorAuditingQueryingAuditLogEntry> result = apiInstance.auditLogGetAuditLogs(xKeyfactorRequestedWith, xKeyfactorApiVersion, pqQueryString, pqPageReturned, pqReturnLimit, pqSortField, pqSortAscending);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AuditLogApi#auditLogGetAuditLogs");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
xKeyfactorRequestedWith String Type of the request [XMLHttpRequest, APIClient] [default to APIClient]
xKeyfactorApiVersion String Desired version of the api, if not provided defaults to v1 [optional] [default to 1]
pqQueryString String Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) [optional]
pqPageReturned Integer The current page within the result set to be returned [optional]
pqReturnLimit Integer Maximum number of records to be returned in a single call [optional]
pqSortField String Field by which the results should be sorted (view results via Management Portal for sortable columns) [optional]
pqSortAscending Integer Field sort direction [0=ascending, 1=descending] [optional] [enum: 0, 1]

Return type

List<KeyfactorAuditingQueryingAuditLogEntry>

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code Description Response headers
200 OK -

auditLogGetRelatedEntities

List<KeyfactorAuditingQueryingAuditLogEntry> auditLogGetRelatedEntities(xKeyfactorRequestedWith, xKeyfactorApiVersion, pqQueryString, pqPageReturned, pqReturnLimit, pqSortField, pqSortAscending)

Returns the audit log entry associated with the provided keyfactor id

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.AuditLogApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    AuditLogApi apiInstance = new AuditLogApi(defaultClient);
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    String pqQueryString = "pqQueryString_example"; // String | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2)
    Integer pqPageReturned = 56; // Integer | The current page within the result set to be returned
    Integer pqReturnLimit = 56; // Integer | Maximum number of records to be returned in a single call
    String pqSortField = "pqSortField_example"; // String | Field by which the results should be sorted (view results via Management Portal for sortable columns)
    Integer pqSortAscending = 0; // Integer | Field sort direction [0=ascending, 1=descending]
    try {
      List<KeyfactorAuditingQueryingAuditLogEntry> result = apiInstance.auditLogGetRelatedEntities(xKeyfactorRequestedWith, xKeyfactorApiVersion, pqQueryString, pqPageReturned, pqReturnLimit, pqSortField, pqSortAscending);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AuditLogApi#auditLogGetRelatedEntities");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
xKeyfactorRequestedWith String Type of the request [XMLHttpRequest, APIClient] [default to APIClient]
xKeyfactorApiVersion String Desired version of the api, if not provided defaults to v1 [optional] [default to 1]
pqQueryString String Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) [optional]
pqPageReturned Integer The current page within the result set to be returned [optional]
pqReturnLimit Integer Maximum number of records to be returned in a single call [optional]
pqSortField String Field by which the results should be sorted (view results via Management Portal for sortable columns) [optional]
pqSortAscending Integer Field sort direction [0=ascending, 1=descending] [optional] [enum: 0, 1]

Return type

List<KeyfactorAuditingQueryingAuditLogEntry>

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code Description Response headers
200 OK -

auditLogValidateAuditLog

Boolean auditLogValidateAuditLog(id, xKeyfactorRequestedWith, xKeyfactorApiVersion)

Validates the audit log entry associated with the provided keyfactor id

The validation performs a signing operation and checks the signature against the stored signature.

Example

// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.AuditLogApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    AuditLogApi apiInstance = new AuditLogApi(defaultClient);
    Integer id = 56; // Integer | Keyfactor identifier of the audit log entry
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      Boolean result = apiInstance.auditLogValidateAuditLog(id, xKeyfactorRequestedWith, xKeyfactorApiVersion);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AuditLogApi#auditLogValidateAuditLog");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id Integer Keyfactor identifier of the audit log entry
xKeyfactorRequestedWith String Type of the request [XMLHttpRequest, APIClient] [default to APIClient]
xKeyfactorApiVersion String Desired version of the api, if not provided defaults to v1 [optional] [default to 1]

Return type

Boolean

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

HTTP response details

Status code Description Response headers
200 OK -