PUT MacEnrollment

The PUT /MacEnrollment method is used to update the existing Mac Auto-EnrollmentClosed Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA). configuration. This method returns HTTP 200 OK on a success with the Mac Auto-Enrollment configuration details.

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

/agents/management/mac/auto-enrollment/management/modify/

Important:  Any previously populated fields that are not submitted with their full existing data using this method will be cleared of their existing data. When using this method, you should first do a GET to retrieve all the values for the record you want to update, enter corrected data into the field(s) you want to update, and then submit all the fields using PUT, including the fields that contain values but which you are not changing.

Table 458: PUT MacEnrollment input Parameters

Name In Description
Id Body

An integer indicating the Keyfactor Command referenced ID of the Mac auto-enrollment configuration.
Enabled Body

An Boolean indicating whether Mac auto-enrollment is configured in the environment (true) or not (false).
Interval Body An integer indicating the frequency with which the Mac auto-enrollment agent should check to see if there are new certificates for which to enroll.
UseMetadata Body

A Boolean indicating whether to automatically associate data in a custom metadata field with an auto-enrolled Mac certificate (true) or not (false).

See for more information about metadata fields.
MetadataField Body

A string indicating the name of the metadata field to populate for the certificate, if UseMetadata is true.
MetadataValue Body A string indicating the value to populate for the metadata field, if UseMetadata is true. This may be either a static value (e.g. a fixed string that indicates this certificate was acquired as a result of an auto-enrollment on a Mac), or a variable retrieved from the Mac. In the current version of the agent, only the Mac serial number is available.

Table 459: PUT MacEnrollment Response Data

Name Description
Id

An integer indicating the Keyfactor Command referenced ID of the Mac auto-enrollment configuration.
Enabled

An Boolean indicating whether Mac auto-enrollment is configured in the environment (true) or not (false).
Interval An integer indicating the frequency with which the Mac auto-enrollment agent should check to see if there are new certificates for which to enroll.
UseMetadata

A Boolean indicating whether to automatically associate data in a custom metadata field with an auto-enrolled Mac certificate (true) or not (false).

See Certificate Metadata for more information about metadata fields.
MetadataField

A string indicating the name of the metadata field to populate for the certificate, if UseMetadata is true.
MetadataValue A string indicating the value to populate for the metadata field, if UseMetadata is true. This may be either a static value (e.g. a fixed string that indicates this certificate was acquired as a result of an auto-enrollment on a Mac), or a variable retrieved from the Mac. In the current version of the agent, only the Mac serial number is available.
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.