Security

The Security component of the Keyfactor APIClosed An API is 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 list, add, and delete security identities and the permissions that are used to control access to aspects of Keyfactor Command.

Table 668: Security Endpoints

Endpoint Method Description Link
/Audit/Collections/{id} GET Returns permission details for the certificate collection with the specified ID. GET Security Audit Collections ID
/Containers/{id}/Roles GET Returns permission details for the certificate store container with the specified ID. GET Security Containers ID Roles
/Containers/{id}/Roles POST Sets the permissions of the certificate store container with the specified ID. POST Security Containers ID Roles
/Identities GET Returns all security identities with with sorting and filter options. GET Security Identities
/Identities POST Adds a new security identity into Keyfactor Command. POST Security Identities
/Identities/{id} DELETE Deletes the security identity with the specified ID. DELETE Security Identities ID
/Identities/{id} GET Returns permission details for the security identity with the specified ID. GET Security Identities ID
/Identities/Lookup GET Validates that the identity with the specified name exists. GET Security Identities Lookup
/My GET

Returns permission details for the current user, including certificate collections and certificate store containers.

Important:  This endpoint has been deprecated. It is retained for backwards compatibility, but new development should use the GET /Security/My/Permissions method (see GET Security My Permissions).
 GET Security My
/My/Permissions GET Returns permission details for the current user. GET Security My Permissions