All URIs are relative to http://keyfactor.example.com
| Method | HTTP request | Description |
|---|---|---|
| GetAppSetting | GET /AppSetting | Get available application settings |
| GetAppSettingById | GET /AppSetting/{id} | Get application setting by id |
| UpdateAppSetting | PUT /AppSetting | Bulk update available application settings |
| UpdateAppSettingByIdSet | PUT /AppSetting/{id}/Set | Update one application setting by id |
| UpdateAppSettingNameSet | PUT /AppSetting/{name}/Set | Update one application setting by short name |
[]AppSettingsAppSettingResponse NewGetAppSettingRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
Get available application settings
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.AppSettingApi.NewGetAppSettingRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AppSettingApi.GetAppSetting``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAppSetting`: []AppSettingsAppSettingResponse
fmt.Fprintf(os.Stdout, "Response from `AppSettingApi.GetAppSetting`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetAppSettingRequest 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 |
[]AppSettingsAppSettingResponse
- 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]
AppSettingsAppSettingResponse NewGetAppSettingByIdRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
Get application setting by id
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := int32(56) // int32 | Id for the application setting
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.AppSettingApi.NewGetAppSettingByIdRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AppSettingApi.GetAppSettingById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAppSettingById`: AppSettingsAppSettingResponse
fmt.Fprintf(os.Stdout, "Response from `AppSettingApi.GetAppSettingById`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | Id for the application setting |
Other parameters are passed through a pointer to a apiGetAppSettingByIdRequest 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 |
- 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]
[]AppSettingsAppSettingResponse NewUpdateAppSettingRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AppSettingsAppSettingUpdateBulkRequest(appSettingsAppSettingUpdateBulkRequest).Execute()
Bulk update available application settings
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)
appSettingsAppSettingUpdateBulkRequest := []openapiclient.AppSettingsAppSettingUpdateBulkRequest{*openapiclient.NewAppSettingsAppSettingUpdateBulkRequest()} // []AppSettingsAppSettingUpdateBulkRequest | List of information to update application settings (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AppSettingApi.NewUpdateAppSettingRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AppSettingsAppSettingUpdateBulkRequest(appSettingsAppSettingUpdateBulkRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AppSettingApi.UpdateAppSetting``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateAppSetting`: []AppSettingsAppSettingResponse
fmt.Fprintf(os.Stdout, "Response from `AppSettingApi.UpdateAppSetting`: %v\n", resp)
}Other parameters are passed through a pointer to a apiUpdateAppSettingRequest 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 | |
| appSettingsAppSettingUpdateBulkRequest | []AppSettingsAppSettingUpdateBulkRequest | List of information to update application settings |
[]AppSettingsAppSettingResponse
- 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]
AppSettingsAppSettingResponse NewUpdateAppSettingByIdSetRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AppSettingsAppSettingUpdateRequest(appSettingsAppSettingUpdateRequest).Execute()
Update one application setting by id
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := int32(56) // int32 | Id for the application setting
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)
appSettingsAppSettingUpdateRequest := *openapiclient.NewAppSettingsAppSettingUpdateRequest() // AppSettingsAppSettingUpdateRequest | Infomation for updating the application setting (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AppSettingApi.NewUpdateAppSettingByIdSetRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AppSettingsAppSettingUpdateRequest(appSettingsAppSettingUpdateRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AppSettingApi.UpdateAppSettingByIdSet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateAppSettingByIdSet`: AppSettingsAppSettingResponse
fmt.Fprintf(os.Stdout, "Response from `AppSettingApi.UpdateAppSettingByIdSet`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | Id for the application setting |
Other parameters are passed through a pointer to a apiUpdateAppSettingByIdSetRequest 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 | appSettingsAppSettingUpdateRequest | AppSettingsAppSettingUpdateRequest | Infomation for updating the application setting |
- 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]
AppSettingsAppSettingResponse NewUpdateAppSettingNameSetRequest(ctx, name).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AppSettingsAppSettingUpdateRequest(appSettingsAppSettingUpdateRequest).Execute()
Update one application setting by short name
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
name := "name_example" // string | Short name for the application setting
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)
appSettingsAppSettingUpdateRequest := *openapiclient.NewAppSettingsAppSettingUpdateRequest() // AppSettingsAppSettingUpdateRequest | Infomation for updating the application setting (optional)
configuration := openapiclient.NewConfiguration(make(map[string]string))
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AppSettingApi.NewUpdateAppSettingNameSetRequest(context.Background(), name).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).AppSettingsAppSettingUpdateRequest(appSettingsAppSettingUpdateRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AppSettingApi.UpdateAppSettingNameSet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateAppSettingNameSet`: AppSettingsAppSettingResponse
fmt.Fprintf(os.Stdout, "Response from `AppSettingApi.UpdateAppSettingNameSet`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| name | string | Short name for the application setting |
Other parameters are passed through a pointer to a apiUpdateAppSettingNameSetRequest 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 | appSettingsAppSettingUpdateRequest | AppSettingsAppSettingUpdateRequest | Infomation for updating the application setting |
- 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]