GET Security Claims Roles

The GET /Security/Claims/Roles operation returns the security roles assigned to the security claim identified by the selected parameters. Use the GET Security Claims ID operation to determine the parameterClosed A parameter or argument is a value that is passed into a function in an application. values. On success, the operation returns HTTP 200 OK 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 757: 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 (for example, Active Directory, or Client Certificate Authentication CA, or unknown). The value in the ProviderAuthenticationScheme parameter from GET Security Claims or GET Security Claims ID.

Table 758: 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 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.