\WorkflowApi

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

Method	HTTP request	Description
CreateWorkflowCertificatesApprove	POST /Workflow/Certificates/Approve	Approves pending certificate requests associated with the provided ids
CreateWorkflowCertificatesDeny	POST /Workflow/Certificates/Deny	Denies pending certificate requests associated with the provided ids
GetWorkflowCertificatesById	GET /Workflow/Certificates/{id}	Returns certificate request details based on the provided ID.
GetWorkflowCertificatesDenied	GET /Workflow/Certificates/Denied	Gets a collection of denied certificate requests based on the provided query.
GetWorkflowCertificatesExternalValidation	GET /Workflow/Certificates/ExternalValidation	Gets a collection of external validation certificate requests based on the provided query.
GetWorkflowCertificatesPending	GET /Workflow/Certificates/Pending	Gets a collection of pending certificate requests based on the provided query.

CreateWorkflowCertificatesApprove

CSSCMSDataModelModelsWorkflowApproveDenyResult NewCreateWorkflowCertificatesApproveRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).RequestBody(requestBody).Execute()

Approves pending certificate requests associated with the provided ids

Example

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)
    requestBody := []int32{int32(123)} // []int32 | Array of Keyfactor identifiers of the certificate requests (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WorkflowApi.NewCreateWorkflowCertificatesApproveRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).RequestBody(requestBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WorkflowApi.CreateWorkflowCertificatesApprove``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateWorkflowCertificatesApprove`: CSSCMSDataModelModelsWorkflowApproveDenyResult
    fmt.Fprintf(os.Stdout, "Response from `WorkflowApi.CreateWorkflowCertificatesApprove`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1
requestBody	[]int32	Array of Keyfactor identifiers of the certificate requests

Return type

CSSCMSDataModelModelsWorkflowApproveDenyResult

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]

CreateWorkflowCertificatesDeny

CSSCMSDataModelModelsWorkflowApproveDenyResult NewCreateWorkflowCertificatesDenyRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).CSSCMSDataModelModelsWorkflowDenialRequest(cSSCMSDataModelModelsWorkflowDenialRequest).Execute()

Denies pending certificate requests associated with the provided ids

Example

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)
    cSSCMSDataModelModelsWorkflowDenialRequest := *openapiclient.NewCSSCMSDataModelModelsWorkflowDenialRequest() // CSSCMSDataModelModelsWorkflowDenialRequest | Keyfactor identifiers of the certificate requests to be denied and any denial comments (optional)

    configuration := openapiclient.NewConfiguration(make(map[string]string))
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WorkflowApi.NewCreateWorkflowCertificatesDenyRequest(context.Background()).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).CSSCMSDataModelModelsWorkflowDenialRequest(cSSCMSDataModelModelsWorkflowDenialRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WorkflowApi.CreateWorkflowCertificatesDeny``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateWorkflowCertificatesDeny`: CSSCMSDataModelModelsWorkflowApproveDenyResult
    fmt.Fprintf(os.Stdout, "Response from `WorkflowApi.CreateWorkflowCertificatesDeny`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description
xKeyfactorRequestedWith	string	Type of the request [XMLHttpRequest, APIClient]
xKeyfactorApiVersion	string	Desired version of the api, if not provided defaults to v1
cSSCMSDataModelModelsWorkflowDenialRequest	CSSCMSDataModelModelsWorkflowDenialRequest	Keyfactor identifiers of the certificate requests to be denied and any denial comments

Return type

CSSCMSDataModelModelsWorkflowApproveDenyResult

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]

GetWorkflowCertificatesById

CertificatesCertRequestResponseModel NewGetWorkflowCertificatesByIdRequest(ctx, id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Returns certificate request details based on the provided ID.

Example

package main

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

func main() {
    id := int32(56) // int32 | The ID of the certificate request.
    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.WorkflowApi.NewGetWorkflowCertificatesByIdRequest(context.Background(), id).XKeyfactorRequestedWith(xKeyfactorRequestedWith).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WorkflowApi.GetWorkflowCertificatesById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetWorkflowCertificatesById`: CertificatesCertRequestResponseModel
    fmt.Fprintf(os.Stdout, "Response from `WorkflowApi.GetWorkflowCertificatesById`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32	The ID of the certificate request.

Other Parameters

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

Name	Type	Description	Notes

Return type

CertificatesCertRequestResponseModel

Authorization

basicAuth

HTTP request headers

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]

GetWorkflowCertificatesDenied

[]CSSCMSDataModelModelsWorkflowCertificateRequestModel NewGetWorkflowCertificatesDeniedRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).QueryString(queryString).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Gets a collection of denied certificate requests based on the provided query.

Example

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.WorkflowApi.NewGetWorkflowCertificatesDeniedRequest(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 `WorkflowApi.GetWorkflowCertificatesDenied``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetWorkflowCertificatesDenied`: []CSSCMSDataModelModelsWorkflowCertificateRequestModel
    fmt.Fprintf(os.Stdout, "Response from `WorkflowApi.GetWorkflowCertificatesDenied`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description
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

Return type

[]CSSCMSDataModelModelsWorkflowCertificateRequestModel

Authorization

basicAuth

HTTP request headers

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]

GetWorkflowCertificatesExternalValidation

[]CSSCMSDataModelModelsWorkflowCertificateRequestModel NewGetWorkflowCertificatesExternalValidationRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).QueryString(queryString).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Gets a collection of external validation certificate requests based on the provided query.

Example

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.WorkflowApi.NewGetWorkflowCertificatesExternalValidationRequest(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 `WorkflowApi.GetWorkflowCertificatesExternalValidation``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetWorkflowCertificatesExternalValidation`: []CSSCMSDataModelModelsWorkflowCertificateRequestModel
    fmt.Fprintf(os.Stdout, "Response from `WorkflowApi.GetWorkflowCertificatesExternalValidation`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description
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

Return type

[]CSSCMSDataModelModelsWorkflowCertificateRequestModel

Authorization

basicAuth

HTTP request headers

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]

GetWorkflowCertificatesPending

[]CSSCMSDataModelModelsWorkflowCertificateRequestModel NewGetWorkflowCertificatesPendingRequest(ctx).XKeyfactorRequestedWith(xKeyfactorRequestedWith).QueryString(queryString).PageReturned(pageReturned).ReturnLimit(returnLimit).SortField(sortField).SortAscending(sortAscending).XKeyfactorApiVersion(xKeyfactorApiVersion).Execute()

Gets a collection of pending certificate requests based on the provided query.

Example

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.WorkflowApi.NewGetWorkflowCertificatesPendingRequest(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 `WorkflowApi.GetWorkflowCertificatesPending``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetWorkflowCertificatesPending`: []CSSCMSDataModelModelsWorkflowCertificateRequestModel
    fmt.Fprintf(os.Stdout, "Response from `WorkflowApi.GetWorkflowCertificatesPending`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description
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

Return type

[]CSSCMSDataModelModelsWorkflowCertificateRequestModel

Authorization

basicAuth

HTTP request headers

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]

Uh oh!

FilesExpand file tree

WorkflowApi.md

Latest commit

History

WorkflowApi.md

File metadata and controls

\WorkflowApi

CreateWorkflowCertificatesApprove

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateWorkflowCertificatesDeny

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetWorkflowCertificatesById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetWorkflowCertificatesDenied

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetWorkflowCertificatesExternalValidation

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetWorkflowCertificatesPending

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers