custom/generated/Set-JcSdkAppleMdm.ps1
|
<# .Synopsis 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.\n\n#### Sample Request\n```\n curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"MDM name\",\n \"appleSignedCert\": \"{CERTIFICATE}\",\n \"encryptedDepServerToken\": \"{SERVER_TOKEN}\",\n \"dep\": {\n \"welcomeScreen\": {\n \"title\": \"Welcome\",\n \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\",\n \"button\": \"continue\",\n },\n },\n }'\n``` .Description 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.\n\n#### Sample Request\n```\n curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"MDM name\",\n \"appleSignedCert\": \"{CERTIFICATE}\",\n \"encryptedDepServerToken\": \"{SERVER_TOKEN}\",\n \"dep\": {\n \"welcomeScreen\": {\n \"title\": \"Welcome\",\n \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\",\n \"button\": \"continue\",\n },\n },\n }'\n``` .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs JumpCloud.SDK.V2.Models.IAppleMdmPatchInput .Inputs JumpCloud.SDK.V2.Models.IJumpCloudApIsIdentity .Outputs JumpCloud.SDK.V2.Models.IAppleMdm .Outputs System.String .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. BODY <IAppleMdmPatchInput>: [AppleSignedCert <String>]: A signed certificate obtained from Apple after providing Apple with the plist file provided on POST. [DefaultSystemGroupId <String>]: ObjectId uniquely identifying the MDM default System Group. [DepSetupAssistantOptions <IDepSetupAssistantOption[]>]: [Option <SetupAssistantOption?>]: Options to skip screens during MacOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `tos` - Skips terms and conditions. [EncryptedDepServerToken <String>]: The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance. [Name <String>]: A new name for the Apple MDM configuration. [WelcomeScreenButton <String>]: Text to display on the button on the DEP Welcome Screen. [WelcomeScreenParagraph <String>]: A message to display on the DEP Welcome Screen. [WelcomeScreenTitle <String>]: The title to display on the DEP Welcome Screen. DEPSETUPASSISTANTOPTIONS <IDepSetupAssistantOption[]>: [Option <SetupAssistantOption?>]: Options to skip screens during MacOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `tos` - Skips terms and conditions. INPUTOBJECT <IJumpCloudApIsIdentity>: [AccountId <String>]: [ActivedirectoryId <String>]: [AppleMdmId <String>]: [ApplicationId <String>]: ObjectID of the Application. [CommandId <String>]: ObjectID of the Command. [DeviceId <String>]: [GroupId <String>]: ObjectID of the System Group. [GsuiteId <String>]: ObjectID of the G Suite instance. [Id <String>]: ObjectID of the System Group. [JobId <String>]: [LdapserverId <String>]: ObjectID of the LDAP Server. [Office365Id <String>]: ObjectID of the Office 365 instance. [PolicyId <String>]: ObjectID of the Policy. [ProviderId <String>]: [RadiusserverId <String>]: ObjectID of the Radius Server. [SoftwareAppId <String>]: ObjectID of the Software App. [SystemId <String>]: ObjectID of the System. [UserId <String>]: ObjectID of the User. [WorkdayId <String>]: .Link https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md #> Function Set-JcSdkAppleMdm { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdm], [System.String])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] Param( [Parameter(ParameterSetName='Update', Mandatory)] [Parameter(ParameterSetName='UpdateExpanded', Mandatory)] [JumpCloud.SDK.V2.Category('Path')] [System.String] # . ${Id}, [Parameter(ParameterSetName='UpdateViaIdentity', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='UpdateViaIdentityExpanded', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Path')] [JumpCloud.SDK.V2.Models.IJumpCloudApIsIdentity] # Identity Parameter # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter(ParameterSetName='Update', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='UpdateViaIdentity', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IAppleMdmPatchInput] # Apple MDM Patch Input # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='UpdateExpanded')] [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # A signed certificate obtained from Apple after providing Apple with the plist file provided on POST. ${AppleSignedCert}, [Parameter(ParameterSetName='UpdateExpanded')] [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # ObjectId uniquely identifying the MDM default System Group. ${DefaultSystemGroupId}, [Parameter(ParameterSetName='UpdateExpanded')] [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IDepSetupAssistantOption[]] # . # To construct, see NOTES section for DEPSETUPASSISTANTOPTIONS properties and create a hash table. ${DepSetupAssistantOptions}, [Parameter(ParameterSetName='UpdateExpanded')] [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance. ${EncryptedDepServerToken}, [Parameter(ParameterSetName='UpdateExpanded')] [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # A new name for the Apple MDM configuration. ${Name}, [Parameter(ParameterSetName='UpdateExpanded')] [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # Text to display on the button on the DEP Welcome Screen. ${WelcomeScreenButton}, [Parameter(ParameterSetName='UpdateExpanded')] [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # A message to display on the DEP Welcome Screen. ${WelcomeScreenParagraph}, [Parameter(ParameterSetName='UpdateExpanded')] [Parameter(ParameterSetName='UpdateViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # The title to display on the DEP Welcome Screen. ${WelcomeScreenTitle}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [JumpCloud.SDK.V2.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [JumpCloud.SDK.V2.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) Begin { $Results = @() $PSBoundParameters.Add('HttpPipelineAppend', { param($req, $callback, $next) # call the next step in the Pipeline $ResponseTask = $next.SendAsync($req, $callback) $global:JCHttpRequest = $req # $global:JCHttpRequestContent = If (-not [System.String]::IsNullOrEmpty($req.Content)) { $req.Content.ReadAsStringAsync() } $global:JCHttpResponse = $ResponseTask # $global:JCHttpResponseContent = If (-not [System.String]::IsNullOrEmpty($ResponseTask.Result.Content)) { $ResponseTask.Result.Content.ReadAsStringAsync() } Return $ResponseTask } ) } Process { $Results = JumpCloud.SDK.V2.internal\Set-JcSdkInternalAppleMdm @PSBoundParameters } End { Write-Debug ('HttpRequest: ' + $JCHttpRequest); # Write-Debug ('HttpRequestContent: ' + $JCHttpRequestContent.Result); Write-Debug ('HttpResponse: ' + $JCHttpResponse.Result); # Write-Debug ('HttpResponseContent: ' + $JCHttpResponseContent.Result); # Clean up global variables $GlobalVars = @('JCHttpRequest', 'JCHttpRequestContent', 'JCHttpResponse', 'JCHttpResponseContent') $GlobalVars | ForEach-Object { If ((Get-Variable -Scope:('Global')).Where( { $_.Name -eq $_ })) { Remove-Variable -Name:($_) -Scope:('Global') } } Return $Results } } |