| Id |
An integer indicating the ID of the container. |
| Name |
A string indicating the name of the container. |
| Schedule |
A string containing the inventory schedule set for the container.  Show schedule details.
| Off |
Turn off a previously configured schedule. |
| 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.| Minutes | An integer indicating the number of minutes between each interval. |
For example, every hour: "Interval": {
"Minutes": 60
} |
| Daily |
A dictionary that indicates a job scheduled to run every day at the same time with the parameter:
| 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. 2021-05-19T16:23:01Z). |
For example, daily at 11:30 pm: "Daily": {
"Time": "2022-02-25T23:30:00Z"
}
|
Note: Although the Swagger Example Value may show examples of various other schedules, only the schedules shown here—that are available in the Management Portal for this functionality—are valid for this endpoint.
|
| CertStoreType |
An integer indicating the ID of the certificate store type, as defined in Keyfactor Command, for this certificate store. (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) |
| CertificateStores |
An array of certificate store data for the certificate stores within this container. Show certificate store details.
| Id |
A string indicating the GUID of the certificate store within Keyfactor Command. |
| DisplayName |
A string indicating the display name of the certificate store.
|
| ContainerId |
An integer indicating the ID of the certificate store's associated certificate store container. |
| ClientMachine |
The string value of the client machine. The value for this will vary depending on the certificate store type. For example, for a Java keystore or an F5 device, it is the hostname of the machine on which the store is located, but for an Amazon Web Services store, it is the FQDN of the Keyfactor Command Windows Orchestrator. See Adding or Modifying a Certificate Store in the Keyfactor Command Reference Guide for more information. |
| 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 in the Keyfactor Command Reference Guide for more information. |
| CertStoreInventoryJobId |
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. |
| CertStoreType |
An integer indicating the ID of the certificate store type, as defined in Keyfactor Command, for this certificate store. (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) |
| 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. |
| CreateIfMissing |
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. |
| Properties |
Some types of certificate stores have additional properties that are stored in this parameter. The data is stored in a series of, typically, key value pairs that define the property name and value (see GET Certificate Store Types for more information).
When reading this field, the values are returned as simple key value pairs, with the values being individual values. When writing, the values are specified as objects, though they are typically single values.
For example, on a GET request for a PEM store configured with a separate private key, the contents of this field might be: "{
\"privateKeyPath\":\"/opt/app/mystore.key\",
\"separatePrivateKey\":\"true\"
}"
However, the syntax used when updating the properties sets the value as a key value pair using value as the key. For example, on a POST or PUT request for a PEM store configured with a separate private key, the contents of this field might be: "{
\"privateKeyPath\":{\"value\":\"/opt/app/mystore.key\"},
\"separatePrivateKey\":{\"value\":\"true\"}
}"
Tip: Built-in stores that make use of this field include: - AWS stores use this field to store secured versions of the access key and secret.
- F5 REST stores (all types) use this field to store the primary node information (PrimaryNode, PrimaryNodeCheckRetryWaitSecs, PrimaryNodeCheckRetryMax) and F5 version (F5Version).
- IIS stores (all types) use this field to store the port for SMB communications.
- PEM stores use this field to store the path to the private key file, if defined, and the Boolean value indicating whether a separate private key path is defined.
|
| AgentId |
A string indicating the Keyfactor Command GUID of the orchestrator for this store. |
| AgentAssigned |
A Boolean that indicates whether there is an orchestrator assigned to this certificate store (true) or not (false). |
| ContainerName |
A string indicating the name of the certificate store's associated container. |
| InventorySchedule |
The inventory schedule for this certificate store. |
| ReenrollmentStatus |
An array that indicates whether the certificate store can use the re-enrollment function with accompanying data about the re-enrollment job. |
| SetNewPasswordAllowed |
A Boolean that indicates whether the store password can be changed (true) or not (false). |
| Password |
An array indicating the source for and details of the credential information Keyfactor Command will use to access the certificates in a specific certificate store (the store password).
Note: Secret data is stored in the secrets table or a PAM provider and is not returned in responses. |
|
) at the top of the Keyfactor Command Management Portal page next to the Log Out button.