GET Permission Sets

The GET /PermissionSets method is used to return a list of the permission sets defined in Keyfactor Command (see Permission Sets). Query parameters enable filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. This method returns HTTP 200 OK on a success with details for the permission sets.

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

/security/read/

Table 625: GET Permission Sets Input Parameters

Name In Description
QueryString Query

There are no query parsers for this endpoint.
PageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
ReturnLimit Query An integer that specifies how many results to return per page. The default is 50. Very large values can result in long processing time.
SortField Query

A string containing the property by which the results should be sorted. Fields available for sorting through the API include:

  • Id

  • Name

The default sort field is Id.
SortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 626: GET Permission Sets Response Data

Name Description
Id A string containing the Keyfactor Command reference GUID for the permission set.
Permissions

An array of strings containing the permissions assigned to the permission set. See Version Two Permission Model 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 top of the Management Portal page next to the Log Out button.