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. Run GET Security Claims ID 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 625: GET Security Claims Roles Input Parameters

Name In Description
Claim Type Body

Required. An integer indicating the type of claim. Supported values are:

Claim Type Integer Claim Type String Description
0 User Active Directory user account
1 Group

Active Directory group.
2 Computer

Active Directory machine account
3 OAuth Oid

An open authorization claim of a type not covered by client, role or subject
4 OAuth Role

An open authorization group claim
5 OAuth Subject

An open authorization user claim
6 OAuth ClientId

An open authorization client application claim
Claim Value Body Required. A string containing the identifying information for the entity specified in the claim. For Active Directory users and groups, this will be in the form DOMAIN\user or group name (e.g. KEYEXAMPLE\PKI Administrators). For Active Directory computers, this will be in the form of a machine account (e.g. KEYEXAMPLE\MyServer$).
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 626: 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 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 the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. 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.