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 parameter
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 637: GET Security Claims Roles Input Parameters
| Name | In | Description |
|---|---|---|
| Claim Type | Body |
Required. An integer indicating the type of claim. Supported values are: |
| 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 638: GET Security Claims Roles Response Data
Tip: See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor 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. 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.
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 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.