GET Certificate Authority CA Connectors

The GET /CertificateAuthority/CAConnectors method is used to retrieve the list of CAClosed A certificate authority (CA) is an entity that issues digital certificates. Within Keyfactor Command, a CA may be a Microsoft CA or a Keyfactor gateway to a cloud-based or remote CA. connectors configured in Keyfactor Command. This method returns HTTP 200 OK on a success with the details for each of the CA connectors. This method has no input parameters other than the standard headers (see Endpoint Common Features).

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

/certificate_authorities/read/

Table 332: GET Certificate Authority CA Connectors Response Body

Name

Description
ID An integer indicating the Keyfactor Command reference ID of the CA connector.

Name

A string indicating a name for the connector. This name must match the name that the CA Connector Client will use to connect to Keyfactor Command. If you use the -Name (Windows) or --name (Linux) parameter when installing the CA Connector Client, you can specify this value. If you do not specify this value, the CA Connector Client uses the results from a hostname lookup for the server's name.
Enabled A Boolean indicating whether the CA connector record is enabled (true) or not (false). The default is false.
PoolName A string indicating the name of the CA connector pool with which this connector is associated. Pools are used to group multiple CA Connector Clients together to perform tasks on the same CA or set of CAs. A pool may only contain CA Connector Clients of one type—DCOM or HTTPS.
LastSeen A string indicating the date and time that the CA Connector Client last connected to Keyfactor Command. This is based on the heartbeat to the CA Connector Client every 2 minutes.
ClaimType

A string indicating the type of claim that the CA Connector Client will use to authenticate to Keyfactor Command. Supported types are:

  • OAuthClientId

  • OAuthOid

  • OAuthRole

  • OAuthSubject
ClaimValue

A string indicating the claim value that the CA Connector Client will use to authenticate to Keyfactor Command based on the ClaimType.

Note:  The CA Connector Client's authorization is validated with each connection it makes to Keyfactor Command.
ProviderId

A string indicating the Keyfactor Command reference GUID of the identity provider that will provide the claim.

Use the GET /IdentityProviders method (see GET Identity Providers) to retrieve the list of all the identity providers to determine the identity provider GUID.
ProviderName A string indicating the name of the identity provider that will provide the claim.
Connected A Boolean indicating whether the CA Connector Client is actively connected to Keyfactor Command (true) or not (false). This is based on the heartbeat to the CA Connector Client every 2 minutes. If the heartbeat fails or the CA Connector Client is shut down, the Connected value will be updated to false and the heartbeat will no longer run, until a new connection is received from the CA Connector Client.
CAType A string indicating the type of CA connector. Supported values are DCOM or HTTPS. DCOM is used for Microsoft CAs. HTTPS is used for EJBCA CAs. The default is DCOM.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed 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 workflowClosed 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.