Skip to content

Latest commit

 

History

History
260 lines (178 loc) · 11.4 KB

AppleMDMApi.md

File metadata and controls

260 lines (178 loc) · 11.4 KB

\AppleMDMApi

All URIs are relative to https://console.jumpcloud.com/api/v2

Method HTTP request Description
ApplemdmsDelete Delete /applemdms/{apple_mdm_id} Delete an Apple MDM
ApplemdmsList Get /applemdms List Apple MDMs
ApplemdmsPost Post /applemdms Create Apple MDM
ApplemdmsPut Put /applemdms/{apple_mdm_id} Update an Apple MDM
EnrollmentprofilesGet Get /applemdms/{apple_mdm_id}/enrollmentprofiles/{enrollment_profile_id} Get an Apple MDM Enrollment Profile
EnrollmentprofilesList Get /applemdms/{apple_mdm_id}/enrollmentprofiles List Apple MDM Enrollment Profiles

ApplemdmsDelete

AppleMdm ApplemdmsDelete(ctx, appleMdmId, contentType, accept, optional) Delete an Apple MDM

Removes an Apple MDM configuration. Warning: This is a destructive operation and will remove your Apple Push Certificates. We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM. #### Sample Request curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
appleMdmId string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
appleMdmId string
contentType string [default to application/json]
accept string [default to application/json]
xOrgId string [default to ]

Return type

AppleMdm

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApplemdmsList

[]AppleMdm ApplemdmsList(ctx, contentType, accept, optional) List Apple MDMs

Get a list of all Apple MDM configurations. An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet. Note: currently only one MDM configuration per organization is supported. #### Sample Request curl https://console.jumpcloud.com/api/v2/applemdms \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
contentType string [default to application/json]
accept string [default to application/json]
xOrgId string [default to ]

Return type

[]AppleMdm

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApplemdmsPost

InlineResponse201 ApplemdmsPost(ctx, contentType, accept, optional) Create Apple MDM

Creates an Apple MDM Enrollment for an organization. Only one enrollment per organization will be allowed. Note that this is the first step in completly setting up an MDM Enrollment. The user must supply the returned plist to Apple for signing, and then provide the certificate provided by Apple back into the PUT API. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/organizations/{Organization_ID}/mdm \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
contentType string [default to application/json]
accept string [default to application/json]
body Body
xOrgId string [default to ]

Return type

InlineResponse201

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApplemdmsPut

AppleMdm ApplemdmsPut(ctx, appleMdmId, contentType, accept, optional) 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. #### 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}\" }'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
appleMdmId string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
appleMdmId string
contentType string [default to application/json]
accept string [default to application/json]
body AppleMdmPatchInput
xOrgId string [default to ]

Return type

AppleMdm

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnrollmentprofilesGet

Mobileconfig EnrollmentprofilesGet(ctx, appleMdmId, enrollmentProfileId, contentType, accept, optional) Get an Apple MDM Enrollment Profile

Get an enrollment profile Currently only requesting the mobileconfig is supported. #### Sample Request curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles/{ENROLLMENT_PROFILE_ID} \\ -H 'accept: application/x-apple-aspen-config' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
appleMdmId string
enrollmentProfileId string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
appleMdmId string
enrollmentProfileId string
contentType string [default to application/json]
accept string [default to application/json]
xOrgId string [default to ]

Return type

Mobileconfig

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/x-apple-aspen-config

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnrollmentprofilesList

[]AppleMdm EnrollmentprofilesList(ctx, appleMdmId, contentType, accept, optional) List Apple MDM Enrollment Profiles

Get a list of enrollment profiles for an apple mdm. Note: currently only one enrollment profile is supported. #### Sample Request curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
appleMdmId string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
appleMdmId string
contentType string [default to application/json]
accept string [default to application/json]
xOrgId string [default to ]

Return type

[]AppleMdm

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]