Security Roles

The Security Roles 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, update, and delete security roles which are used to control access to all aspects of Keyfactor Command.

Important:  In recent versions, all of the v1 security roles have been deprecated, except for DELETE /security/Roles/{id}. Keyfactor strongly recommends using the new v2 endpoints (v1 will be removed in a future version).

Table 741: Security Roles Endpoints

Endpoint Method Description Link
/{id} GET Returns details for the security role with the specified ID, including permissions granted to the role and claims assigned the role. GET Security Roles ID
/{id} DELETE Deletes the security role with the specified ID. DELETE Security Roles ID
/ GET Returns all security roles with filtering and output options. GET Security Roles
/ POST Adds a new security role. POST Security Roles
/ PUT Updates the security role with the specified ID. PUT Security Roles
/{id}/Identities GET

Returns the security identities assigned to the security role with the specified ID.

Important:  This endpoint has been deprecated. It is retained for backwards compatibility, but new development should not use this method.
 GET Security Roles ID Identities
/{id}/Identities PUT

Updates the security identities assigned to the security role with the specified ID.

Important:  This endpoint has been deprecated. It is retained for backwards compatibility, but new development should not use this method.
 PUT Security Roles ID Identities
/{id}/Copy POST

Adds a new security role by copying the existing security role with the specified ID.

Important:  This endpoint has been deprecated. It is retained for backwards compatibility, but new development should not use this method.
 POST Security Roles ID Copy