Documentation Suite v25.2

Submit Search

GET Certificate Stores

The GET /CertificateStores method is used to return a list of all certificate stores defined in Keyfactor Command. The results include both approved certificates stores and certificates stores found on discovery but not yet approved. Query parameters enable filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. This method returns HTTP 200 OK on a success with details about the certificate store(s).

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

/certificate_stores/read/

/certificate_stores/read/#/ (where # is a reference to a specific certificate store container ID)

Permissions for certificate stores can be set at either the global or certificate store container level. See Container Permissions for more information about global vs container permissions.

Table 387: GET Certificate Stores 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: Using the Certificate Store Search Feature. The query fields supported for this endpoint are: AddSupported (True, False) AgentAvailable (True, False) AgentId Approved (True, False) Category (0-Javakeystore, 2-PEMFile, 3-F5SSLProfiles,4-IISRoots, 5-NetScaler, 6-IISPersonal, 7-F5WebServer, 8-IISRevoked, 9-F5WebServerREST, 10-F5SSLProfilesREST, 11-F5CABundlesREST, 100-AmazonWebServices, 101-FileTransferProtocol) CertificateId ClientMachine Container (ContainerName) ContainerId HasInventoryScheduled (True, False) PrivateKeyAllowed (0-Forbidden, 1-Optional, 2-Required) ODKGSupported (True, False) RemoveSupported (True, False) StorePath Tip: Use the following query to limit the results to only active certificate stores and not include discovery results: approved -eq true
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. Very large values can result in long processing time.
SortField	Query	A string containing the property by which the results should be sorted. Fields available for sorting through the API include: AgentId Approved CertStoreType ClientMachine ContainerId ContainerName Storepath Available sort fields are affected by the query provided in QueryString. The default sort field is ClientMachine.
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 388: GET Certificate Stores Response Data

Name Description

Agent Assigned A Boolean that indicates whether there is an orchestrator assigned to this certificate store (true) or not (false).

AgentId A string indicating the Keyfactor Command GUID of the orchestrator for this store.

Approved A Boolean that indicates whether a certificate store is approved (true) or not (false). If a certificate store is approved, it can be used and updated. A certificate store that has been discovered using the discover feature but not yet marked as approved will be false here.

Cert Store Inventory JobId A string indicating the GUID that identifies the inventory job for the certificate store in the Keyfactor Command database. This will be null if an inventory schedule is not set for the certificate store.

Cert Store Type An integer indicating the ID of the certificate store type, as defined in Keyfactor Command, for this certificate store. Built-in certificates store types are: (0-Javakeystore, 2-PEMFile, 3-F5SSLProfiles,4-IISRoots, 5-NetScaler, 6-IISPersonal, 7-F5WebServer, 8-IISRevoked, 9-F5WebServerREST, 10-F5SSLProfilesREST, 11-F5CABundlesREST, 100-AmazonWebServices, 101-FileTransferProtocol). Any custom extensions for the Keyfactor Universal Orchestrator you add will have certificate store types numbered 102+.

ClientMachine

A string containing the client machine name. The value for this will vary depending on the certificate store type. Typically, it is the hostname of the machine on which the store is located, but this may vary. See Adding or Modifying a Certificate Store for more information.

Container Name A string indicating the name of the certificate store's associated container, if applicable.

ContainerId An integer indicating the ID of the certificate store's associated certificate store container, if applicable (see GET Certificate Store Containers).

Create If Missing A Boolean that indicates whether a new certificate store should be created with the information provided (true) or not (false). This option is only valid for Java keystores and any custom certificate store types you have defined to support this functionality.

DisplayName A string indicating the name of the certificate store as it will display in the Management Portal. This value includes the client machine and the store path.

Id A string indicating the GUID of the certificate store within Keyfactor Command. This ID is automatically set by Keyfactor Command.

Inventory Schedule

An object indicating the inventory schedule for this certificate store. Show schedule details.

Name

Description

Off Turn off a previously configured schedule.

Immediate

A Boolean that indicates a job scheduled to run immediately (true) or not (false).

Tip: In some instances, jobs initially scheduled as Immediate will appear on a GET as null.

Interval

A dictionary that indicates a job scheduled to run every x minutes with the specified parameter. Any interval that is selected in the UI will be converted to minutes when stored in the database.

Name	Description
Minutes	An integer indicating the number of minutes between each interval.

For example, every hour:

Copy

"Interval": {
   "Minutes": 60
}

Daily

A dictionary that indicates a job scheduled to run every day at the same time with the parameter:

Name	Description
Time	The date and time to next run the job. The date and time should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-19T16:23:01Z).

For example, daily at 11:30 pm:

Copy

"Daily": {
   "Time": "2023-11-25T23:30:00Z"
}

Weekly

A dictionary that indicates a job scheduled to run on a specific day or days every week at the same time with the parameters:

Name	Description
Time	The date and time to next run the job. The date and time should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-19T16:23:01Z).
Days	An array of values representing the days of the week on which to run the job. These can either be entered as integers (0 for Sunday, 1 for Monday, etc.) or as days of the week (e.g. “Sunday”).

For example, every Monday, Wednesday and Friday at 5:30 pm:

Copy

"Weekly": {
   "Days": [
      "Monday",
      "Wednesday",
      "Friday"
   ],
   "Time": "2023-11-27T17:30:00Z"
}

Exactly Once

A dictionary that indicates a job scheduled to run at the time specified with the parameter:

Name	Description
Time	The date and time to next run the job. The date and time should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-19T16:23:01Z).

For example, exactly once at 11:45 am:

Copy

"ExactlyOnce": {
   "Time": "2023-11-27T11:45:00Z"
}

