Skip to content

EnrollmentApi.md

Latest commit

 

History

History
81 lines (52 loc) · 3.38 KB

EnrollmentApi.md

File metadata and controls

81 lines (52 loc) · 3.38 KB
Raw

\EnrollmentApi

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

Method HTTP request Description
CreateEnrollmentPFX POST /Enrollment/PFX Performs a PFX Enrollment based upon the provided request

CreateEnrollmentPFX

EnrollmentPFXEnrollmentManagementResponse NewCreateEnrollmentPFXRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XCertificateformat(xCertificateformat).XKeyfactorApiVersion(xKeyfactorApiVersion).EnrollmentPFXEnrollmentWithStoresRequest(enrollmentPFXEnrollmentWithStoresRequest).Execute()

Performs a PFX Enrollment based upon the provided request

Example

package main

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

func main() {
    xKeyfactorRequestedWith := "APIClient" // string | Type of the request [XMLHttpRequest, APIClient]
    xCertificateformat := "PFX" // string | Desired format [PFX, ZIP, PEM, JKS, STORE, REPLACE]
    xKeyfactorApiVersion := "2" // string | Desired version of the api, if not provided defaults to v1 (optional)
    enrollmentPFXEnrollmentWithStoresRequest := *openapiclient.NewEnrollmentPFXEnrollmentWithStoresRequest() // EnrollmentPFXEnrollmentWithStoresRequest | The information needed to perform the PFX Enrollment (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnrollmentApi.NewCreateEnrollmentPFXRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XCertificateformat(xCertificateformat).XKeyfactorApiVersion(xKeyfactorApiVersion).EnrollmentPFXEnrollmentWithStoresRequest(enrollmentPFXEnrollmentWithStoresRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnrollmentApi.CreateEnrollmentPFX``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateEnrollmentPFX`: EnrollmentPFXEnrollmentManagementResponse
    fmt.Fprintf(os.Stdout, "Response from `EnrollmentApi.CreateEnrollmentPFX`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
xKeyfactorRequestedWith string Type of the request [XMLHttpRequest, APIClient]
xCertificateformat string Desired format [PFX, ZIP, PEM, JKS, STORE, REPLACE]
xKeyfactorApiVersion string Desired version of the api, if not provided defaults to v1
enrollmentPFXEnrollmentWithStoresRequest EnrollmentPFXEnrollmentWithStoresRequest The information needed to perform the PFX Enrollment

Return type

EnrollmentPFXEnrollmentManagementResponse

Authorization

basicAuth

HTTP request headers

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