The GET /PamProviders/Local/{providerId}/Entries operation returns information for the secrets for the requested local PAM
PAM (Privileged Access Management): Controls privileged access by vaulting credentials, enforcing least-privilege/just-in-time access, rotating secrets, and auditing sessions. Across Keyfactor products, PAM protects diverse sensitive operations and secrets—for example certificate stores and CA credentials—via built-in or third-party providers; external integrations are delivered as custom PAM extensions (several published on Keyfactor’s public GitHub). provider, not including the actual secrets. Query parameters support filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. On success, the operation returns HTTP 200 OK with details for the local PAM provider secrets.
Permissions for PAM providers can be set at the system-wide level or with fine-grained control at the PAM provider level. See PAM Permissions for more information about the differences between system-wide and more targeted permissions.
Table 656: GET PamProviders Local {providerId} Entries Input Parameters
| Name | In | Description |
|---|---|---|
| ProviderId | Path | Required. The Keyfactor Command reference ID for the PAM provider associated with the secret. Use the GET PAM Providers operation to retrieve a list of all the PAM providers to determine the PAM provider's ID. |
|
QueryString |
Query |
A string containing a query to limit the results (for example, field1 -eq value1 AND field2 -gt value2). The default is to return all records. For querying guidelines, refer to: Using Search in the Management Portal. The query fields supported for this operation are:
|
|
PageReturned |
Query | An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1. |
|
ReturnLimit |
Query | An integer that specifies how many results to return per page. The default is 50. Very large values can result in long processing time. |
|
SortField |
Query |
A string containing the property by which the results should be sorted. Fields available for sorting through the API include:
Available sort fields are affected by the query provided in QueryString. The default sort field is SecretName. |
|
SortAscending |
Query | An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending. |
Table 657: GET PamProviders Local {providerId} Entries Response Data
| Name |
Description |
|---|---|
| ProviderId | An integer containing the Keyfactor Command reference ID for the PAM provider associated with the secret. |
| SecretName | A string containing the Keyfactor Command reference name for the PAM secret. |
| Description | A string containing a description for the PAM secret. |
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 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu (
) in the Management Portal.Was this page helpful? Provide Feedback