Tip: In some instances, jobs initially scheduled as Immediate will appear on a GET as ExactlyOnce.

Password

Note: Secret data is stored in the secrets table or a PAM provider and is not returned in responses.

Properties

For the most part, the properties parameter is a stringified JSON object that contains key-value pairs defining additional properties for the certificate store, where the values are serialized JSON objects. The entire JSON structure for the properties parameter is held as a string. Inside this string, the inner JSON structure is escaped (using \" for double quotes and \\ for backslashes) to ensure that it's treated as a literal string when transmitted or processed.

Newer certificate store types use the stringified JSON object format for both input and output values. Legacy certificate store types may return output as simple key-value pairs, with the values being individual values, while input is typically in the stringified JSON object format.

Note: There are three standard properties that are used for certificate store types that require server credentials (e.g. F5):

ServerUsername
ServerPassword
ServerUseSsl

These are created automatically in the certificate store type record when the NeedsServer option is set to true. ServerUsername and ServerPassword then must be populated in certificate store records for these types.

These replace the separate certificate store server records that existed in previous versions of Keyfactor Command.

For legacy support, if credentials are not provided through store properties during creation or editing of a certificate store, Keyfactor Command will attempt to find a certificate store server record and copy the credentials from it into the store properties for future use.

Reenrollment Status

An object that indicates whether the certificate store can use the re-enrollment function with accompanying data about the re-enrollment job. Show reenrollment status details.

Name Description

Data A Boolean that indicates whether the certificate store can use the re-enrollment function (true) or not (false).

AgentId A string indicating the Keyfactor Command GUID of the orchestrator that can re-enroll the certificate store.

Message A string indicating the reason the certificate store cannot re-enroll, if applicable.

Job Properties

An array of strings containing the unique entry parameters defined for the certificate store type that need to be populated for the certificate. The key is the name of the specific entry parameter from the certificate store type definition as returned in the JobProperties on the store type using the GET CertificateStoreTypes method and the value is the value that should be set for that parameter on the certificate in the certificate store. For example, for CitrixAdc, the key name that is optionally used to associate the certificate with a virtual server is virtualServerName and is returned by GET CertificateStoreTypes like so:

"JobProperties": [ "sniCert", "virtualServerName"]

It can be seen in the Keyfactor Command Management Portal when editing the certificate store type on the Entry Parameters tab.

The setting is referenced using the following format:

Copy

"JobProperties": [
   {
      "sniCert":"MyCertificateName",
      "virtualServerName":"MyVirtualServerName"
   }
]

This field is optional.

Custom Alias Allowed

An integer indicating the option for a custom alias for this certificate store.

0—forbidden
1—optional
2—required

Entry Parameters

An array of objects indicating unique parameters that are required when performing management jobs on a certificate store of this type. Show entry parameter details.

Name	Description
StoreTypeID	An integer identifying the certificate store type. This is the same ID referenced by the StoreType parameter, above.
Name	A string containing the short name of the entry parameter.
DisplayName	A string containing the full display name of the entry parameter.
Type	A string containing the type of the entry parameter: String Bool MultipleChoice Secret
RequiredWhen	An object containing Boolean values indicating the circumstances under which a value is required to be provided for this entry parameter. These are: HasPrivateKey: If set to true, a value must be provided for this field when configuring a management job (either add or remove) if the certificate has an associated private key in Keyfactor Command. This would be the case, for example, when doing a PFX enrollment and adding the resulting certificate to a certificate store. OnAdd: If set to true, a value must be provided for this field when configuring an add certificate job. OnRemove: If set to true, a value must be provided for this field when configuring a remove certificate job. OnReenrollment: If set to true, a value must be provided for this field when configuring a reenrollment job.
DependsOn	A string containing the name of the parameter on which this parameter depends. This only applies if at least two custom parameters have been created for this certificate store type. This option is used to configure one custom parameter to display only if another custom parameter contains a value.
DefaultValue	A string containing the default value for the entry parameter. If Type is Multiple Choice, this field should contain a single value that represents the default selection from the provided list (see Options) for this entry parameter. If Type is Boolean, this field should contain true or false.
Options	A string containing a comma-separated list of multiple choice options for this entry parameter.

Tip: What's the difference between properties (custom fields) and entry parameters?

Properties are about the certificate store definition itself and are static. For example, you might use a property to define the primary node name of an F5 instance. This node name is the same no matter what inventory or management jobs you do with the F5 device(s). Values for properties are entered in the certificate store record when creating or editing the certificate store record.
Entry parameters are about the specific certificate within the certificate store. They are used to send additional information related to the certificate to the server or device that hosts the certificate store when running management jobs for that certificate store. Often this is more fluid information that isn't the same for every use of that certificate store. For example, several virtual servers with separate certificates in the same folder may exist on a NetScaler device. When replacing one certificate, updates may need to be made to only the virtual server that is using the certificate. In this case, the authorized user will be prompted to enter the virtual server name based on an entry parameter. Values for entry parameters are entered at the time a management job is initiated (e.g. adding a certificate to a certificate store).

Set New Password Allowed

A Boolean that indicates whether the store requires a password AND whether the user has modify permissions on the store within Keyfactor Command (true) or not (false).

Storepath A string indicating the path to the certificate store on the target. The format for this path will vary depending on the certificate store type. For example, for a Java keystore, this will be a file path (e.g. /opt/myapp/store.jks), but for an F5 device, this will be a partition name on the device (e.g. Common). See Adding or Modifying a Certificate Store for more information. The maximum number of characters supported in this field is 722.

Tip: See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor API

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

Version v25.2

On this page: