mirror of
https://github.com/apple/device-management.git
synced 2026-02-13 02:02:47 +00:00
40 lines
1.2 KiB
YAML
40 lines
1.2 KiB
YAML
title: Apply Redemption Code Command
|
|
description: Complete the installation of an app using a redemption code.
|
|
payload:
|
|
requesttype: ApplyRedemptionCode
|
|
supportedOS:
|
|
iOS:
|
|
introduced: '5.0'
|
|
accessrights: AllowAppInstallation
|
|
supervised: false
|
|
requiresdep: false
|
|
sharedipad:
|
|
mode: forbidden
|
|
userenrollment:
|
|
mode: forbidden
|
|
macOS:
|
|
introduced: n/a
|
|
tvOS:
|
|
introduced: n/a
|
|
visionOS:
|
|
introduced: n/a
|
|
watchOS:
|
|
introduced: n/a
|
|
payloadkeys:
|
|
- key: Identifier
|
|
type: <string>
|
|
presence: required
|
|
content: The bundle identifier of the app.
|
|
- key: RedemptionCode
|
|
type: <string>
|
|
presence: required
|
|
content: The redemption code that applies to the app pending installation.
|
|
notes:
|
|
- title: ''
|
|
content: |-
|
|
This command provides a redemption code to complete installing an app. Use this when `InstallApplication` returns `NeedsRedemption`, or when `ManagedApplicationList` returns `NeedsRedemption` for the status of the app.
|
|
|
|
Sending a redemption code to an app that doesn't need it produces an error.
|
|
|
|
Refer to the following sections to determine supported channels and requirements, and to see an example request and response.
|