PUT PAM Providers Local ID Entries

The PUT /PamProviders/Local/{providerId}/Entries method updates an existing PAM description for a local PAM provider secret. This method returns HTTP 200 OK on a success with details for the updated secret (not including the actual secret).

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/pam/modify/
OR
/pam/modify/#/ (where # is a reference to a specific PAM provider ID)

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

Important:  Any previously populated fields that are not submitted with their full existing data using this method will be cleared of their existing data. When using this method, you should first do a GET to retrieve all the values for the record you want to update, enter corrected data into the field(s) you want to update, and then submit all the fields using PUT, including the fields that contain values but which you are not changing.

Table 609: PUT PamProviders Local {providerId} Entries Input Parameters

Name Description
ProviderId Required. An integer containing the Keyfactor Command reference ID for the PAM provider associated with the secret.

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.

SecretName Required. A string containing the Keyfactor Command reference name for the PAM secret.
Description A string containing a description for the PAM secret.
SecretValue A string containing the secret data for the PAM secret. This data is not returned in responses or GET requests.

Table 610: PUT 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.