Skip to content

Latest commit

 

History

History
840 lines (556 loc) · 36.5 KB

CertificateStoreApi.md

File metadata and controls

840 lines (556 loc) · 36.5 KB

\CertificateStoreApi

All URIs are relative to http://keyfactor.example.com

Method HTTP request Description
CertificateStoreAddCertificate Post /CertificateStores/Certificates/Add Configures a management job to add a certificate to one or more stores with the provided schedule
CertificateStoreApprovePending Post /CertificateStores/Approve Approves the provided certificate stores to make them available for management
CertificateStoreConfigureDiscoveryJob Put /CertificateStores/DiscoveryJob Configures a discovery job to locate currently unmanaged certificate stores
CertificateStoreCreateCertificateStoreServer Post /CertificateStores/Server Creates a new certificate store server with the provided properties
CertificateStoreDeleteCertificateStore Delete /CertificateStores/{id} Deletes a persisted certificate store by its Keyfactor identifier
CertificateStoreDeleteCertificateStores Delete /CertificateStores Deletes multiple persisted certificate store entities by their identifiers
CertificateStoreGetCertificateStoreInventory Get /CertificateStores/{id}/Inventory Returns a single certificate store's inventory associated with the provided id
CertificateStoreRemoveCertificate Post /CertificateStores/Certificates/Remove Configures a management job to remove a certificate from one or more stores with the provided schedule
CertificateStoreSchedule Post /CertificateStores/Schedule Creates an inventory schedule for the provided certificate stores
CertificateStoreScheduleForReenrollment Post /CertificateStores/Reenrollment Schedules a certificate store for reenrollment
CertificateStoreSetPassword Put /CertificateStores/Password Sets a password for the requested certificate store
CertificateStoreUpdateCertificateStoreServer Put /CertificateStores/Server Updates a given certificate store server with the properties of the provided instance

CertificateStoreAddCertificate

