API Change Log v11.0

APIClosed A set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. changes for Keyfactor Command version 11.0 major release

Table 844: API Change Log v11.0

Endpoint Methods Action Notes
AppSetting GET, PUT Added  
AppSetting /{id} GET Added  
AppSetting /{id} /Set PUT Added  
AppSetting /{name} /Set PUT Added  
CertificateAuthority /SourceCount GET Added  
CertificateAuthority /ConfigurationTenants GET Added  
CertificateAuthority /HealthMonitoring /Schedule GET Added  
CertificateAuthority /AlertRecipients /CAHealthRecipients GET Added  
CertificateAuthority /AlertRecipients /CAHealthRecipients POST Added  
CertificateAuthority /AlertRecipients /CAThresholdRecipients GET Added  
CertificateAuthority /AlertRecipients /CAThresholdRecipients POST Added  
CertificateAuthority /AlertRecipients /CAHealthRecipients /{id} DELETE Added  
CertificateAuthority /AlertRecipients /CAHealthRecipients /{id} GET Added  
CertificateAuthority /AlertRecipients /CAHealthRecipients /{id} PUT Added  
CertificateAuthority /AlertRecipients /CAThresholdRecipients /{id} DELETE Added  
CertificateAuthority /AlertRecipients /CAThresholdRecipients /{id} GET Added  
CertificateAuthority /AlertRecipients /CAThresholdRecipients /{id} PUT Added  
CertificateAuthority /Import POST Added  
CertificateAuthority /ConfigurationTenants GET Changed The endpoint is now renamed to GET /CertificateAuthority/AvailableForests and the definition is changed to: Returns a list of available forests that are in Active Directory.
Certificates /CSV GET Added  
Certificates /IdentityAudit /{id} GET Added to V2 definitions This API endpoint is available in both the V1 and V2 definitions in the Keyfactor API Reference and Utility and acts exactly the same in both.
CertificateCollections /{id} /Permissions POST Removed Instead use POST Security/Roles/{id}/Permissions/Collection.
CertificateCollections /{id} DELETE Added  
CertificateCollections /NavItems GET Added  
CertificateCollections /CollectionList GET Added  
CertificateCollections /{id}/Favorite PUT Added  
CertificateStores /Server GET, POST, PUT Deprecated  
CertificateStoreTypes GET Changed

The API will return ALL certificate store types if at least one of these conditions are met:

  • The end-user has one of the /certificate_stores/read/ global permissions.

  • The end-user has permission to at least one certificate store container.
ComponentInstallation /{id} DELETE Added  
ComponentInstallation/ GET Added  
EventHandlerRegistration /{id} GET, DELETE, PUT Added  
EventHandlerRegistration/ GET, POST Added  
Extensions/Scripts /{id} DELETE, GET Added  
Extensions/Scripts GET, POST, PUT Added  
IdentityProviders /{id} GET, PUT Added  
IdentityProviders GET Added  
IdentityProviders /Types GET Added  
Permissions GET Added  
PermissionSets/{id} GET, DELETE Added  
PermissionSets GET, POST, PUT Added  
Scheduling POST Added  
Security /Containers /{id} /Roles GET, POST Added  
Security /Audit /Collections /{id} GET Added  
Security /Claims /{id} GET, DELETE Added  
Security /Claims GET, POST, PUT Added  
Security /Claims /Roles GET Added  
Security /Identities GET Changed The non-working query string field has been removed.
Security /Roles /{id} /Permissions /PamProviders GET, PUT Added  

Security /Roles (V1)

Security /Roles /{id} (V1)

Security /Roles /{id} /Identities(V1)

Security /Roles /{id} /copy(V1)

 GET, POST, PUT Deprecated in V1 All SecurityRoles API endpoints (except DELETE /{id}) have been deprecated from the V1 API, as they only work against Active Directory users. There are new Security/Roles endpoints in the V2 API

Security /Roles (V2)

Security /Roles /{id} (V2)

 GET, POST, PUT Added in V2 Security/ Roles API endpoints have been recreated in V2 API to work with both OAUTH and AD users.
Templates /{id} GET Changed Now returns an object with a TemplatePolicy property and a KeyAlgorithms property that show the policies and algorithms the template supports.
Templates /Import GET, POST Changed Now supports multiple algorithms.
Templates/Settings GET, PUT Changed The Template Policy property used to update global application settings now contains four properties: ECDSA, RSA, Ed448, and Ed25519. These replace the AllowEd448, AllowEd25519, RSAValidCurves, and ECCValidCurves.