GET Agents ID

The GET /Agents/{id} method is used to retrieve a single orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. or agent registered in Keyfactor Command. This method returns HTTP 200 OK on a success with a list of all orchestrator details.

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

/agents/management/read/

Table 103: GET Agents{id} Input Parameters

Name In Description
id Path Required. The GUID of the orchestrator to retrieve.

Use the GET /Agents method (see GET Agents) to retrieve a list of all the orchestrators to determine the orchestrator GUID.

Table 104: GET Agent {id} Response Data

Name Description
AgentId A string indicating the GUID of the orchestrator.
ClientMachine A string indicating the client machine on which the orchestrator is installed.
Username A string indicating the Active Directory user or service account the orchestrator is using to connect to Keyfactor Command.
AgentPlatform

An integer indicating the platform for the orchestrator. ClosedShow agent platform values.
Version A string indicating the version of the orchestrator.
Status An integer indicating the orchestrator status. ClosedShow status values.
LastSeen The time, in UTC, at which the orchestrator last contacted Keyfactor Command.
Capabilities An array of strings indicating the capabilities reported by the orchestrator. These may be built-in or custom capabilities. ClosedShow built-in capability values for common orchestrators.
Blueprint

A string indicating the name of the blueprint associated with the orchestrator.
Thumbprint A string indicating the thumbprint of the certificate that Keyfactor Command is expecting the orchestrator to use for client certificate authentication.
LegacyThumbprint A string indicating the thumbprint of the certificate previously used by the orchestrator for client certificate authentication before a certificate renewal operation took place (rotating the current thumbprint into the legacy thumbprint). The legacy thumbprint is cleared once the orchestrator successfully registers with the new thumbprint.
AuthCertificateReenrollment

An integer indicating the value of the orchestrator certificate reenrollment request or require status. ClosedShow values.
LastThumbprintUsed A string indicating the thumbprint of the certificate that the orchestrator most recently used for client certificate authentication. In most cases, this will match the Thumbprint.
LastErrorCode An integer indicating the last error code, if any, reported from the orchestrator when trying to register a session. This code is cleared on successful session registration.
LastErrorMessage A string indicating the last error message, if any, reported from the orchestrator when trying to register a session. This message is cleared on successful session registration.
JobTypes

An array of strings indicating the job types correlated with the orchestrator with the following attributes:

Attribute Description
Name

The name of the job type which includes a combination of capability and the job type.
CertStoreTypeShortName

The user-defined short name given to the certificate store associated with the job type.

CertStoreJobType

The job type:

  • Inventory: Determine what is in the certificate store(s) and report the contents to Keyfactor Command. This capability is required for all store types.
  • Add: Add new certificates to a certificate store.
  • Remove: Remove certificates from a certificate store.
  • Create: Create a new certificate store.
  • Discovery: Determine what certificate stores of this type are on the device.
  • Reenrollment: Generate a keypair on the device and submit a certificate signing request using on-device key generation (ODKG)
JobTypeId The ID of the job type to be referenced in the Keyfactor Command SQL Database.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed 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 the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. 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.