PUT PAM Providers

The PUT /PamProviders method updates an existing PAM provider. This method returns HTTP 200 OK on a success with details for the updated provider.

Tip:  The following permissions (see Security Overview) are required to use this feature:

CertificateStoreManagement: Modify
PrivilegedAccessManagement: Modify
SystemSettings: Read

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 404: PUT PamProviders Input Parameters

Name In Description
ID Body Required. An integer indicating the Keyfactor Command reference ID for the PAM provider. This ID is automatically set by Keyfactor Command.
Name Body

Required. A string indicating the name of the PAM provider. This name used to identify the PAM provider throughout Keyfactor.
Area Body An integer indicating the area of Keyfactor Command the provider is used for. PAM providers generally have a value of 1, indicating they are used for certificate stores.
ProviderType Body

An array containing details about the provider type for the provider.

ProviderTypeParamValues Body

An array containing the values for the provider types specified by ProviderTypeParams.

SecureAreaId Body

An integer indicating the Keyfactor Command reference ID for the certificate store container the PAM provider is associated with, if any.

You can create a single PAM provider for each provider type (e.g. CyberArk), however, if you have opted to organize your certificate stores into containers, you will need to create multiple providers to match your container organization structure. The container field in the PAM provider definition is not required, but if one is supplied when creating a PAM provider, the PAM provider can only be used with certificate stores in the matching container. Likewise, a PAM provider defined with no container would be available for selection when setting passwords for any certificate store that also did not specify a container. A PAM provider configured in this way could be used across a variety of certificate stores (e.g. both JKS and F5) as long as they were not in containers.

Table 405: PUT PamProviders 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 used to identify the PAM provider throughout Keyfactor.
Area An integer indicating the area of Keyfactor Command the provider is used for. PAM providers generally have a value of 1, indicating they are used for certificate stores.
ProviderType

An array containing details about the provider type for the provider. ClosedShow provider type details.
ProviderTypeParamValues

An array containing the values for the provider types specified by ProviderTypeParams. ClosedShow provider type parameter value details.
SecureAreaId

An integer indicating the Keyfactor Command reference ID for the certificate store container the PAM provider is associated with, if any.

You can create a single PAM provider for each provider type (e.g. CyberArk), however, if you have opted to organize your certificate stores into containers, you will need to create multiple providers to match your container organization structure. The container field in the PAM provider definition is not required, but if one is supplied when creating a PAM provider, the PAM provider can only be used with certificate stores in the matching container. Likewise, a PAM provider defined with no container would be available for selection when setting passwords for any certificate store that also did not specify a container. A PAM provider configured in this way could be used across a variety of certificate stores (e.g. both JKS and F5) as long as they were not in containers.
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.