GET Security Claims Roles

The GET /Security/Claims/Roles method is used to return the security roles assigned to the security claim identified by the selected parameters. Use the GET Security Claims ID method to determine the parameterClosed A parameter or argument is a value that is passed into a function in an application. values. This method returns HTTP 200 OK on a success with the details of the roles assigned to the claim.

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

/security/read/

Table 687: GET Security Claims Roles Input Parameters

Name In Description
Claim Type Body

Required. An integer indicating the type of claim. ClosedShow supported values.
Claim Value Body Required. A string containing the identifying information for the entity specified in the claim. For implementations authenticated using Active Directory, this will be in NetBIOS format (DOMAIN\account-name). For example, group KEYEXAMPLE\PKI Administrators or for a computer, machine account KEYEXAMPLE\MyServer$. For implementations authenticated using OAuth, this will be in the format defined by the Name Claim Type.
Provider Authentication Scheme Body Required. A string indicating the provider authentication scheme (e.g. Active Directory, or Client Certificate Authentication CA, or unknown). The value in the Provider Authentication Scheme parameter from GET Security Claims or GET Security Claims ID.

Table 688: GET Security Claims Roles Response Data

Name Description
Id An integer containing the Keyfactor Command reference ID for the security role.
Name A string containing the short reference name of the security role.
Description A string containing the description of the security role.
Permission SetId

A string containing the Keyfactor Command reference GUID for the permission set assigned to the security role.
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.