POST Agents Set Auth Certificate Reenrollment

The POST /Agents/SetAuthCertificateReenrollment method is used to request or require that one or more orchestrators (a.k.a. agents) enroll for a new client authentication certificate on the orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores.'s next session registration. This method returns HTTP 200 OK on a success with information about any failed requests.

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

/agents/management/read/
/agents/management/modify/

Table 111: POST Agents Set Auth Certificate Reenrollment Input Parameters

Name In Description
OrchestratorIds Body Required. An array of strings indicating the GUIDs of the orchestrators on which you want to change the AuthCertificateReenrollment value to request or require the orchestrator(s) to enroll for a new client authentication certificate on the next session registration.

Use the GET Agents method (see GET Agents) to retrieve a list of all the orchestrators to determine the orchestrator GUIDs and current status of the orchestrators.
Status Body

An integer indicating the value that AuthCertificateReenrollment should be set to. ClosedShow status options.

Table 112: POST Agents Set Auth Certificate Reenrollment Response Data

Name Description
FailedOrchestratorIds An array of strings indicating the GUIDs of orchestrators that failed to update.
Status

A string indicating the value for AuthCertificateReenrollment that was requested. ClosedShow status options.
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.