POST Security Roles ID Permissions Containers

The POST /Security/Roles/{id}/Permissions/Containers method is used to add new container permissions to the security role that matches the ID. This method returns HTTP 200 OK on a success with certificate store container permission details for the specified security role.

Important: Only the permission settings included in the command will be affected. Any other permissions settings will not be affected and remain as is.

Note: The API

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. Endpoint

An endpoint is a URL that enables the API to gain access to resources on a server. utility displays a list of valid global permissions on the endpoint.

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 681: POST Security Roles {id} Permissions Containers Input Parameters

Name

Description

Path

Required. An integer indicating the Keyfactor Command reference ID of the security role for which to set certificate store container permissions.

Use the GET /Security/Roles method (see GET Security Roles) to retrieve a list of all the security roles to determine the role's ID.

containerPermissions

Body

An object containing information about the permissions granted to certificate store containers for this security role. Show container details.

Name	Description
ContainerId	Required. An integer containing the Keyfactor Command identifier for the certificate store container.
Permission	Required. A string indicating the permission granted on the container for this role—Read, Schedule, or Modify. Tip: Users with Modify permissions on a container inherit Read and Schedule; users with Schedule permissions on a container inherit Read.

Table 682: POST Security Roles {id} Permissions Containers Response Data

Name

Description

An object containing information about the certificate store container permissions granted to the security role. Show details.

Name	Description
ContainerId	An integer containing the container ID.
Name	A string containing the name of the certificate store container.
Permission	A string indicating the permission granted on the entity for this role.

Tip: See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor API endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow

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 top of the Management Portal page next to the Log Out button.

Version v24.4.4

On this page: