The GET /PamProviders method returns a list of all the PAM providers that have been configured in Keyfactor Command. This method returns HTTP 200 OK on a success with details about each PAM provider.
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.
This method has two available versions. Keyfactor recommends using the newer method when possible. For more information about versioning, see Versioning.
Version 2 of the GET /PamProviders method has been redesigned to remove references to PAM associations with areas and containers.
Table 523: GET PamProviders v2 Input Parameters
| Name | In | Description |
|---|---|---|
|
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:
|
|
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. |
|
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 524: GET PamProviders v2 Response Data
| Name | Description |
|---|---|
| Id | An integer indicating the Keyfactor Command reference ID for the PAM provider. This ID is automatically set by Keyfactor Command. |
| Name |
A string indicating the name of the PAM provider. This name is used to identify the PAM provider throughout Keyfactor Command. |
| Provider Type |
An object containing details about the provider type for the provider. |
| Provider Type Param Values |
An array of objects containing the values for the provider types specified by ProviderTypeParam. . |
| Remote | A Boolean indicating whether the PAM provider is local to the Keyfactor Command server (false) or local to the orchestrator (true). The default is false. |
Version 1 of the GET /PamProviders method includes the same capabilities as version 2 except it includes references to the deprecated parameters related to the area of Keyfactor Command to which the PAM provider applies.
Table 525: GET PamProviders v1 Input Parameters
| Name | In | Description |
|---|---|---|
| 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:
|
| 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. |
| 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 526: GET PamProviders v1 Response Data
| Name | Description |
|---|---|
| Id | An integer indicating the Keyfactor Command reference ID for the PAM provider. This ID is automatically set by Keyfactor Command. |
| Name |
A string indicating the name of the PAM provider. This name is used to identify the PAM provider throughout Keyfactor Command. |
| Area |
An integer indicating the area of Keyfactor Command the provider is used for. This is considered deprecated and may be removed in a future release. |
| Provider Type |
An object containing details about the provider type for the provider. |
| Provider Type Param Values |
An array of objects containing the values for the provider types specified by ProviderTypeParam. . |
| Remote | A Boolean indicating whether the PAM provider is local to the Keyfactor Command server (false) or local to the orchestrator (true). The default is false. |
| Secure Area Id |
An integer indicating the Keyfactor Command reference ID for the certificate store container the PAM provider is associated with, if any. This is considered deprecated and may be removed in a future release. |
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 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.