GuidesAPI ReferenceGitHub
API Reference
Community ForumsTwitter

Enrolls a machine to the CIP using an enrollment code.

post
https://example.com/ServerAgent/RegisterV2

See EnrollV2 for enrolling using user credentials.
Use the same arguments as EnrollV2 with the following modifications:
Added: EnrollmentCode
Disallowed: Owner
Owner must be omitted or the empty string since the agent profile will be the owner
of the enrollment code.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Version of the agent performing the enrollment

string
required

Name of a user or CIP role to set as the owner of the agent profile. The owner impacts what users can manage or take over the profile

string
required

Either the FQDN or IP address of the machine being enrolled

Sets
array of objects
Defaults to []

List of system sets to add the created system to:

Sets
string

Device ID of the enrolling machine. Should only be provided by Mac agents

string
Defaults to [value of Name]

Name the PAS system corresponding to the enrolled machine should have. If the Suffix argument is supplied, the final name of the system will be in the form '[name]@[suffix]'. Otherwise, the final name will be in the form '[name]'

boolean
Defaults to false

Whether an agent profile take over attempt is made if the enrollment would result in such a scenario

string
required

Enrollment code to enroll with.

string
required

JSON encoded settings the corresponding system should have. At minimum, the 'ComputerClass' and 'SessionType' values should be provided

string
Defaults to null

JSON encoded policies the corresponding system should have

string

Specific suffix to use for the login and resource names. See the documentation of Name and ResourceName for details

string
Defaults to [default password]

Password to protect the PKCS #12 'Cert' return value. If omitted or empty, a default password is used

string
required

Operating system of the enrolling machine. Should start with 'darwin' for macOS, and 'windows' for Windows. Can start with anything for Linux. See

string
required

Name prefix of the agent / corresponding service user. If the Suffix argument is supplied, said suffix will be used to form the final name. Otherwise, a default suffix will be used

Response

Updated 11 months ago

Language
LoadingLoading…
Response
Choose an example:
*/*

Updated 11 months ago