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)

Permissions for certificates can be set at either the global or certificate collection level. See Certificate Collection Permissions for more information about global vs collection permissions. See also the CollectionId input parameter, below.

Table 277: 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 integer specifying an optional certificate collection identifier to validate that the user executing the request has sufficient permissions to do so. If a certificate collection ID is not supplied, the user must have global permissions to complete the action. Supplying a certificate collection ID allows for a check of the user's certificate collection-level permissions to determine whether the user has sufficient permissions at a collection level to complete the action. See Certificate Collection Permissions for more information.

Table 278: 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

endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow

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.

Version v24.4

On this page: