Client certificates

Client certificates API overview

The Client certificates API allows integrators to manage client certificates within SCM.
The API supports listing and updating certificates, performing lifecycle actions (enroll, renew, revoke), managing deployment locations, working with certificate profiles and custom fields, and integrating with key agents for key download.

Client certificates API endpoints

The following tables group the Client certificates API endpoints by functionality.
Click any action in the first column to open its API reference page.

1. Certificate listing & details

Action	Method	Path	Description
List client certificates	GET	`/api/smime/v2`	List client certificates with optional filters.
List client certificates by Person ID	GET	`/api/smime/v2/byPersonId/{pid}`	List all Client Certificates for a person with given ID.
List client certificates by Person Email	GET	`/api/smime/v2/byPersonEmail/{email}`	List all List all Client Certificates for a person with given email.

2. Enrollment & import

Action	Method	Path	Description
Import client certificates	POST	`/api/smime/v2/import`	Import existing client certificates into SCM for management.

3. Certificate lifecycle actions

Action	Method	Path	Description
Renew a certificate by serial number	POST	`/api/smime/v2/renew/serial/{serialNumber}`	Renew a client certificate using its serial number.
Renew a certificate by backend certificate ID	POST	`/api/smime/v2/renew/order/{backendCertId}`	Renew a client certificate using its backend certificate ID.

4. Certificate locations

Action	Method	Path	Description
List certificate locations	GET	`/api/smime/v2/{certId}/location`	List locations associated with a client certificate.
Create a custom location	POST	`/api/smime/v2/{certId}/location`	Add a custom deployment location for a client certificate.
Get a certificate location	GET	`/api/smime/v2/{certId}/location/{locationId}`	Retrieve details of a specific certificate location.
Update a certificate location	PUT	`/api/smime/v2/{certId}/location/{locationId}`	Update a custom deployment location.
Delete a certificate location	DELETE	`/api/smime/v2/{certId}/location/{locationId}`	Remove a certificate’s deployment location.

5. Certificate & key download

Action	Method	Path	Description
Collect client certificate by backend certificate ID	GET	`/api/smime/v2/collect/{backendCertId}`	Download the issued client certificate using backend certificate ID.
Collect client certificate by ID	GET	`/api/smime/v2/collect/{id}`	Download the issued client certificate using certificate ID.