API
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 this release of Keyfactor Command.
Table 861: 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 | |
| Certificate Authority/ SourceCount | GET | Added | |
| Certificate Authority/ ConfigurationTenants | GET | Added | |
| Certificate Authority/ HealthMonitoring/ Schedule | GET | Added | |
| Certificate Authority/ AlertRecipients/ CAHealth Recipients | GET | Added | |
| Certificate Authority/ AlertRecipients/ CAHealth Recipients | POST | Added | |
| Certificate Authority/ AlertRecipients/ CAThreshold Recipients | GET | Added | |
| Certificate Authority/ AlertRecipients/ CAThreshold Recipients | POST | Added | |
| Certificate Authority/ AlertRecipients/ CAHealth Recipients/ {id} | DELETE | Added | |
| CertificateAuthority/ AlertRecipients/ CAHealth Recipients/ {id} | GET | Added | |
| Certificate Authority/ AlertRecipients/ CAHealth Recipients/ {id} | PUT | Added | |
| Certificate Authority/ AlertRecipients/ CAThreshold Recipients/ {id} | DELETE | Added | |
| Certificate Authority/ AlertRecipients/ CAThreshold Recipients/ {id} | GET | Added | |
| Certificate Authority/ AlertRecipients/ CAThreshold Recipients/ {id} | PUT | Added | |
| Certificate Authority/ Import | POST | Added | |
| Certificate Authority/ 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. |
| Certificate Collections/ {id}/ Permissions | POST | Removed | Instead use POST Security/Roles/{id}/Permissions/Collection. |
| Certificate Collections/ {id} | DELETE | Added | |
| Certificate Collections/ NavItems | GET | Added | |
| Certificate Collections/ CollectionList | GET | Added | |
| Certificate Collections/ {id}/ Favorite | PUT | Added | |
| Certificate Stores/ Server | GET, POST, PUT | Deprecated | |
| Certificate Store Types | GET | Changed |
The API will return ALL certificate store types if at least one of these conditions are met:
|
| Component Installation/{id} | DELETE | Added | |
| Component Installation/ | GET | Added | |
| Event Handler Registration/ {id} | GET, DELETE, PUT | Added | |
| Event Handler Registration/ | GET, POST | Added | |
| Extensions/ Scripts/ {id} | DELETE, GET | Added | |
| Extensions/ Scripts | GET, POST, PUT | Added | |
| Identity Providers/ {id} | GET, PUT | Added | |
| Identity Providers | GET | Added | |
| Identity Providers/ Types | GET | Added | |
| Permissions | GET | Added | |
| Permission Sets/ {id} | GET, DELETE | Added | |
| Permission Sets | 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/ Pam Providers | 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. |