The GET /Security/Claims/{id} method is used to return a security claim by ID. This method returns HTTP 200 OK on a success with details for the specified security claim.
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/security/read/
Table 684: GET Security Claims{id} Input Parameters
| Name | In | Description |
|---|---|---|
| id | Path |
Required. The Keyfactor Command reference ID of the security claim to retrieve. Use the GET /Security/Claims method (see GET Security Claims) to retrieve a list of all the security claims to determine the claim's ID. |
Table 685: GET Security Claims{id} Response Data
| Name | Description |
|---|---|
| Id | An integer containing the Keyfactor Command reference ID for the security claim. |
| Description | A string indicating a description for the security claim. |
| Claim Type |
A string indicating the type of claim. |
| Claim Value | 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 |
An object containing information about the provider assigned to the security claim. |
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.Was this page helpful? Provide Feedback