[]string CertificateStoreAddCertificate(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).AddRequest(addRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Configures a management job to add a certificate to one or more stores with the provided schedule

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    addRequest := *openapiclient.NewKeyfactorApiModelsCertificateStoresAddCertificateRequest(int32(123), []openapiclient.ModelsCertificateStoreEntry{*openapiclient.NewModelsCertificateStoreEntry("00000000-0000-0000-0000-000000000000")}, *openapiclient.NewKeyfactorCommonSchedulingKeyfactorSchedule()) // KeyfactorApiModelsCertificateStoresAddCertificateRequest | Configuration details of the management job
    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.CertificateStoreApi.CertificateStoreAddCertificate(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).AddRequest(addRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreAddCertificate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CertificateStoreAddCertificate`: []string
    fmt.Fprintf(os.Stdout, "Response from `CertificateStoreApi.CertificateStoreAddCertificate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreAddCertificateRequest struct via the builder pattern

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
addRequest KeyfactorApiModelsCertificateStoresAddCertificateRequest Configuration details of the management job
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

[]string

Authorization

basicAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CertificateStoreApprovePending

CertificateStoreApprovePending(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Keystores(keystores).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Approves the provided certificate stores to make them available for management

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    keystores := []openapiclient.KeyfactorApiModelsCertificateStoresCertificateStoreApproveRequest{*openapiclient.NewKeyfactorApiModelsCertificateStoresCertificateStoreApproveRequest()} // []KeyfactorApiModelsCertificateStoresCertificateStoreApproveRequest | Certificate stores to be approved
    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.CertificateStoreApi.CertificateStoreApprovePending(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Keystores(keystores).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreApprovePending``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreApprovePendingRequest struct via the builder pattern

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
keystores []KeyfactorApiModelsCertificateStoresCertificateStoreApproveRequest Certificate stores to be approved
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CertificateStoreConfigureDiscoveryJob

CertificateStoreConfigureDiscoveryJob(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).DiscoveryJobRequest(discoveryJobRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Configures a discovery job to locate currently unmanaged certificate stores

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    discoveryJobRequest := *openapiclient.NewModelsDiscoveryJobRequest(int32(123)) // ModelsDiscoveryJobRequest | Configuration properties of the discovery job
    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.CertificateStoreApi.CertificateStoreConfigureDiscoveryJob(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).DiscoveryJobRequest(discoveryJobRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreConfigureDiscoveryJob``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreConfigureDiscoveryJobRequest struct via the builder pattern

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
discoveryJobRequest ModelsDiscoveryJobRequest Configuration properties of the discovery job
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CertificateStoreCreateCertificateStoreServer

ModelsCertificateStoreServerResponse CertificateStoreCreateCertificateStoreServer(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Request(request).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Creates a new certificate store server with the provided properties

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    request := *openapiclient.NewModelsCertificateStoreCreateServerRequest(*openapiclient.NewModelsKeyfactorAPISecret(), *openapiclient.NewModelsKeyfactorAPISecret(), false, int32(123), "Name_example") // ModelsCertificateStoreCreateServerRequest | Certificate store server to be created with the provided properties
    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.CertificateStoreApi.CertificateStoreCreateCertificateStoreServer(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Request(request).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreCreateCertificateStoreServer``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CertificateStoreCreateCertificateStoreServer`: ModelsCertificateStoreServerResponse
    fmt.Fprintf(os.Stdout, "Response from `CertificateStoreApi.CertificateStoreCreateCertificateStoreServer`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreCreateCertificateStoreServerRequest struct via the builder pattern

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
request ModelsCertificateStoreCreateServerRequest Certificate store server to be created with the provided properties
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

ModelsCertificateStoreServerResponse

Authorization

basicAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CertificateStoreDeleteCertificateStore

CertificateStoreDeleteCertificateStore(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Deletes a persisted certificate store by its Keyfactor identifier

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Keyfactor certificate store identifier (GUID)
    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.CertificateStoreApi.CertificateStoreDeleteCertificateStore(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreDeleteCertificateStore``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Keyfactor certificate store identifier (GUID)

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreDeleteCertificateStoreRequest 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"]

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CertificateStoreDeleteCertificateStores

CertificateStoreDeleteCertificateStores(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Ids(ids).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Deletes multiple persisted certificate store entities by their identifiers

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    ids := []string{"00000000-0000-0000-0000-000000000000"} // []string | Array of Keyfactor identifiers (GUID) for the certificate stores to be deleted
    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.CertificateStoreApi.CertificateStoreDeleteCertificateStores(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Ids(ids).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreDeleteCertificateStores``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreDeleteCertificateStoresRequest struct via the builder pattern

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
ids []string Array of Keyfactor identifiers (GUID) for the certificate stores to be deleted
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CertificateStoreGetCertificateStoreInventory

[]ModelsCertificateStoreInventory CertificateStoreGetCertificateStoreInventory(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).QueryPageReturned(queryPageReturned).QueryReturnLimit(queryReturnLimit).QuerySortField(querySortField).QuerySortAscending(querySortAscending).Execute()

Returns a single certificate store's inventory associated with the provided id

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Keyfactor identifier (GUID) of the certificate store
    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")
    queryPageReturned := int32(56) // int32 | The current page within the result set to be returned (optional)
    queryReturnLimit := int32(56) // int32 | Maximum number of records to be returned in a single call (optional)
    querySortField := "querySortField_example" // string | Field by which the results should be sorted (OperationStart, OperationEnd, UserName) (optional)
    querySortAscending := 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.CertificateStoreApi.CertificateStoreGetCertificateStoreInventory(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).QueryPageReturned(queryPageReturned).QueryReturnLimit(queryReturnLimit).QuerySortField(querySortField).QuerySortAscending(querySortAscending).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreGetCertificateStoreInventory``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CertificateStoreGetCertificateStoreInventory`: []ModelsCertificateStoreInventory
    fmt.Fprintf(os.Stdout, "Response from `CertificateStoreApi.CertificateStoreGetCertificateStoreInventory`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Keyfactor identifier (GUID) of the certificate store

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreGetCertificateStoreInventoryRequest 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"] queryPageReturned | int32 | The current page within the result set to be returned | queryReturnLimit | int32 | Maximum number of records to be returned in a single call | querySortField | string | Field by which the results should be sorted (OperationStart, OperationEnd, UserName) | querySortAscending | int32 | Field sort direction [0=ascending, 1=descending] |

Return type

[]ModelsCertificateStoreInventory

Authorization

basicAuth

HTTP request headers

  • 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]

CertificateStoreRemoveCertificate

[]string CertificateStoreRemoveCertificate(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).RemovalRequest(removalRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Configures a management job to remove a certificate from one or more stores with the provided schedule

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    removalRequest := *openapiclient.NewKeyfactorApiModelsCertificateStoresRemoveCertificateRequest([]openapiclient.ModelsCertificateLocationSpecifier{*openapiclient.NewModelsCertificateLocationSpecifier()}, *openapiclient.NewKeyfactorCommonSchedulingKeyfactorSchedule()) // KeyfactorApiModelsCertificateStoresRemoveCertificateRequest | Configuration details of the management job
    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.CertificateStoreApi.CertificateStoreRemoveCertificate(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).RemovalRequest(removalRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreRemoveCertificate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CertificateStoreRemoveCertificate`: []string
    fmt.Fprintf(os.Stdout, "Response from `CertificateStoreApi.CertificateStoreRemoveCertificate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreRemoveCertificateRequest struct via the builder pattern

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
removalRequest KeyfactorApiModelsCertificateStoresRemoveCertificateRequest Configuration details of the management job
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

[]string

Authorization

basicAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CertificateStoreSchedule

CertificateStoreSchedule(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).FutureSchedule(futureSchedule).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Creates an inventory schedule for the provided certificate stores

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    futureSchedule := *openapiclient.NewModelsCertStoresSchedule([]string{"00000000-0000-0000-0000-000000000000"}) // ModelsCertStoresSchedule | Certificate store identifiers and the desired schedule
    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.CertificateStoreApi.CertificateStoreSchedule(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).FutureSchedule(futureSchedule).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreSchedule``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreScheduleRequest struct via the builder pattern

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
futureSchedule ModelsCertStoresSchedule Certificate store identifiers and the desired schedule
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CertificateStoreScheduleForReenrollment

CertificateStoreScheduleForReenrollment(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Reenroll(reenroll).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Schedules a certificate store for reenrollment

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    reenroll := *openapiclient.NewKeyfactorApiModelsCertificateStoresReenrollmentRequest() // KeyfactorApiModelsCertificateStoresReenrollmentRequest | An object that contains a Keystore Id, a Agent Guid, a string SubjectName and string Alias
    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.CertificateStoreApi.CertificateStoreScheduleForReenrollment(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Reenroll(reenroll).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreScheduleForReenrollment``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreScheduleForReenrollmentRequest struct via the builder pattern

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
reenroll KeyfactorApiModelsCertificateStoresReenrollmentRequest An object that contains a Keystore Id, a Agent Guid, a string SubjectName and string Alias
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CertificateStoreSetPassword

CertificateStoreSetPassword(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).PasswordRequest(passwordRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Sets a password for the requested certificate store

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    passwordRequest := *openapiclient.NewModelsCertStoreNewPasswordRequest("00000000-0000-0000-0000-000000000000", map[string]interface{}(123)) // ModelsCertStoreNewPasswordRequest | Identifier of the certificate store and the password to be applied to it
    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.CertificateStoreApi.CertificateStoreSetPassword(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).PasswordRequest(passwordRequest).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreSetPassword``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreSetPasswordRequest struct via the builder pattern

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
passwordRequest ModelsCertStoreNewPasswordRequest Identifier of the certificate store and the password to be applied to it
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CertificateStoreUpdateCertificateStoreServer

ModelsCertificateStoreServerResponse CertificateStoreUpdateCertificateStoreServer(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Request(request).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Updates a given certificate store server with the properties of the provided instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xKeyfactorRequestedWith := "xKeyfactorRequestedWith_example" // string | Type of the request [XMLHttpRequest, APIClient] (default to "APIClient")
    request := *openapiclient.NewModelsCertificateStoreUpdateServerRequest(int32(123), *openapiclient.NewModelsKeyfactorAPISecret(), *openapiclient.NewModelsKeyfactorAPISecret(), false, "Name_example") // ModelsCertificateStoreUpdateServerRequest | Server to be updated with the provided properties
    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.CertificateStoreApi.CertificateStoreUpdateCertificateStoreServer(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).Request(request).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CertificateStoreApi.CertificateStoreUpdateCertificateStoreServer``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CertificateStoreUpdateCertificateStoreServer`: ModelsCertificateStoreServerResponse
    fmt.Fprintf(os.Stdout, "Response from `CertificateStoreApi.CertificateStoreUpdateCertificateStoreServer`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCertificateStoreUpdateCertificateStoreServerRequest struct via the builder pattern

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient] [default to "APIClient"]
request ModelsCertificateStoreUpdateServerRequest Server to be updated with the provided properties
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1 [default to "1"]

Return type

ModelsCertificateStoreServerResponse

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]