All URIs are relative to http://keyfactor.example.com
| 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 |
string AuditLogDownloadCSV(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PqQueryString(pqQueryString).PqPageReturned(pqPageReturned).PqReturnLimit(pqReturnLimit).PqSortField(pqSortField).PqSortAscending(pqSortAscending).Execute()
Returns a Comma Separated file containing the audit log entries according to the provided filter
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")
pqQueryString := "pqQueryString_example" // string | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) (optional)
pqPageReturned := int32(56) // int32 | The current page within the result set to be returned (optional)
pqReturnLimit := int32(56) // int32 | Maximum number of records to be returned in a single call (optional)
pqSortField := "pqSortField_example" // string | Field by which the results should be sorted (view results via Management Portal for sortable columns) (optional)
pqSortAscending := int32(56) // int32 | Field sort direction [0=ascending, 1=descending] (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AuditLogApi.AuditLogDownloadCSV(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PqQueryString(pqQueryString).PqPageReturned(pqPageReturned).PqReturnLimit(pqReturnLimit).PqSortField(pqSortField).PqSortAscending(pqSortAscending).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AuditLogApi.AuditLogDownloadCSV``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AuditLogDownloadCSV`: string
fmt.Fprintf(os.Stdout, "Response from `AuditLogApi.AuditLogDownloadCSV`: %v\n", resp)
}Other parameters are passed through a pointer to a apiAuditLogDownloadCSVRequest struct via the builder pattern
| 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 | [default to "1"] |
| pqQueryString | string | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) | |
| pqPageReturned | int32 | The current page within the result set to be returned | |
| pqReturnLimit | int32 | Maximum number of records to be returned in a single call | |
| pqSortField | string | Field by which the results should be sorted (view results via Management Portal for sortable columns) | |
| pqSortAscending | int32 | Field sort direction [0=ascending, 1=descending] |
string
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} AuditLogGetAuditLog(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
Returns the audit log entry associated with the provided identifier
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := int32(56) // int32 | Keyfactor identifer of the audit entry to be returned
xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AuditLogApi.AuditLogGetAuditLog(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AuditLogApi.AuditLogGetAuditLog``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AuditLogGetAuditLog`: map[string]interface{}
fmt.Fprintf(os.Stdout, "Response from `AuditLogApi.AuditLogGetAuditLog`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | Keyfactor identifer of the audit entry to be returned |
Other parameters are passed through a pointer to a apiAuditLogGetAuditLogRequest struct via the builder pattern
| 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 | [default to "1"]
map[string]interface{}
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]KeyfactorAuditingQueryingAuditLogEntry AuditLogGetAuditLogs(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PqQueryString(pqQueryString).PqPageReturned(pqPageReturned).PqReturnLimit(pqReturnLimit).PqSortField(pqSortField).PqSortAscending(pqSortAscending).Execute()
Returns all audit log entries according to the provided filter and output parameters
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")
pqQueryString := "pqQueryString_example" // string | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) (optional)
pqPageReturned := int32(56) // int32 | The current page within the result set to be returned (optional)
pqReturnLimit := int32(56) // int32 | Maximum number of records to be returned in a single call (optional)
pqSortField := "pqSortField_example" // string | Field by which the results should be sorted (view results via Management Portal for sortable columns) (optional)
pqSortAscending := int32(56) // int32 | Field sort direction [0=ascending, 1=descending] (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AuditLogApi.AuditLogGetAuditLogs(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PqQueryString(pqQueryString).PqPageReturned(pqPageReturned).PqReturnLimit(pqReturnLimit).PqSortField(pqSortField).PqSortAscending(pqSortAscending).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AuditLogApi.AuditLogGetAuditLogs``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AuditLogGetAuditLogs`: []KeyfactorAuditingQueryingAuditLogEntry
fmt.Fprintf(os.Stdout, "Response from `AuditLogApi.AuditLogGetAuditLogs`: %v\n", resp)
}Other parameters are passed through a pointer to a apiAuditLogGetAuditLogsRequest struct via the builder pattern
| 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 | [default to "1"] |
| pqQueryString | string | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) | |
| pqPageReturned | int32 | The current page within the result set to be returned | |
| pqReturnLimit | int32 | Maximum number of records to be returned in a single call | |
| pqSortField | string | Field by which the results should be sorted (view results via Management Portal for sortable columns) | |
| pqSortAscending | int32 | Field sort direction [0=ascending, 1=descending] |
[]KeyfactorAuditingQueryingAuditLogEntry
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]KeyfactorAuditingQueryingAuditLogEntry AuditLogGetRelatedEntities(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PqQueryString(pqQueryString).PqPageReturned(pqPageReturned).PqReturnLimit(pqReturnLimit).PqSortField(pqSortField).PqSortAscending(pqSortAscending).Execute()
Returns the audit log entry associated with the provided keyfactor id
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")
pqQueryString := "pqQueryString_example" // string | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) (optional)
pqPageReturned := int32(56) // int32 | The current page within the result set to be returned (optional)
pqReturnLimit := int32(56) // int32 | Maximum number of records to be returned in a single call (optional)
pqSortField := "pqSortField_example" // string | Field by which the results should be sorted (view results via Management Portal for sortable columns) (optional)
pqSortAscending := int32(56) // int32 | Field sort direction [0=ascending, 1=descending] (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AuditLogApi.AuditLogGetRelatedEntities(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).PqQueryString(pqQueryString).PqPageReturned(pqPageReturned).PqReturnLimit(pqReturnLimit).PqSortField(pqSortField).PqSortAscending(pqSortAscending).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AuditLogApi.AuditLogGetRelatedEntities``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AuditLogGetRelatedEntities`: []KeyfactorAuditingQueryingAuditLogEntry
fmt.Fprintf(os.Stdout, "Response from `AuditLogApi.AuditLogGetRelatedEntities`: %v\n", resp)
}Other parameters are passed through a pointer to a apiAuditLogGetRelatedEntitiesRequest struct via the builder pattern
| 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 | [default to "1"] |
| pqQueryString | string | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) | |
| pqPageReturned | int32 | The current page within the result set to be returned | |
| pqReturnLimit | int32 | Maximum number of records to be returned in a single call | |
| pqSortField | string | Field by which the results should be sorted (view results via Management Portal for sortable columns) | |
| pqSortAscending | int32 | Field sort direction [0=ascending, 1=descending] |
[]KeyfactorAuditingQueryingAuditLogEntry
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bool AuditLogValidateAuditLog(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
Validates the audit log entry associated with the provided keyfactor id
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := int32(56) // int32 | Keyfactor identifier of the audit log entry
xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
xKeyfactorApiVersion := "xKeyfactorApiVersion_example" // string | Desired version of the api, if not provided defaults to v1 (optional) (default to "1")
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AuditLogApi.AuditLogValidateAuditLog(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AuditLogApi.AuditLogValidateAuditLog``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AuditLogValidateAuditLog`: bool
fmt.Fprintf(os.Stdout, "Response from `AuditLogApi.AuditLogValidateAuditLog`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | Keyfactor identifier of the audit log entry |
Other parameters are passed through a pointer to a apiAuditLogValidateAuditLogRequest struct via the builder pattern
| 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 | [default to "1"]
bool
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]