All URIs are relative to http://keyfactor.example.com
| Method | HTTP request | Description |
|---|---|---|
| CreateAlertsKeyRotation | POST /Alerts/KeyRotation | Add a key rotation alert |
| CreateAlertsKeyRotationTest | POST /Alerts/KeyRotation/Test | Test An Alert |
| CreateAlertsKeyRotationTestAll | POST /Alerts/KeyRotation/TestAll | Test All Alerts |
| DeleteAlertsKeyRotationById | DELETE /Alerts/KeyRotation/{id} | Delete a key rotation alert |
| GetAlertsKeyRotation | GET /Alerts/KeyRotation | Gets all key rotation alerts according to the provided filter and output parameters |
| GetAlertsKeyRotationById | GET /Alerts/KeyRotation/{id} | Get a key rotation alert |
| GetAlertsKeyRotationSchedule | GET /Alerts/KeyRotation/Schedule | Get the schedule for key rotation alerts |
| UpdateAlertsKeyRotation | PUT /Alerts/KeyRotation | Edit a key rotation alert |
| UpdateAlertsKeyRotationSchedule | PUT /Alerts/KeyRotation/Schedule | Edit schedule |
AlertsKeyRotationKeyRotationAlertDefinitionResponse NewCreateAlertsKeyRotationRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsKeyRotationKeyRotationAlertCreationRequest(alertsKeyRotationKeyRotationAlertCreationRequest).Execute()
Add a key rotation alert
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
alertsKeyRotationKeyRotationAlertCreationRequest := *openapiclient.NewAlertsKeyRotationKeyRotationAlertCreationRequest("DisplayName_example", int32(123)) // AlertsKeyRotationKeyRotationAlertCreationRequest | Information for the new alert (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.KeyRotationAlertApi.NewCreateAlertsKeyRotationRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsKeyRotationKeyRotationAlertCreationRequest(alertsKeyRotationKeyRotationAlertCreationRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KeyRotationAlertApi.CreateAlertsKeyRotation``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateAlertsKeyRotation`: AlertsKeyRotationKeyRotationAlertDefinitionResponse
fmt.Fprintf(os.Stdout, "Response from `KeyRotationAlertApi.CreateAlertsKeyRotation`: %v\n", resp)
}Other parameters are passed through a pointer to a apiCreateAlertsKeyRotationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | |
| xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 | |
| alertsKeyRotationKeyRotationAlertCreationRequest | AlertsKeyRotationKeyRotationAlertCreationRequest | Information for the new alert |
AlertsKeyRotationKeyRotationAlertDefinitionResponse
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AlertsKeyRotationKeyRotationAlertTestResponse NewCreateAlertsKeyRotationTestRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsKeyRotationKeyRotationAlertTestRequest(alertsKeyRotationKeyRotationAlertTestRequest).Execute()
Test An Alert
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
alertsKeyRotationKeyRotationAlertTestRequest := *openapiclient.NewAlertsKeyRotationKeyRotationAlertTestRequest() // AlertsKeyRotationKeyRotationAlertTestRequest | Parameters used to test the alert (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.KeyRotationAlertApi.NewCreateAlertsKeyRotationTestRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsKeyRotationKeyRotationAlertTestRequest(alertsKeyRotationKeyRotationAlertTestRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KeyRotationAlertApi.CreateAlertsKeyRotationTest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateAlertsKeyRotationTest`: AlertsKeyRotationKeyRotationAlertTestResponse
fmt.Fprintf(os.Stdout, "Response from `KeyRotationAlertApi.CreateAlertsKeyRotationTest`: %v\n", resp)
}Other parameters are passed through a pointer to a apiCreateAlertsKeyRotationTestRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | |
| xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 | |
| alertsKeyRotationKeyRotationAlertTestRequest | AlertsKeyRotationKeyRotationAlertTestRequest | Parameters used to test the alert |
AlertsKeyRotationKeyRotationAlertTestResponse
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AlertsKeyRotationKeyRotationAlertTestResponse NewCreateAlertsKeyRotationTestAllRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsKeyRotationKeyRotationAlertTestAllRequest(alertsKeyRotationKeyRotationAlertTestAllRequest).Execute()
Test All Alerts
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
alertsKeyRotationKeyRotationAlertTestAllRequest := *openapiclient.NewAlertsKeyRotationKeyRotationAlertTestAllRequest() // AlertsKeyRotationKeyRotationAlertTestAllRequest | Information about the key rotation alert test (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.KeyRotationAlertApi.NewCreateAlertsKeyRotationTestAllRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsKeyRotationKeyRotationAlertTestAllRequest(alertsKeyRotationKeyRotationAlertTestAllRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KeyRotationAlertApi.CreateAlertsKeyRotationTestAll``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateAlertsKeyRotationTestAll`: AlertsKeyRotationKeyRotationAlertTestResponse
fmt.Fprintf(os.Stdout, "Response from `KeyRotationAlertApi.CreateAlertsKeyRotationTestAll`: %v\n", resp)
}Other parameters are passed through a pointer to a apiCreateAlertsKeyRotationTestAllRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | |
| xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 | |
| alertsKeyRotationKeyRotationAlertTestAllRequest | AlertsKeyRotationKeyRotationAlertTestAllRequest | Information about the key rotation alert test |
AlertsKeyRotationKeyRotationAlertTestResponse
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NewDeleteAlertsKeyRotationByIdRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
Delete a key rotation alert
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := int32(56) // int32 | Id for the key rotation alert
xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.KeyRotationAlertApi.NewDeleteAlertsKeyRotationByIdRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KeyRotationAlertApi.DeleteAlertsKeyRotationById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | Id for the key rotation alert |
Other parameters are passed through a pointer to a apiDeleteAlertsKeyRotationByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]AlertsKeyRotationKeyRotationAlertDefinitionResponse NewGetAlertsKeyRotationRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).QueryString(queryString).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
Gets all key rotation alerts according to the provided filter and output parameters
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
queryString := "queryString_example" // string | (optional)
pageReturned := int32(56) // int32 | (optional)
returnLimit := int32(56) // int32 | (optional)
sortField := "sortField_example" // string | (optional)
sortAscending := openapiclient.Keyfactor.Common.QueryableExtensions.SortOrder(0) // KeyfactorCommonQueryableExtensionsSortOrder | (optional)
xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.KeyRotationAlertApi.NewGetAlertsKeyRotationRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).QueryString(queryString).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KeyRotationAlertApi.GetAlertsKeyRotation``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAlertsKeyRotation`: []AlertsKeyRotationKeyRotationAlertDefinitionResponse
fmt.Fprintf(os.Stdout, "Response from `KeyRotationAlertApi.GetAlertsKeyRotation`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetAlertsKeyRotationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | |
| queryString | string | ||
| pageReturned | int32 | ||
| returnLimit | int32 | ||
| sortField | string | ||
| sortAscending | KeyfactorCommonQueryableExtensionsSortOrder | ||
| xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 |
[]AlertsKeyRotationKeyRotationAlertDefinitionResponse
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AlertsKeyRotationKeyRotationAlertDefinitionResponse NewGetAlertsKeyRotationByIdRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
Get a key rotation alert
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := int32(56) // int32 | Id for the key rotation alert to get
xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.KeyRotationAlertApi.NewGetAlertsKeyRotationByIdRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KeyRotationAlertApi.GetAlertsKeyRotationById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAlertsKeyRotationById`: AlertsKeyRotationKeyRotationAlertDefinitionResponse
fmt.Fprintf(os.Stdout, "Response from `KeyRotationAlertApi.GetAlertsKeyRotationById`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | Id for the key rotation alert to get |
Other parameters are passed through a pointer to a apiGetAlertsKeyRotationByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 |
AlertsKeyRotationKeyRotationAlertDefinitionResponse
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AlertsAlertScheduleAlertScheduleResponse NewGetAlertsKeyRotationScheduleRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
Get the schedule for key rotation alerts
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.KeyRotationAlertApi.NewGetAlertsKeyRotationScheduleRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KeyRotationAlertApi.GetAlertsKeyRotationSchedule``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAlertsKeyRotationSchedule`: AlertsAlertScheduleAlertScheduleResponse
fmt.Fprintf(os.Stdout, "Response from `KeyRotationAlertApi.GetAlertsKeyRotationSchedule`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetAlertsKeyRotationScheduleRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | |
| xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 |
AlertsAlertScheduleAlertScheduleResponse
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AlertsKeyRotationKeyRotationAlertDefinitionResponse NewUpdateAlertsKeyRotationRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsKeyRotationKeyRotationAlertUpdateRequest(alertsKeyRotationKeyRotationAlertUpdateRequest).Execute()
Edit a key rotation alert
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
alertsKeyRotationKeyRotationAlertUpdateRequest := *openapiclient.NewAlertsKeyRotationKeyRotationAlertUpdateRequest("DisplayName_example", int32(123)) // AlertsKeyRotationKeyRotationAlertUpdateRequest | Information for the key rotation alert (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.KeyRotationAlertApi.NewUpdateAlertsKeyRotationRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsKeyRotationKeyRotationAlertUpdateRequest(alertsKeyRotationKeyRotationAlertUpdateRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KeyRotationAlertApi.UpdateAlertsKeyRotation``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateAlertsKeyRotation`: AlertsKeyRotationKeyRotationAlertDefinitionResponse
fmt.Fprintf(os.Stdout, "Response from `KeyRotationAlertApi.UpdateAlertsKeyRotation`: %v\n", resp)
}Other parameters are passed through a pointer to a apiUpdateAlertsKeyRotationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | |
| xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 | |
| alertsKeyRotationKeyRotationAlertUpdateRequest | AlertsKeyRotationKeyRotationAlertUpdateRequest | Information for the key rotation alert |
AlertsKeyRotationKeyRotationAlertDefinitionResponse
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AlertsAlertScheduleAlertScheduleResponse NewUpdateAlertsKeyRotationScheduleRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsAlertScheduleAlertScheduleRequest(alertsAlertScheduleAlertScheduleRequest).Execute()
Edit schedule
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion := "1.0" // string | Desired version of the api, if not provided defaults to v1 (optional)
alertsAlertScheduleAlertScheduleRequest := *openapiclient.NewAlertsAlertScheduleAlertScheduleRequest() // AlertsAlertScheduleAlertScheduleRequest | (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.KeyRotationAlertApi.NewUpdateAlertsKeyRotationScheduleRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AlertsAlertScheduleAlertScheduleRequest(alertsAlertScheduleAlertScheduleRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KeyRotationAlertApi.UpdateAlertsKeyRotationSchedule``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateAlertsKeyRotationSchedule`: AlertsAlertScheduleAlertScheduleResponse
fmt.Fprintf(os.Stdout, "Response from `KeyRotationAlertApi.UpdateAlertsKeyRotationSchedule`: %v\n", resp)
}Other parameters are passed through a pointer to a apiUpdateAlertsKeyRotationScheduleRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| xKeyfactorRequestedWith | string | Type of the request [XMLHttpRequest, APIClient] | |
| xKeyfactorApiVersion | string | Desired version of the api, if not provided defaults to v1 | |
| alertsAlertScheduleAlertScheduleRequest | AlertsAlertScheduleAlertScheduleRequest |
AlertsAlertScheduleAlertScheduleResponse
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]