Enrollment

The Enrollment Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA). component of the Keyfactor 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. includes methods necessary to enroll certificate signing requests (CSRs) and personal information exchanges (PFXs).

Table 318: Enrollment Endpoints

Endpoint	Method	Description	Link
/Settings/{Id}	GET	Returns the template A certificate template defines the policies and rules that a CA uses when a request for a certificate is received. settings to use during enrollment.	GET Enrollment Settings ID
/CSR A CSR or certificate signing request is a block of encoded text that is submitted to a CA when enrolling for a certificate. When you generate a CSR within Keyfactor Command, the matching private key for it is stored in Keyfactor Command in encrypted format and will be married with the certificate once returned from the CA./Context/My	GET	Returns the templates available for CSR enrollment by the current user.	GET Enrollment CSR Content My
/PFX A PFX file (personal information exchange format), also known as a PKCS#12 archive, is a single, password-protected certificate archive that contains both the public and matching private key and, optionally, the certificate chain. It is a common format for Windows servers./Context/My	GET	Returns the templates available for PFX enrollment by the current user.	GET Enrollment PFX Content My
/AvailableRenewal/Id/{id}	GET	Returns the type of renewals available for the referenced certificate ID.	GET Enrollment Available Renewal ID
/AvailableRenewal/Thumbprint/{thumbprint}	GET	Returns the type of renewals available for the referenced certificate thumbprint.	GET Enrollment Available Renewal Thumbprint
/CSR	POST	Performs a CSR enrollment.	POST Enrollment CSR
/PFX	POST	Performs a PFX enrollment.	POST Enrollment PFX
/CSR/Parse	POST	Returns information found in a CSR in a human friendly form.	POST Enrollment CSR Parse
/PFX/Deploy	POST	Adds a certificate into a certificate store following a PFX enrollment or certificate renewal.	POST Enrollment PFX Deploy
/PFX/Replace	POST	Replaces a certificate in a certificate store following a PFX enrollment.	POST Enrollment PFX Replace
/Renew	POST	Performs a certificate renewal.	POST Enrollment Renew