All URIs are relative to https://192.168.78.139/KeyfactorAPI
Method | HTTP request | Description |
---|---|---|
workflowApprovePendingRequests | POST /Workflow/Certificates/Approve | Approves pending certificate requests associated with the provided ids |
workflowDenyPendingRequests | POST /Workflow/Certificates/Deny | Denies pending certificate requests associated with the provided ids |
workflowGet | GET /Workflow/Certificates/Pending | Gets a collection of certificate requests based on the provided query. |
workflowGetCertificateRequestDetails | GET /Workflow/Certificates/{id} | Returns certificate request details based on the provided ID. |
workflowGetDenied | GET /Workflow/Certificates/Denied | Gets a collection of denied certificate requests based on the provided query. |
ModelsWorkflowApproveDenyResult workflowApprovePendingRequests(xKeyfactorRequestedWith, requestIds, xKeyfactorApiVersion)
Approves pending certificate requests associated with the provided ids
// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.WorkflowApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
WorkflowApi apiInstance = new WorkflowApi(defaultClient);
String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
List<Integer> requestIds = Arrays.asList(); // List<Integer> | Array of Keyfactor identifiers of the certificate requests
String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
try {
ModelsWorkflowApproveDenyResult result = apiInstance.workflowApprovePendingRequests(xKeyfactorRequestedWith, requestIds, xKeyfactorApiVersion);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowApi#workflowApprovePendingRequests");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
xKeyfactorRequestedWith | String | Type of the request [XMLHttpRequest, APIClient] | [default to APIClient] |
requestIds | List<Integer> | Array of Keyfactor identifiers of the certificate requests | |
xKeyfactorApiVersion | String | Desired version of the api, if not provided defaults to v1 | [optional] [default to 1] |
ModelsWorkflowApproveDenyResult
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
ModelsWorkflowApproveDenyResult workflowDenyPendingRequests(xKeyfactorRequestedWith, request, xKeyfactorApiVersion)
Denies pending certificate requests associated with the provided ids
// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.WorkflowApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
WorkflowApi apiInstance = new WorkflowApi(defaultClient);
String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
ModelsWorkflowDenialRequest request = new ModelsWorkflowDenialRequest(); // ModelsWorkflowDenialRequest | Keyfactor identifiers of the certificate requests to be denied and any denial comments
String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
try {
ModelsWorkflowApproveDenyResult result = apiInstance.workflowDenyPendingRequests(xKeyfactorRequestedWith, request, xKeyfactorApiVersion);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowApi#workflowDenyPendingRequests");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
xKeyfactorRequestedWith | String | Type of the request [XMLHttpRequest, APIClient] | [default to APIClient] |
request | ModelsWorkflowDenialRequest | Keyfactor identifiers of the certificate requests to be denied and any denial comments | |
xKeyfactorApiVersion | String | Desired version of the api, if not provided defaults to v1 | [optional] [default to 1] |
ModelsWorkflowApproveDenyResult
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
List<ModelsWorkflowCertificateRequestModel> workflowGet(xKeyfactorRequestedWith, xKeyfactorApiVersion, pagedQueryQueryString, pagedQueryPageReturned, pagedQueryReturnLimit, pagedQuerySortField, pagedQuerySortAscending)
Gets a collection of certificate requests based on the provided query.
// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.WorkflowApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
WorkflowApi apiInstance = new WorkflowApi(defaultClient);
String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
String pagedQueryQueryString = "pagedQueryQueryString_example"; // String | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2)
Integer pagedQueryPageReturned = 56; // Integer | The current page within the result set to be returned
Integer pagedQueryReturnLimit = 56; // Integer | Maximum number of records to be returned in a single call
String pagedQuerySortField = "pagedQuerySortField_example"; // String | Field by which the results should be sorted (view results via Management Portal for sortable columns)
Integer pagedQuerySortAscending = 0; // Integer | Field sort direction [0=ascending, 1=descending]
try {
List<ModelsWorkflowCertificateRequestModel> result = apiInstance.workflowGet(xKeyfactorRequestedWith, xKeyfactorApiVersion, pagedQueryQueryString, pagedQueryPageReturned, pagedQueryReturnLimit, pagedQuerySortField, pagedQuerySortAscending);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowApi#workflowGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
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 | [optional] [default to 1] |
pagedQueryQueryString | String | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) | [optional] |
pagedQueryPageReturned | Integer | The current page within the result set to be returned | [optional] |
pagedQueryReturnLimit | Integer | Maximum number of records to be returned in a single call | [optional] |
pagedQuerySortField | String | Field by which the results should be sorted (view results via Management Portal for sortable columns) | [optional] |
pagedQuerySortAscending | Integer | Field sort direction [0=ascending, 1=descending] | [optional] [enum: 0, 1] |
List<ModelsWorkflowCertificateRequestModel>
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
ModelsWorkflowCertificateRequestDetailsModel workflowGetCertificateRequestDetails(id, xKeyfactorRequestedWith, xKeyfactorApiVersion)
Returns certificate request details based on the provided ID.
// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.WorkflowApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
WorkflowApi apiInstance = new WorkflowApi(defaultClient);
Integer id = 56; // Integer | The ID of the certificate request.
String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
try {
ModelsWorkflowCertificateRequestDetailsModel result = apiInstance.workflowGetCertificateRequestDetails(id, xKeyfactorRequestedWith, xKeyfactorApiVersion);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowApi#workflowGetCertificateRequestDetails");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | The ID of the certificate request. | |
xKeyfactorRequestedWith | String | Type of the request [XMLHttpRequest, APIClient] | [default to APIClient] |
xKeyfactorApiVersion | String | Desired version of the api, if not provided defaults to v1 | [optional] [default to 1] |
ModelsWorkflowCertificateRequestDetailsModel
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
List<ModelsWorkflowCertificateRequestModel> workflowGetDenied(xKeyfactorRequestedWith, xKeyfactorApiVersion, pagedQueryQueryString, pagedQueryPageReturned, pagedQueryReturnLimit, pagedQuerySortField, pagedQuerySortAscending)
Gets a collection of denied certificate requests based on the provided query.
// Import classes:
import com.keyfactor.command.client.ApiClient;
import com.keyfactor.command.client.ApiException;
import com.keyfactor.command.client.Configuration;
import com.keyfactor.command.client.auth.*;
import com.keyfactor.command.client.models.*;
import com.keyfactor.command.client.api.WorkflowApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://192.168.78.139/KeyfactorAPI");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
WorkflowApi apiInstance = new WorkflowApi(defaultClient);
String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
String pagedQueryQueryString = "pagedQueryQueryString_example"; // String | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2)
Integer pagedQueryPageReturned = 56; // Integer | The current page within the result set to be returned
Integer pagedQueryReturnLimit = 56; // Integer | Maximum number of records to be returned in a single call
String pagedQuerySortField = "pagedQuerySortField_example"; // String | Field by which the results should be sorted (view results via Management Portal for sortable columns)
Integer pagedQuerySortAscending = 0; // Integer | Field sort direction [0=ascending, 1=descending]
try {
List<ModelsWorkflowCertificateRequestModel> result = apiInstance.workflowGetDenied(xKeyfactorRequestedWith, xKeyfactorApiVersion, pagedQueryQueryString, pagedQueryPageReturned, pagedQueryReturnLimit, pagedQuerySortField, pagedQuerySortAscending);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowApi#workflowGetDenied");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
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 | [optional] [default to 1] |
pagedQueryQueryString | String | Contents of the query (ex: field1 -eq value1 AND field2 -gt value2) | [optional] |
pagedQueryPageReturned | Integer | The current page within the result set to be returned | [optional] |
pagedQueryReturnLimit | Integer | Maximum number of records to be returned in a single call | [optional] |
pagedQuerySortField | String | Field by which the results should be sorted (view results via Management Portal for sortable columns) | [optional] |
pagedQuerySortAscending | Integer | Field sort direction [0=ascending, 1=descending] | [optional] [enum: 0, 1] |
List<ModelsWorkflowCertificateRequestModel>
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
Status code | Description | Response headers |
---|---|---|
200 | OK | - |