GET Certificates Locations ID

The GET /Certificates/Locations/{id} method is used to return details for the certificate store locations in which the certificate with the specified ID is found. This method returns HTTP 200 OK on a success with certificate store location details in the message body.

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

/certificates/collections/read/

/certificates/collections/read/#/ (where # is a reference to a specific certificate collection ID—see CollectionID, below)

/certificate_stores/read/

/certificate_stores/read/#/ (where # is a reference to a specific certificate store container ID—see ContainerID, below)

Permissions for certificates can be configured at multiple levels. You can apply them system-wide—for all certificates or all certificate stores—or use fine-grained control by assigning permissions at the certificate collection The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports). or certificate store container level. The appropriate level depends on how the certificates are accessed. See Certificate Collection Permissions and Container Permissions for more information about system-wide versus more targeted permission models.

Table 310: GET Certificates Locations {id} Input Parameters

Name	In	Description
id	Path	Required. The Keyfactor Command reference ID of the certificate for which to retrieve certificate store location details.
CollectionId	Query	An optional integer that specifies the certificate collection (CollectionId) to validate whether the user has sufficient permissions to perform the action. If a CollectionId is not provided, the user must have appropriate permissions granted system-wide or via certificate store containers. Providing a CollectionId allows the system to check the user's permissions at the certificate collection level. Permissions are evaluated in the following order: System-wide certificate permissions Granular certificate permissions Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0). See Certificate Collection Permissions for more information.
ContainerId	Query	An optional integer that specifies the certificate store container (ContainerId) to validate whether the user has sufficient permissions to perform the action. If a ContainerId is not provided, the user must have appropriate permissions granted system-wide or via certificate collections. Providing a ContainerId allows the system to check the user's permissions at the container level. Permissions are evaluated in the following order: System-wide certificate store container permissions Granular certificate store container permissions Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0). See Container Permissions for more information.

Name

Description

Path

Required. The Keyfactor Command reference ID of the certificate for which to retrieve certificate store location details.

CollectionId

Query

An optional integer that specifies the certificate collection (CollectionId) to validate whether the user has sufficient permissions to perform the action. If a CollectionId is not provided, the user must have appropriate permissions granted system-wide or via certificate store containers.

Providing a CollectionId allows the system to check the user's permissions at the certificate collection level. Permissions are evaluated in the following order:

System-wide certificate permissions
Granular certificate permissions

Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0).

See Certificate Collection Permissions for more information.

ContainerId

Query

An optional integer that specifies the certificate store container (ContainerId) to validate whether the user has sufficient permissions to perform the action. If a ContainerId is not provided, the user must have appropriate permissions granted system-wide or via certificate collections.

Providing a ContainerId allows the system to check the user's permissions at the container level. Permissions are evaluated in the following order:

System-wide certificate store container permissions
Granular certificate store container permissions

Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0).

See Container Permissions for more information.

Table 311: GET Certificates Locations {id} Response Data

Name

Description

Details

An array of objects containing the certificate stores in which the certificate is found. Show certificate store details.

Name

Description

StoreType

A string indicating the type of certificate store (e.g., Java Keystore).

StoreTypeId

An integer indicating the Keyfactor Command referenced ID for the type of certificate store.

Use the GET CertificateStoreTypes method (see GET Certificate Store Types) to retrieve a list of all the certificate store types to see a complete list of types.

StoreCount

An integer indicating the number of stores of the type referenced by StoreType in which the certificate is found.

Locations

An array of objects containing details about the specific certificate stores in which the certificate is found. Show location details.

Name	Description
StoreId	A GUID that identifies the certificate store in which the certificate is located.
StoreTypeId	An integer indicating the Keyfactor Command reference ID for the type of certificate store.
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.
StorePath	A string containing 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.
Alias	A string containing the alias of the certificate in the certificate store. The format for this path will vary depending on the certificate store type. For example, for a Java keystore, this will be a user-provided string, but for an IIS Personal store, this will be the thumbprint of the certificate. See PFX Enrollment for more information.

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.3

On this page: