JUjumpcloud
Apple MDM

Update an Apple MDM

Updates an Apple MDM configuration. This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. It may also be used to update the DEP Settings.

Sample Request

  curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "name": "MDM name",
    "appleSignedCert": "{CERTIFICATE}",
    "encryptedDepServerToken": "{SERVER_TOKEN}",
    "dep": {
      "welcomeScreen": {
        "title": "Welcome",
        "paragraph": "In just a few steps, you will be working securely from your Mac.",
        "button": "continue",
      },
    },
  }'
put/applemdms/{id}

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

appleSignedCertstring

A signed certificate obtained from Apple after providing Apple with the plist file provided on POST.

encryptedDepServerTokenstring

The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance.

namestring

A new name for the Apple MDM configuration.

defaultSystemGroupIDstring

ObjectId uniquely identifying the MDM default System Group.

defaultIosUserEnrollmentDeviceGroupIDstring

ObjectId uniquely identifying the MDM default iOS user enrollment device group.

allowMobileUserEnrollmentboolean

A toggle to allow mobile device enrollment for an organization.

appleCertCreatorAppleIDstring

The Apple ID of the admin who created the Apple signed certificate.

Response

apnsPushTopicstring

The push topic assigned to this enrollment by Apple after uploading the Signed CSR plist.

depServerTokenState'unknown' | 'missing' | 'valid' | 'expired'

The state of the dep server token, presence and expiry.

idstring required

ObjectId uniquely identifying an MDM Enrollment,

namestring

A friendly name to identify this enrollment. Not required to be unique.

organizationstring

The identifier for an organization

apnsCertExpirystring nullable

The expiration date and time for the APNS Certificate.

depAccessTokenExpirystring nullable

The expiration date and time for the DEP Access Token. This aligns with the DEP Server Token State.

defaultSystemGroupIDstring nullable

ObjectId uniquely identifying the MDM default System Group.

defaultIosUserEnrollmentDeviceGroupIDstring nullable

ObjectId uniquely identifying the MDM default iOS user enrollment device group.

allowMobileUserEnrollmentboolean nullable

A toggle to allow mobile device enrollment for an organization.

appleCertCreatorAppleIDstring

The Apple ID of the admin who created the Apple signed certificate associated to the Device Manager.

appleCertSerialNumberstring

The serial number of the Apple signed certificate associated to the Device Manager.

serviceDiscoveryEnabledboolean nullable

A flag to know whether service discovery is enabled or not for the Device Manager.

Changes

No recorded changes to this operation across all 1 revision of this API.