POST Security Applications ID Roles

The POST /Security/Applications/{id}/Roles method is used to assign permissions for a security role to a certificate store application. This method returns HTTP 200 OK on a success with the details of the security role and permissions.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/security/modify/

The user must hold a role containing this permission in the Global Permission Set (see Permission Sets).

Table 685: POST Security Applications {id} Roles Input Parameters

Name

In

Description
id Path

Required. An integer indicating the Keyfactor Command reference ID of the certificate store application to update.

Use the GET /Applications method (see GET Applications) to determine the ID of the certificate store application.

SecurityRoleId Body

Required. An integer indicating the Keyfactor Command reference ID of the security role granted permissions to the certificate store application.

Use the GET /Security/Roles method (see GET Security Roles) to determine the ID of the security role.

Permissions Body

Required. A comma-delimited array of strings indicating the permissions granted to the role for the certificate store application. See Certificate Stores for an overview of the possible permissions.

For example:

Copy
"Permissions": [
   "Read",
   "Modify"
]

Table 686: POST Security Applications {id} Roles Response Data

Name Description
SecurityRoleId

An integer indicating the Keyfactor Command reference ID of the security role granted permissions to the certificate store application.

Name A string containing the short reference name for the security role granted permissions to the certificate store application.
Permissions

A comma-delimited array of strings indicating the permissions granted to the role for the certificate store application. See Certificate Stores for an overview of the possible permissions.

Tip:  See the Keyfactor API Reference and Utility which provides a utility through which 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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the bottom of the Management Portal side menu.