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 operations necessary to list, add, update, and delete security roles which are used to control access to all aspects of Keyfactor Command.

Important:  The v1 /Security/Roles operations are deprecated, with the exception of DELETE /Security/Roles/{id}. Use the v2 /Security/Roles operations for all new development. The v1 operations will be removed in a future release.

Table 784: Security Roles Operations

Endpoint Version Method Description Link
/ 1 & 2 GET Returns all security roles with filtering and output options. GET Security Roles
/ 1 & 2 POST Adds a new security role. POST Security Roles
/ 1 & 2 PUT Updates the security role with the specified ID. PUT Security Roles
/{id} 1 & 2 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} 1 DELETE Deletes the security role with the specified ID. DELETE Security Roles ID
/{id}/claims 2 PUT Adds claims to the security role with the specified ID. PUT Security Roles ID Claims (v2)
/{id}/claims 2 DELETE Removes claims from the security role with the specified ID. DELETE Security Roles ID Claims (v2)
/{id}/Copy 1 POST

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

Important:  This operation has been deprecated. It is retained for backwards compatibility, but new development should not use it.
 POST Security Roles ID Copy
/{id}/Identities 1 GET

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

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

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

Important:  This operation has been deprecated. It is retained for backwards compatibility, but new development should not use it.
 PUT Security Roles ID Identities