The GET /PamProviders/{id} method is used to return a PAM provider by ID. This method returns HTTP 200 OK on a success with details about the specified 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/{id} method has been redesigned to remove references to PAM associations with areas and containers.
Table 583: GET PamProviders {id} v2 Input Parameters
| Name | In | Description |
|---|---|---|
| id | Path |
Required. The Keyfactor Command reference ID of the PAM provider to retrieve. Use the GET /PAM/Providers method (see GET PAM Providers) to retrieve a list of all the PAM providers to determine the provider's ID. |
Table 584: GET PamProviders {id} 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/{id} 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 585: GET PamProviders {id} Iv1 nput Parameters
| Name | In | Description |
|---|---|---|
| id | Path |
Required. The Keyfactor Command reference ID of the PAM provider to retrieve. Use the GET /PAM/Providers method (see GET PAM Providers) to retrieve a list of all the PAM providers to determine the provider's ID. |
Table 586: GET PamProviders {id} 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. |
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