POST PAM Providers

The POST /PamProviders method creates a new PAM provider. This method returns HTTP 200 OK on a success with details for the new provider.

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.

Table 497: POST PamProviders Input Parameters

Name In Description
Name Body

Required. A string indicating the name of the PAM provider. This name is used to identify the PAM provider throughout Keyfactor Command.

Important:  The name you give to your PAM provider in Keyfactor Command must match the name of the PAM provider as referenced in the manifest.json file (see Installing Custom PAM Provider Extensions).
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 can be used for certificate stores.
Provider Type Body

An object containing details about the provider type for the provider. ClosedShow provider type details.

Provider Type Param Values Body

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

Secure Area Id Body

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.

Table 498: POST 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 is used to identify the PAM provider throughout Keyfactor Command.

Area An integer indicating the area of Keyfactor Command the provider is used for. PAM providers generally have a value of 1, indicating they can be used for certificate stores.
Provider Type

An object containing details about the provider type for the provider. ClosedShow provider type details.

Provider Type Param Values

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

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.

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