Update a Computer Prestage

put

https://{region}.api.jamfcloud.com/pro/v3/computer-prestages/{id}

Updates a Computer Prestage

Required Permissions: prestage-enrollments:update

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Computer Prestage identifier

Body Params

Computer Prestage to update

displayName

string

required

mandatory

boolean

required

mdmRemovable

boolean

required

supportPhoneNumber

string

required

supportEmailAddress

string

required

department

string

required

defaultPrestage

boolean

required

enrollmentSiteId

string

required

keepExistingSiteMembership

boolean

required

keepExistingLocationInformation

boolean

required

requireAuthentication

boolean

required

authenticationPrompt

string

required

preventActivationLock

boolean

required

enableDeviceBasedActivationLock

boolean

required

deviceEnrollmentProgramInstanceId

string

required

skipSetupItems

object

locationInformation

object

required

purchasingInformation

object

required

anchorCertificates

array of strings

The Base64 encoded PEM Certificate

anchorCertificates

enrollmentCustomizationId

string

language

string

region

string

autoAdvanceSetup

boolean

required

installProfilesDuringSetup

boolean

required

prestageInstalledProfileIds

array of strings

required

prestageInstalledProfileIds*

customPackageIds

array of strings

required

customPackageIds*

customPackageDistributionPointId

string

required

enableRecoveryLock

boolean

recoveryLockPasswordType

string

enum

Allowed:

rotateRecoveryLockPassword

boolean

prestageMinimumOsTargetVersionType

string

enum

Allowed:

minimumOsSpecificVersion

string

length ≥ 0

pssoEnabled

boolean

Defaults to false

Indicates whether Platform SSO (PSSO) is enabled for this computer prestage, regardless of unattended or 403 workflows. When enabled, the PSSO application will be deployed to devices during the setup process to facilitate single sign-on (SSO) for users.

platformSsoAppBundleId

string

The bundle identifier for the Platform SSO (PSSO) application unattended workflow. This identifier is used to specify which PSSO app should be deployed to devices during the setup process.

profileUrl

string | null

The URL to the configuration profile for the Platform SSO (PSSO) application 403 workflow. This URL is used when deploying the PSSO app to devices during the setup process. Users should use either profileUrl or populate pssoConfigProfileId, but not both.

pssoConfigProfileId

string | null

The identifier for the configuration profile associated with the Platform SSO (PSSO) application 403 workflow. This ID is used to specify which configuration profile should be applied to devices during the setup process when PSSO is enabled. Users should use either pssoConfigProfileId or populate profileUrl, but not both.

manifestUrl

string | null

The URL to the manifest file for the Platform SSO (PSSO) application 403 workflow. This URL is used when deploying the PSSO app to devices during the setup process.

accountSettings

object

recoveryLockPassword

password

length ≥ 1

versionLock

integer

≥ 0

Headers

X-Tenant-Id

uuid

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.

X-Environment-Id

uuid

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

200Success

400Bad Request

404Computer Prestage with that id does not exist

409The Computer Prestage was modified by another process. Read the Computer Prestage again for updated changes.