GitHub - Keyfactor/keyfactor-java-client-sdk: Client SDK in Java for the Keyfactor Web API · GitHub
Skip to content

Keyfactor/keyfactor-java-client-sdk

BranchesTags

Repository files navigation

Community supported

We welcome contributions.

The Keyfactor Java Client SDK is open source and community supported, meaning that there is no SLA applicable for these tools.

To report a problem or suggest a new feature, use the Issues tab. If you want to contribute actual bug fixes or proposed enhancements, use the Pull requests tab.

keyfactor-java-client-sdk

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.keyfactor.command</groupId>
  <artifactId>keyfactor-java-client-sdk</artifactId>
  <version>v1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'keyfactor-java-client-sdk' jar has been published to maven central.
    mavenLocal()       // Needed if the 'keyfactor-java-client-sdk' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.keyfactor.command:keyfactor-java-client-sdk:v1"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/keyfactor-java-client-sdk-v1.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// 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.AgentApi;

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");

    AgentApi apiInstance = new AgentApi(defaultClient);
    String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
    List<String> agentIds = Arrays.asList(); // List<String> | List of Agent Ids to Approve
    String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
    try {
      apiInstance.agentApprove(xKeyfactorRequestedWith, agentIds, xKeyfactorApiVersion);
    } catch (ApiException e) {
      System.err.println("Exception when calling AgentApi#agentApprove");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://192.168.78.139/KeyfactorAPI

Class Method HTTP request Description
AgentApi agentApprove POST /Agents/Approve Approve a list of agents
AgentApi agentDisapprove POST /Agents/Disapprove Disapprove a list of agents
AgentApi agentFetchLogs POST /Agents/{id}/FetchLogs Schedules a job on the agent to retrieve log files
AgentApi agentGetAgentDetail GET /Agents/{id} Returns details for a single agent, specified by ID
AgentApi agentGetAgents GET /Agents Returns all agents according to the provided filter and output parameters
AgentApi agentReset0 POST /Agents/Reset Reset a list of agents
AgentApi agentReset1 POST /Agents/{id}/Reset Reset an agent to a new state
AgentApi agentSetAuthCertificateReenrollment POST /Agents/SetAuthCertificateReenrollment Update the AuthCertificateReenrollment value for an agent to request or require (or unset the request) the agent to enroll for a new client authentication certificate on its next registration.
AgentBlueprintApi agentBlueprintApplyBlueprint POST /AgentBluePrint/ApplyBlueprint Applies the selected agent blueprint to the provided agents
AgentBlueprintApi agentBlueprintDeleteBlueprint DELETE /AgentBluePrint/{id} Deletes an agent blueprint by its Keyfactor identifier
AgentBlueprintApi agentBlueprintGenerateBlueprint POST /AgentBluePrint/GenerateBluePrint Generates an agent blueprint from the provided agents
AgentBlueprintApi agentBlueprintGetAgentBlueprint GET /AgentBluePrint/{id} Returns an agent blueprint according to the provided filter and output parameters
AgentBlueprintApi agentBlueprintGetAgentBlueprints GET /AgentBluePrint Returns all agent blueprints according to the provided filter and output parameters
AgentBlueprintApi agentBlueprintGetBlueprintJobs GET /AgentBluePrint/{id}/Jobs Gets the agent blueprint scheduled jobs
AgentBlueprintApi agentBlueprintGetBlueprintStores GET /AgentBluePrint/{id}/Stores Gets the agent blueprint certificate stores
AgentPoolApi agentPoolCreateAgentPool POST /AgentPools Creates an agent pool with the provided properties
AgentPoolApi agentPoolDeleteAgentPool DELETE /AgentPools/{id} Deletes the agent pool associated with the provided id
AgentPoolApi agentPoolGetAgentPoolById GET /AgentPools/{id} Returns a single agent pool associated with the provided id
AgentPoolApi agentPoolGetAgentPools GET /AgentPools Returns all agent pools according to the provided filter and output parameters
AgentPoolApi agentPoolGetDefaultAgentPoolAgents GET /AgentPools/Agents Returns all agents for the default agent pool
AgentPoolApi agentPoolUpdateAgentPool PUT /AgentPools Updates an existing agent pool with the provided properties
AuditLogApi auditLogDownloadCSV GET /Audit/Download Returns a Comma Separated file containing the audit log entries according to the provided filter
AuditLogApi auditLogGetAuditLog GET /Audit/{id} Returns the audit log entry associated with the provided identifier
AuditLogApi auditLogGetAuditLogs GET /Audit Returns all audit log entries according to the provided filter and output parameters
AuditLogApi auditLogGetRelatedEntities GET /Audit/RelatedEntities Returns the audit log entry associated with the provided keyfactor id
AuditLogApi auditLogValidateAuditLog GET /Audit/{id}/Validate Validates the audit log entry associated with the provided keyfactor id
CertificateApi certificateAnalyzeCert POST /Certificates/Analyze Returns the public information of the certificate
CertificateApi certificateCertificateHistory GET /Certificates/{id}/History Gets the history of operations on a certificate
CertificateApi certificateCompareMetadata GET /Certificates/Metadata/Compare Compares the metadata value provided with the metadata value associated with the specified certificate
CertificateApi certificateDeleteByQuery DELETE /Certificates/Query Deletes multiple persisted certificate entities selected by a given query
CertificateApi certificateDeleteCertificate DELETE /Certificates/{id} Deletes a persisted certificate by its unique id as well as the stored private key (if present) associated with it
CertificateApi certificateDeleteCertificates DELETE /Certificates Deletes multiple persisted certificates by their unique ids
CertificateApi certificateDeletePrivateKeys0 DELETE /Certificates/PrivateKey Deletes the persisted private keys of multiple certificates by the unique ids of the Certificates
CertificateApi certificateDeletePrivateKeys1 DELETE /Certificates/PrivateKey/{id} Deletes the persisted private key of the certificate associated with the provided identifier
CertificateApi certificateDownloadCertificateAsync POST /Certificates/Download Downloads the persisted certificate associated with the provided query
CertificateApi certificateGetCertificate GET /Certificates/{id} Returns a single certificate that matches the id
CertificateApi certificateGetCertificateLocations GET /Certificates/Locations/{id} Returns a list of locations the certificate is in
CertificateApi certificateGetCertificateSecurity GET /Certificates/{id}/Security Gets the list of Security Identities and which permissions they have on the given certificate.
CertificateApi certificateIdentityAudit GET /Certificates/IdentityAudit/{id} Audit identity permissions for certificate
CertificateApi certificatePostImportCertificate POST /Certificates/Import Imports the provided certificate into the Keyfactor instance, including any provided associated data
CertificateApi certificateQueryCertificates GET /Certificates Returns all certificates according to the provided filter and output parameters
CertificateApi certificateRecoverCertificateAsync POST /Certificates/Recover Recovers the persisted certificate associated with the provided query
CertificateApi certificateRevoke POST /Certificates/Revoke Revokes the certificates associated with the provided identifiers and associates the provided data with the revocation
CertificateApi certificateRevokeAll POST /Certificates/RevokeAll Revokes the certificates associated with the provided query and Collection Id and associates the provided data with the revocation
CertificateApi certificateUpdateAllMetadata PUT /Certificates/Metadata/All Updates the metadata for certificates associated with the certificate identifiers or query provided
CertificateApi certificateUpdateMetadata PUT /Certificates/Metadata Updates the metadata for the certificate associated with the identifier provided
CertificateApi certificateValidateCertificate GET /Certificates/{id}/Validate Validates the certificate chain can be built.
CertificateAuthorityApi certificateAuthorityCreateCA POST /CertificateAuthority Creates a new CertificateAuthority object
CertificateAuthorityApi certificateAuthorityDeleteCA DELETE /CertificateAuthority/{id} Deletes a CertificateAuthority from the system, specified by ID
CertificateAuthorityApi certificateAuthorityGetCa GET /CertificateAuthority/{id} Returns details for a single CA, specified by ID
CertificateAuthorityApi certificateAuthorityGetCas GET /CertificateAuthority Returns all certificate authorities
CertificateAuthorityApi certificateAuthorityPublishCRL POST /CertificateAuthority/PublishCRL Publishes a CRL according to the provided request
CertificateAuthorityApi certificateAuthorityTestCertificateAuthority POST /CertificateAuthority/Test Validates the connection info for the CA provided by the model.
CertificateAuthorityApi certificateAuthorityUpdateCA PUT /CertificateAuthority Updates a CertificateAuthority object
CertificateCollectionApi certificateCollectionCopyFromExistingCollection POST /CertificateCollections/Copy Creates a new certificate collection from an existing collection. The permissions, query and description of the existing collection are copied when creating the new record, with the option to overwrite the query or description.
CertificateCollectionApi certificateCollectionCreateCollection POST /CertificateCollections Creates a new certificate collection with the provided properties
CertificateCollectionApi certificateCollectionGetCollection0 GET /CertificateCollections/{id} Returns the certificate collection definition associated with the provided Keyfactor identifier
CertificateCollectionApi certificateCollectionGetCollection1 GET /CertificateCollections/{name} Returns the certificate collection associated with the provided collection name
CertificateCollectionApi certificateCollectionGetCollections GET /CertificateCollections Returns all certificate collections
CertificateCollectionApi certificateCollectionSetCollectionPermissions POST /CertificateCollections/{id}/Permissions Set the permissions for a collection
CertificateCollectionApi certificateCollectionUpdateCollection PUT /CertificateCollections Updates an existing certificate collection with the provided properties
CertificateStoreApi certificateStoreAddCertificate POST /CertificateStores/Certificates/Add Configures a management job to add a certificate to one or more stores with the provided schedule
CertificateStoreApi certificateStoreApprovePending POST /CertificateStores/Approve Approves the provided certificate stores to make them available for management
CertificateStoreApi certificateStoreConfigureDiscoveryJob PUT /CertificateStores/DiscoveryJob Configures a discovery job to locate currently unmanaged certificate stores
CertificateStoreApi certificateStoreCreateCertificateStoreServer POST /CertificateStores/Server Creates a new certificate store server with the provided properties
CertificateStoreApi certificateStoreDeleteCertificateStore DELETE /CertificateStores/{id} Deletes a persisted certificate store by its Keyfactor identifier
CertificateStoreApi certificateStoreDeleteCertificateStores DELETE /CertificateStores Deletes multiple persisted certificate store entities by their identifiers
CertificateStoreApi certificateStoreGetCertificateStoreInventory GET /CertificateStores/{id}/Inventory Returns a single certificate store's inventory associated with the provided id
CertificateStoreApi certificateStoreRemoveCertificate POST /CertificateStores/Certificates/Remove Configures a management job to remove a certificate from one or more stores with the provided schedule
CertificateStoreApi certificateStoreSchedule POST /CertificateStores/Schedule Creates an inventory schedule for the provided certificate stores
CertificateStoreApi certificateStoreScheduleForReenrollment POST /CertificateStores/Reenrollment Schedules a certificate store for reenrollment
CertificateStoreApi certificateStoreSetPassword PUT /CertificateStores/Password Sets a password for the requested certificate store
CertificateStoreApi certificateStoreUpdateCertificateStoreServer PUT /CertificateStores/Server Updates a given certificate store server with the properties of the provided instance
CertificateStoreContainerApi certificateStoreContainerDeleteCertificateStoreContainers DELETE /CertificateStoreContainers/{id} Delete a certificate store container
CertificateStoreContainerApi certificateStoreContainerGetAllCertificateStoreContainers GET /CertificateStoreContainers Returns all certificate store container according to the provided filter and output parameters
CertificateStoreTypeApi certificateStoreTypeCreateCertificateStoreType POST /CertificateStoreTypes Creates a new certificate store type with the provided properties
CertificateStoreTypeApi certificateStoreTypeDeleteCertificateStoreType DELETE /CertificateStoreTypes/{id} Deletes a certificate store type according to the provided identifier
CertificateStoreTypeApi certificateStoreTypeDeleteCertificateStoreTypes DELETE /CertificateStoreTypes Deletes certificate store types according to the provided identifiers
CertificateStoreTypeApi certificateStoreTypeGetCertificateStoreType0 GET /CertificateStoreTypes/{id} Returns a single certificate store type that matches id
CertificateStoreTypeApi certificateStoreTypeGetCertificateStoreType1 GET /CertificateStoreTypes/Name/{name} Returns a single certificate store type that matches the provided short name
CertificateStoreTypeApi certificateStoreTypeGetTypes GET /CertificateStoreTypes Returns all certificate store types according to the provided filter and output parameters
CertificateStoreTypeApi certificateStoreTypeUpdateCertificateStoreType PUT /CertificateStoreTypes Updates an existing certificate store type with the provided properties
CsrGenerationApi cSRGenerationDeleteCSR DELETE /CSRGeneration/Pending/{id} Deletes a CSR associated with the provided identifier
CsrGenerationApi cSRGenerationDeleteCSRs DELETE /CSRGeneration/Pending Deletes the CSRs associated with the provided identifiers
CsrGenerationApi cSRGenerationDownload GET /CSRGeneration/Pending/{id} Returns a previously generated CSR associated with the provided identifier
CsrGenerationApi cSRGenerationGetPendingCSRs GET /CSRGeneration/Pending Returns a list of the currently pending CSRs according to the provided query
CsrGenerationApi cSRGenerationPostGenerate POST /CSRGeneration/Generate Generates a CSR according the properties provided
CustomJobTypeApi customJobTypeCreateJobType POST /JobTypes/Custom Creates a custom job type with the provided properties
CustomJobTypeApi customJobTypeDeleteJobType DELETE /JobTypes/Custom/{id} Deletes the custom job type associated with the provided id
CustomJobTypeApi customJobTypeGetJobTypeById GET /JobTypes/Custom/{id} Returns a single custom job type associated with the provided id
CustomJobTypeApi customJobTypeGetJobTypes GET /JobTypes/Custom Returns all custom job types according to the provided filter and output parameters
CustomJobTypeApi customJobTypeUpdateJobType PUT /JobTypes/Custom Updates an existing custom job type with the provided properties
DeniedAlertApi deniedAlertAddDeniedAlert POST /Alerts/Denied Add a denied alert
DeniedAlertApi deniedAlertDeleteDeniedAlert DELETE /Alerts/Denied/{id} Delete a denied alert
DeniedAlertApi deniedAlertEditDeniedAlert PUT /Alerts/Denied Edit a denied alert
DeniedAlertApi deniedAlertGetDeniedAlert GET /Alerts/Denied/{id} Get a denied alert
DeniedAlertApi deniedAlertGetDeniedAlerts GET /Alerts/Denied Gets all denied alerts according to the provided filter and output parameters
EnrollmentApi enrollmentAddToExistingCertStores POST /Enrollment/PFX/Replace Creates management jobs to install a newly enrolled pfx into the same certificate stores as the previous certificate
EnrollmentApi enrollmentAvailableRenewalId GET /Enrollment/AvailableRenewal/Id/{id} Returns the type of renewal available for a given certificate.
EnrollmentApi enrollmentAvailableRenewalThumbprint GET /Enrollment/AvailableRenewal/Thumbprint/{thumbprint} Returns the type of renewal available for a given certificate.
EnrollmentApi enrollmentGetMyCSRContext GET /Enrollment/CSR/Context/My Returns the list of available CSR enrollment templates and their associated CA mappings that the calling user has permissions on
EnrollmentApi enrollmentGetMyPFXContext GET /Enrollment/PFX/Context/My Returns the list of available PFX enrollment templates and their associated CA mappings that the calling user has permissions on
EnrollmentApi enrollmentGetTemplateEnrollmentSettings GET /Enrollment/Settings/{id} Gets the template settings to use during enrollment. The response will be the resolved values for the settings. If there is a template specific setting, the template specific setting will be used in the response. If there is not a template specific setting, the global setting will be used in the response.
EnrollmentApi enrollmentInstallPFXToCertStore POST /Enrollment/PFX/Deploy Creates management jobs to install a newly enrolled pfx in to one or more certificate stores
EnrollmentApi enrollmentPostCSREnroll POST /Enrollment/CSR Performs a CSR Enrollment based upon the provided request
EnrollmentApi enrollmentPostPFXEnroll POST /Enrollment/PFX Performs a PFX Enrollment based upon the provided request
EnrollmentApi enrollmentPostParsedCSR POST /Enrollment/CSR/Parse Parses the provided CSR and returns the properties
EnrollmentApi enrollmentRenew POST /Enrollment/Renew Performs a renewal based upon the passed in request
ExpirationAlertApi expirationAlertAddExpirationAlert POST /Alerts/Expiration Add an expiration alert
ExpirationAlertApi expirationAlertDeleteExpirationAlert DELETE /Alerts/Expiration/{id} Delete an expiration alert
ExpirationAlertApi expirationAlertEditExpirationAlert PUT /Alerts/Expiration Edit an expiration alert
ExpirationAlertApi expirationAlertEditSchedule PUT /Alerts/Expiration/Schedule Edit schedule
ExpirationAlertApi expirationAlertGetExpirationAlert GET /Alerts/Expiration/{id} Get an expiration alert
ExpirationAlertApi expirationAlertGetExpirationAlerts GET /Alerts/Expiration Gets all expiration alerts according to the provided filter and output parameters
ExpirationAlertApi expirationAlertGetSchedule GET /Alerts/Expiration/Schedule Get the schedule for expiration alerts
ExpirationAlertApi expirationAlertTestAllExpirationAlert POST /Alerts/Expiration/TestAll Test All Expiration Alerts
ExpirationAlertApi expirationAlertTestExpirationAlert POST /Alerts/Expiration/Test Test an Expiration Alert
IssuedAlertApi issuedAlertAddIssuedAlert POST /Alerts/Issued Add a issued alert
IssuedAlertApi issuedAlertDeleteIssuedAlert DELETE /Alerts/Issued/{id} Delete a issued alert
IssuedAlertApi issuedAlertEditIssuedAlert PUT /Alerts/Issued Edit a issued alert
IssuedAlertApi issuedAlertEditSchedule PUT /Alerts/Issued/Schedule Edit schedule
IssuedAlertApi issuedAlertGetIssuedAlert GET /Alerts/Issued/{id} Get a issued alert
IssuedAlertApi issuedAlertGetIssuedAlerts GET /Alerts/Issued Gets all issued alerts according to the provided filter and output parameters
IssuedAlertApi issuedAlertGetSchedule GET /Alerts/Issued/Schedule Get the schedule for issued alerts
KeyApi keyDeleteUnmanagedKey DELETE /SSH/Keys/Unmanaged/{id} Deletes Unmanaged Key associated with the provided identifier
KeyApi keyDeleteUnmanagedKeys DELETE /SSH/Keys/Unmanaged Deletes Unmanaged Keys associated with the provided identifiers
KeyApi keyGenerateKey POST /SSH/Keys/MyKey Generates an SSH Key Pair for the requesting user.
KeyApi keyGetMyKey GET /SSH/Keys/MyKey Returns the current key of the requesting user
KeyApi keyGetUnmanagedKey GET /SSH/Keys/Unmanaged/{id} Returns an unmanaged SSH key with provided id.
KeyApi keyGetUnmanagedKeys GET /SSH/Keys/Unmanaged Returns Unmanaged SSH keys
KeyApi keyUpdate PUT /SSH/Keys/MyKey Updates the requesting user's SSH key
KeyRotationAlertApi keyRotationAlertAddKeyRotationAlert POST /Alerts/KeyRotation Add a key rotation alert
KeyRotationAlertApi keyRotationAlertDeleteKeyRotationAlert DELETE /Alerts/KeyRotation/{id} Delete a key rotation alert
KeyRotationAlertApi keyRotationAlertEditKeyRotationAlert PUT /Alerts/KeyRotation Edit a key rotation alert
KeyRotationAlertApi keyRotationAlertEditSchedule PUT /Alerts/KeyRotation/Schedule Edit schedule
KeyRotationAlertApi keyRotationAlertGetKeyRotationAlert GET /Alerts/KeyRotation/{id} Get a key rotation alert
KeyRotationAlertApi keyRotationAlertGetKeyRotationAlerts GET /Alerts/KeyRotation Gets all key rotation alerts according to the provided filter and output parameters
KeyRotationAlertApi keyRotationAlertGetSchedule GET /Alerts/KeyRotation/Schedule Get the schedule for key rotation alerts
KeyRotationAlertApi keyRotationAlertTestAllKeyRotationAlert POST /Alerts/KeyRotation/TestAll Test All Alerts
KeyRotationAlertApi keyRotationAlertTestKeyRotationAlert POST /Alerts/KeyRotation/Test Test An Alert
LicenseApi licenseGetCurrentLicense GET /License Gets the current license
LogonApi logonCreateLogon POST /SSH/Logons Creates a logon with the provided properties
LogonApi logonDelete DELETE /SSH/Logons/{id} Deletes a Logon associated with the provided identifier
LogonApi logonGetLogon GET /SSH/Logons/{id} Fetches a Logon associated with the provided identifier
LogonApi logonLogonAccess POST /SSH/Logons/Access Updates the users with access to an existing logon
LogonApi logonQueryLogons GET /SSH/Logons Returns all Logons according to the provided filter parameters
MacEnrollmentApi macEnrollmentEditMacEnrollment PUT /MacEnrollment Updates mac enrollment settings data
MacEnrollmentApi macEnrollmentMacEnrollment GET /MacEnrollment Gets mac enrollment settings data
MetadataFieldApi metadataFieldCreateMetadataField POST /MetadataFields Creates a new metadata field type with the given metadata field type properties
MetadataFieldApi metadataFieldDeleteMetadataField DELETE /MetadataFields/{id} Deletes a persisted metadata field type by its unique id
MetadataFieldApi metadataFieldDeleteMetadataFields DELETE /MetadataFields Deletes multiple persisted metadata field types by their unique ids
MetadataFieldApi metadataFieldGetAllMetadataFields GET /MetadataFields Returns all metadata field types according to the provided filter and output parameters
MetadataFieldApi metadataFieldGetMetadataField0 GET /MetadataFields/{id} Gets a persisted metadata field type by its unique id
MetadataFieldApi metadataFieldGetMetadataField1 GET /MetadataFields/{name} Gets a persisted metadata field type by its unique name
MetadataFieldApi metadataFieldGetMetadataFieldInUse GET /MetadataFields/{id}/InUse Determines if a metadata field type associated with the provided identifier is currently in use
MetadataFieldApi metadataFieldUpdateMetadataField PUT /MetadataFields Updates a persisted metadata field with the given metadata field type
MonitoringApi monitoringAddRevocationMonitoring POST /Monitoring/Revocation Add a revocation monitoring endpoint
MonitoringApi monitoringDeleteRevocationMonitoring DELETE /Monitoring/Revocation/{id} Delete a revocation monitoring endpoint
MonitoringApi monitoringEditRevocationMonitoring PUT /Monitoring/Revocation Edit a revocation monitoring endpoint
MonitoringApi monitoringGetRevocationMonitoring GET /Monitoring/Revocation/{id} Get a revocation monitoring endpoint
MonitoringApi monitoringGetRevocationMonitoringEndpoints GET /Monitoring/Revocation Gets all revocation monitoring endpoints according to the provided filter and output parameters
MonitoringApi monitoringResolveOCSP POST /Monitoring/ResolveOCSP Resolve the Certificate authority given
MonitoringApi monitoringTestAllRevocationMonitoringAlert POST /Monitoring/Revocation/TestAll Test All Alerts
MonitoringApi monitoringTestRevocationMonitoringAlert POST /Monitoring/Revocation/Test Test Alert
OrchestratorJobApi orchestratorJobAcknowledgeJobs POST /OrchestratorJobs/Acknowledge Acknowledges orchestrator jobs based on the provided information
OrchestratorJobApi orchestratorJobGetCustomJobResultData GET /OrchestratorJobs/JobStatus/Data Retrieves the results of a custom job using the provided information
OrchestratorJobApi orchestratorJobGetJobHistory GET /OrchestratorJobs/JobHistory Returns all histories of an orchestrator job according to the provided filter and output parameters
OrchestratorJobApi orchestratorJobGetScheduledJobs GET /OrchestratorJobs/ScheduledJobs Returns all scheduled orchestrator jobs according to the provided filter and output parameters
OrchestratorJobApi orchestratorJobRescheduleJobs POST /OrchestratorJobs/Reschedule Reschedules orchestrator jobs based on the provided information
OrchestratorJobApi orchestratorJobScheduleBulkJob POST /OrchestratorJobs/Custom/Bulk Schedules the same job for a custom JobType on the specified agents using the provided information
OrchestratorJobApi orchestratorJobScheduleJob POST /OrchestratorJobs/Custom Schedules a job for a custom JobType on the agent using the provided information
OrchestratorJobApi orchestratorJobUnscheduleJobs POST /OrchestratorJobs/Unschedule Unschedules orchestrator jobs based on the provided information
PamProviderApi pAMProviderCreatePamProviderType POST /PamProviders/Types Creates a new PAM provider type with the associated properties
PamProviderApi pAMProviderDeletePamProvider DELETE /PamProviders/{id} Deletes a PAM Provider
PendingAlertApi pendingAlertAddPendingAlert POST /Alerts/Pending Add a pending alert
PendingAlertApi pendingAlertDeletePendingAlert DELETE /Alerts/Pending/{id} Delete a pending alert
PendingAlertApi pendingAlertEditPendingAlert PUT /Alerts/Pending Edit a pending alert
PendingAlertApi pendingAlertEditSchedule PUT /Alerts/Pending/Schedule Edit schedule
PendingAlertApi pendingAlertGetPendingAlert GET /Alerts/Pending/{id} Get a pending alert
PendingAlertApi pendingAlertGetPendingAlerts GET /Alerts/Pending Gets all pending alerts according to the provided filter and output parameters
PendingAlertApi pendingAlertGetSchedule GET /Alerts/Pending/Schedule Get the schedule for pending alerts
PendingAlertApi pendingAlertTestAllPendingAlert POST /Alerts/Pending/TestAll Test all pending alerts. Will send alert emails if SendAlerts is true
PendingAlertApi pendingAlertTestPendingAlert POST /Alerts/Pending/Test Test pending alert. Will send alert emails if SendAlerts is true
ReportsApi reportsCreateCustomReport POST /Reports/Custom Creates a custom report
ReportsApi reportsCreateReportSchedule POST /Reports/{id}/Schedules Create a built-in report's schedule that matches the id of the report.
ReportsApi reportsDeleteReport DELETE /Reports/Custom/{id} Delete custom report that matches the id
ReportsApi reportsDeleteReportSchedule DELETE /Reports/Schedules/{id} Delete a built-in report's schedule that matches the id of the schedule.
ReportsApi reportsGetCustomReport GET /Reports/Custom/{id} Returns a single custom report that matches the id
ReportsApi reportsGetReport GET /Reports/{id} Returns a single built-in report that matches the id
ReportsApi reportsGetReportParameters GET /Reports/{id}/Parameters Get a built-in report's parameters that matches the id of the report.
ReportsApi reportsGetReportSchedule GET /Reports/Schedules/{id} Get a built-in report's schedule that matches the id of the schedule.
ReportsApi reportsGetReportSchedules GET /Reports/{id}/Schedules Get a built-in report's schedules that matches the id of the report.
ReportsApi reportsQueryCustomReports GET /Reports/Custom Returns all custom reports according to the provided filter and output parameters
ReportsApi reportsQueryReports GET /Reports Returns all built-in reports according to the provided filter and output parameters
ReportsApi reportsUpdateCustomReport PUT /Reports/Custom Updates a custom report that matches the id
ReportsApi reportsUpdateReport PUT /Reports Updates a single built-in report that matches the id. Only some fields can be updated.
ReportsApi reportsUpdateReportParameters PUT /Reports/{id}/Parameters Update a built-in report's parameters that matches the id of the report.
ReportsApi reportsUpdateReportSchedule PUT /Reports/{id}/Schedules Update a built-in report's schedule that matches the id of the report.
SecurityApi securityDeleteSecurityIdentity DELETE /Security/Identities/{id} Deletes the security identity whose ID is provided.
SecurityApi securityIdentityPermissions GET /Security/Identities/{id} Gets an object representing the permissions of the identity associated with the provided identifier.
SecurityApi securityLookupIdentity GET /Security/Identities/Lookup Validates that the identity with the name given exists.
SecurityRolePermissionsApi securityRolePermissionsAddCollectionPermissions POST /Security/Roles/{id}/Permissions/Collections Adds collection permissions to the security role that matches the id.
SecurityRolePermissionsApi securityRolePermissionsAddContainerPermissions POST /Security/Roles/{id}/Permissions/Containers Adds container permissions to the security role that matches the id.
SecurityRolePermissionsApi securityRolePermissionsAddGlobalPermissions POST /Security/Roles/{id}/Permissions/Global Adds global permissions to the security role that matches the id.
SecurityRolePermissionsApi securityRolePermissionsGetCollectionPermissionsForRole GET /Security/Roles/{id}/Permissions/Collections Returns all collection permissions associated with the security role that matches the id.
SecurityRolePermissionsApi securityRolePermissionsGetContainerPermissionsForRole GET /Security/Roles/{id}/Permissions/Containers Returns all container permissions associated with the security role that matches the id.
SecurityRolePermissionsApi securityRolePermissionsGetGlobalPermissionsForRole GET /Security/Roles/{id}/Permissions/Global Returns all global permissions associated with the security role that matches the id.
SecurityRolePermissionsApi securityRolePermissionsGetPermissionsForRole GET /Security/Roles/{id}/Permissions Returns all permissions associated with the security role that matches the id.
SecurityRolePermissionsApi securityRolePermissionsSetCollectionPermissions PUT /Security/Roles/{id}/Permissions/Collections Sets collection permissions to the security role that matches the id.
SecurityRolePermissionsApi securityRolePermissionsSetContainerPermissions PUT /Security/Roles/{id}/Permissions/Containers Sets container permissions to the security role that matches the id.
SecurityRolePermissionsApi securityRolePermissionsSetGlobalPermissions PUT /Security/Roles/{id}/Permissions/Global Adds global permissions to the security role that matches the id.
SecurityRolesApi securityRolesDeleteSecurityRole DELETE /Security/Roles/{id} Deletes the security role whose ID is provided.
SecurityRolesApi securityRolesGetIdentitiesWithRole GET /Security/Roles/{id}/Identities Returns all identities which have the security role that matches the id.
SecurityRolesApi securityRolesUpdateIdentitiesWithRole PUT /Security/Roles/{id}/Identities Updates the identities which have the security role that matches the id.
ServerApi serverAddAccess POST /SSH/Servers/Access Updates logons and users with access to those logons for an existing server
ServerApi serverCreateServer POST /SSH/Servers Creates a server with the provided properties
ServerApi serverDelete DELETE /SSH/Servers/{id} Deletes a Server associated with the provided identifier
ServerApi serverGet GET /SSH/Servers/{id} Returns a Server associated with the provided identifier
ServerApi serverGetAccess GET /SSH/Servers/Access/{id} Retrieves logons and users with access to those logons for an existing server
ServerApi serverQueryServers GET /SSH/Servers Returns all servers according to the provided filter parameters
ServerApi serverRemoveAccess DELETE /SSH/Servers/Access Updates logons and users with access to those logons for an existing server
ServerApi serverUpdateServer PUT /SSH/Servers Updates an existing server with the provided properties
ServerGroupApi serverGroupAddAccess POST /SSH/ServerGroups/Access Add access rules to the server group
ServerGroupApi serverGroupCreateServerGroup POST /SSH/ServerGroups Creates a server group with the provided properties
ServerGroupApi serverGroupDelete DELETE /SSH/ServerGroups/{id} Deletes a ServerGroup associated with the provided identifier
ServerGroupApi serverGroupGetAccess GET /SSH/ServerGroups/Access/{id} Retrieves logons and users with access to those logons for an existing server group
ServerGroupApi serverGroupGetGroup GET /SSH/ServerGroups/{id} Returns a ServerGroup associated with the provided identifier
ServerGroupApi serverGroupGetGroupByName GET /SSH/ServerGroups/{name} Returns a ServerGroup associated with the provided identifier
ServerGroupApi serverGroupQueryServerGroups GET /SSH/ServerGroups Returns all server groups according to the provided filter parameters
ServerGroupApi serverGroupRemoveAccess DELETE /SSH/ServerGroups/Access Removes access mappings for the specified server group
ServerGroupApi serverGroupUpdateServerGroup PUT /SSH/ServerGroups Updates an existing server group with the provided properties
ServiceAccountApi serviceAccountCreateServiceAccount POST /SSH/ServiceAccounts Creates a ServiceAccount with the provided properties
ServiceAccountApi serviceAccountDeleteServiceAccount DELETE /SSH/ServiceAccounts/{id} Deletes a ServiceAccount associated with the provided identifier
ServiceAccountApi serviceAccountDeleteServiceAccounts DELETE /SSH/ServiceAccounts Deletes Service Accounts associated with the provided identifiers
ServiceAccountApi serviceAccountGet GET /SSH/ServiceAccounts/{id} Returns a ServiceAccount associated with the provided identifier
ServiceAccountApi serviceAccountGetServiceAccountKey GET /SSH/ServiceAccounts/Key/{id} Returns an SSH key with or without private key based on the provided parameters.
ServiceAccountApi serviceAccountQueryServiceAccounts GET /SSH/ServiceAccounts Returns all ServiceAccounts according to the provided filter parameters
ServiceAccountApi serviceAccountRotateServiceAccountKey POST /SSH/ServiceAccounts/Rotate/{id} Rotate an SSH key for a specified service account.
ServiceAccountApi serviceAccountUpdateServiceAccount PUT /SSH/ServiceAccounts Updates an SSH key for a specified service account.
SmtpApi sMTPSMTP GET /SMTP Gets SMTP profile data
SmtpApi sMTPTestSMTP POST /SMTP/Test Tests SMTP profile data
SmtpApi sMTPUpdateSMTP PUT /SMTP Updates SMTP profile data
SslApi sslAddNetworkRanges POST /SSL/NetworkRanges Adds the provided network range definitions to the associated network definition
SslApi sslCreateNetwork POST /SSL/Networks Creates a network definition according to the provided properties
SslApi sslEndpoint GET /SSL/Endpoints/{id} Returns the details of the associated scanning endpoint
SslApi sslEndpointHistory GET /SSL/Endpoints/{id}/History Returns a list of the scan results for the provided endpoint according to the provided filter and output parameters
SslApi sslGetNetwork GET /SSL/Networks/{identifier} Returns a defined SSL network according to the provided name
SslApi sslGetNetworkRangesForNetwork GET /SSL/NetworkRanges/{id} Returns the network range definitions for the provided network definition
SslApi sslGetNetworks GET /SSL/Networks Returns all defined SSL networks according to the provided filter and output parameters
SslApi sslImmediateSslScan POST /SSL/Networks/{id}/Scan Starts an SSL Scan for the network according to the associated network definition
SslApi sslMonitorAll PUT /SSL/Endpoints/MonitorAll Sets all endpoints matching the provided query as 'monitored'
SslApi sslMonitoringStatus PUT /SSL/Endpoints/MonitorStatus Sets the monitored status according to the provided endpoint and boolean status
SslApi sslNetworkScanParts GET /SSL/Networks/{id}/Parts Returns the scan job components comprising the entire scan job to be executed
SslApi sslRemoveAllNetworkRanges DELETE /SSL/NetworkRanges/{id} Removes all network range definitions from the associated network definition
SslApi sslRemoveNetwork DELETE /SSL/Networks/{id} Removes a network definition according to the provided identifier
SslApi sslResults GET /SSL Returns a list of the endpoint scan results according to the provided filter and output parameters
SslApi sslReviewAll PUT /SSL/Endpoints/ReviewAll Sets all endpoints matching the provided query as 'reviewed'
SslApi sslReviewedStatus PUT /SSL/Endpoints/ReviewStatus Sets the reviewed status according to the provided endpoint and boolean status
SslApi sslScanPart GET /SSL/Parts/{id} Returns the execution details of the associated network scan job part
SslApi sslSetNetworkRanges PUT /SSL/NetworkRanges Configures network range definitions for the provided network
SslApi sslUpdateNetwork PUT /SSL/Networks Updates an existing network definition according to the provided properties
SslApi sslValidateNetworkRanges POST /SSL/NetworkRanges/Validate Validates the format (using regular expressions) of the provided network range definitions
StatusApi statusGetEndpoints GET /Status/Endpoints Returns all endpoints to which the requesting identity has access
TemplateApi templateGetGlobalSettings GET /Templates/Settings Gets the global template settings.
TemplateApi templateGetTemplate GET /Templates/{id} Returns the certificate template associated with the provided id
TemplateApi templateGetTemplates GET /Templates Returns all certificate templates according to the provided filter and output parameters
TemplateApi templateGetValidSubjectParts GET /Templates/SubjectParts
TemplateApi templateImport POST /Templates/Import Imports templates from the provided configuration tenant
TemplateApi templateUpdateGlobalSettings PUT /Templates/Settings Replaces the existing global template settings.
TemplateApi templateUpdateTemplate PUT /Templates Updates a certificate template according to the provided properties
UserApi userCreateUser POST /SSH/Users Creates a new SSH User.
UserApi userDeleteUser DELETE /SSH/Users/{id} Deletes an SSH user.
UserApi userGetUser GET /SSH/Users/{id} Looks up information about an existing SSH user.
UserApi userQueryUsers GET /SSH/Users Returns users matching the criteria from the provided query parameters
UserApi userUpdateUser PUT /SSH/Users Updates information about a given user.
UserApi userUserAccess POST /SSH/Users/Access Updates logon access for a user
WorkflowApi workflowApprovePendingRequests POST /Workflow/Certificates/Approve Approves pending certificate requests associated with the provided ids
WorkflowApi workflowDenyPendingRequests POST /Workflow/Certificates/Deny Denies pending certificate requests associated with the provided ids
WorkflowApi workflowGet GET /Workflow/Certificates/Pending Gets a collection of certificate requests based on the provided query.
WorkflowApi workflowGetCertificateRequestDetails GET /Workflow/Certificates/{id} Returns certificate request details based on the provided ID.
WorkflowApi workflowGetDenied GET /Workflow/Certificates/Denied Gets a collection of denied certificate requests based on the provided query.
WorkflowDefinitionApi workflowDefinitionConfigureDefinitionSteps PUT /Workflow/Definitions/{definitionId}/Steps Sets the provided steps on the latest version of the definition.
WorkflowDefinitionApi workflowDefinitionCreateNewDefinition POST /Workflow/Definitions Creates a new base definition without any steps.
WorkflowDefinitionApi workflowDefinitionDelete DELETE /Workflow/Definitions/{definitionId} Deletes the definition matching the given Id.
WorkflowDefinitionApi workflowDefinitionGet GET /Workflow/Definitions/{definitionId} Gets a workflow definition.
WorkflowDefinitionApi workflowDefinitionGetStepSchema GET /Workflow/Definitions/Steps/{extensionName} Gets the schema of a given step with the specified extension name.
WorkflowDefinitionApi workflowDefinitionPublishDefinition POST /Workflow/Definitions/{definitionId}/Publish Makes the most recent version of a Workflow Definition the published version.
WorkflowDefinitionApi workflowDefinitionQuery GET /Workflow/Definitions Gets the Definitions matching the query specifications.
WorkflowDefinitionApi workflowDefinitionQueryAvailableSteps GET /Workflow/Definitions/Steps Gets the result set of available steps for a given query.
WorkflowDefinitionApi workflowDefinitionQueryWorkflowTypes GET /Workflow/Definitions/Types Performs a query against the workflow types in the system.
WorkflowDefinitionApi workflowDefinitionUpdateExistingDefinition PUT /Workflow/Definitions/{definitionId} Updates the existing definition's DisplayName and Description.
WorkflowInstanceApi workflowInstanceDeleteInstance DELETE /Workflow/Instances/{instanceId} Deletes the specified instance.
WorkflowInstanceApi workflowInstanceGet GET /Workflow/Instances/{instanceId} Get information relevant for knowing where an instance is in its workflow.
WorkflowInstanceApi workflowInstanceQuery GET /Workflow/Instances Gets the workflow instances matching the query specifications.
WorkflowInstanceApi workflowInstanceQueryInstancesAssignedToMe GET /Workflow/Instances/AssignedToMe Gets the workflow instances waiting on the user.
WorkflowInstanceApi workflowInstanceQueryInstancesStartedByMe GET /Workflow/Instances/My Gets the workflow instances started by the user.
WorkflowInstanceApi workflowInstanceRestart POST /Workflow/Instances/{instanceId}/Restart Restarts a failed instance against the specified definition version or the published version if no version is specified.
WorkflowInstanceApi workflowInstanceSignal POST /Workflow/Instances/{instanceId}/Signals Receives the given signal for the given instance.
WorkflowInstanceApi workflowInstanceStop POST /Workflow/Instances/{instanceId}/Stop Rejects an instance, preventing it from continuing.

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication

Keyfactor-v1

  • API version: v1

This reference serves to document REST-based methods to manage and integrate with Keyfactor. In addition, an embedded interface allows for the execution of calls against the current Keyfactor API instance.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

About

Client SDK in Java for the Keyfactor Web API

Topics

java keyfactor-api-client

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

2 stars

Watchers

26 watching

Forks

0 forks
Report repository

Releases

1 tags

Contributors

Languages