GET PAM Providers Local ID Entries

The GET /PamProviders/Local/{providerId}/Entries method returns information for the secrets for the requested local PAM provider, not including the actual secrets. Query parameters enable 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. This method returns HTTP 200 OK on a success with details for the local PAM provider secrets.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/pam/read/
OR
/pam/read/#/ (where # is a reference to a specific PAM provider ID)

Permissions for PAM providers can be set at either the global or PAM provider level. See PAM Permissions for more information about global vs PAM provider permissions.

Table 605: 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 to be deleted.

Use the GET /PamProviders method (see GET PAM Providers) 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 (e.g. field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to: Certificate Search Page. The query fields supported for this endpoint are:

  • Description
  • SecretName

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 for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. The default sort field is Name.

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 606: 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.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which 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. 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 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.