Create iosManagedAppProtection

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Create a new iosManagedAppProtection object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All

HTTP Request

POST /deviceAppManagement/iosManagedAppProtections

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json

Request body

In the request body, supply a JSON representation for the iosManagedAppProtection object.

The following table shows the properties that are required when you create the iosManagedAppProtection.

Property	Type	Description
displayName	String	Policy display name. Inherited from managedAppPolicy
description	String	The policy's description. Inherited from managedAppPolicy
createdDateTime	DateTimeOffset	The date and time the policy was created. Inherited from managedAppPolicy
lastModifiedDateTime	DateTimeOffset	Last time the policy was modified. Inherited from managedAppPolicy
roleScopeTagIds	String collection	List of Scope Tags for this Entity instance. Inherited from managedAppPolicy
id	String	Key of the entity. Inherited from managedAppPolicy
version	String	Version of the entity. Inherited from managedAppPolicy
periodOfflineBeforeAccessCheck	Duration	The period after which access is checked when the device is not connected to the internet. Inherited from managedAppProtection
periodOnlineBeforeAccessCheck	Duration	The period after which access is checked when the device is connected to the internet. Inherited from managedAppProtection
allowedInboundDataTransferSources	managedAppDataTransferLevel	Sources from which data is allowed to be transferred. Inherited from managedAppProtection. Possible values are: allApps, managedApps, none.
allowedOutboundDataTransferDestinations	managedAppDataTransferLevel	Destinations to which data is allowed to be transferred. Inherited from managedAppProtection. Possible values are: allApps, managedApps, none.
organizationalCredentialsRequired	Boolean	Indicates whether organizational credentials are required for app use. Inherited from managedAppProtection
allowedOutboundClipboardSharingLevel	managedAppClipboardSharingLevel	The level to which the clipboard may be shared between apps on the managed device. Inherited from managedAppProtection. Possible values are: allApps, managedAppsWithPasteIn, managedApps, blocked.
dataBackupBlocked	Boolean	Indicates whether the backup of a managed app's data is blocked. Inherited from managedAppProtection
deviceComplianceRequired	Boolean	Indicates whether device compliance is required. Inherited from managedAppProtection
managedBrowserToOpenLinksRequired	Boolean	Indicates whether internet links should be opened in the managed browser app, or any custom browser specified by CustomBrowserProtocol (for iOS) or CustomBrowserPackageId/CustomBrowserDisplayName (for Android) Inherited from managedAppProtection
saveAsBlocked	Boolean	Indicates whether users may use the "Save As" menu item to save a copy of protected files. Inherited from managedAppProtection
periodOfflineBeforeWipeIsEnforced	Duration	The amount of time an app is allowed to remain disconnected from the internet before all managed data it is wiped. Inherited from managedAppProtection
pinRequired	Boolean	Indicates whether an app-level pin is required. Inherited from managedAppProtection
maximumPinRetries	Int32	Maximum number of incorrect pin retry attempts before the managed app is either blocked or wiped. Inherited from managedAppProtection
simplePinBlocked	Boolean	Indicates whether simplePin is blocked. Inherited from managedAppProtection
minimumPinLength	Int32	Minimum pin length required for an app-level pin if PinRequired is set to True Inherited from managedAppProtection
pinCharacterSet	managedAppPinCharacterSet	Character set which may be used for an app-level pin if PinRequired is set to True. Inherited from managedAppProtection. Possible values are: numeric, alphanumericAndSymbol.
periodBeforePinReset	Duration	TimePeriod before the all-level pin must be reset if PinRequired is set to True. Inherited from managedAppProtection
allowedDataStorageLocations	managedAppDataStorageLocation collection	Data storage locations where a user may store managed data. Inherited from managedAppProtection. Possible values are: oneDriveForBusiness, sharePoint, box, localStorage, photoLibrary.
contactSyncBlocked	Boolean	Indicates whether contacts can be synced to the user's device. Inherited from managedAppProtection
printBlocked	Boolean	Indicates whether printing is allowed from managed apps. Inherited from managedAppProtection
fingerprintBlocked	Boolean	Indicates whether use of the fingerprint reader is allowed in place of a pin if PinRequired is set to True. Inherited from managedAppProtection
disableAppPinIfDevicePinIsSet	Boolean	Indicates whether use of the app pin is required if the device pin is set. Inherited from managedAppProtection
maximumRequiredOsVersion	String	Versions bigger than the specified version will block the managed app from accessing company data. Inherited from managedAppProtection
maximumWarningOsVersion	String	Versions bigger than the specified version will block the managed app from accessing company data. Inherited from managedAppProtection
maximumWipeOsVersion	String	Versions bigger than the specified version will block the managed app from accessing company data. Inherited from managedAppProtection
minimumRequiredOsVersion	String	Versions less than the specified version will block the managed app from accessing company data. Inherited from managedAppProtection
minimumWarningOsVersion	String	Versions less than the specified version will result in warning message on the managed app from accessing company data. Inherited from managedAppProtection
minimumRequiredAppVersion	String	Versions less than the specified version will block the managed app from accessing company data. Inherited from managedAppProtection
minimumWarningAppVersion	String	Versions less than the specified version will result in warning message on the managed app. Inherited from managedAppProtection
minimumWipeOsVersion	String	Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from managedAppProtection
minimumWipeAppVersion	String	Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from managedAppProtection
appActionIfDeviceComplianceRequired	managedAppRemediationAction	Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from managedAppProtection. Possible values are: block, wipe, warn.
appActionIfMaximumPinRetriesExceeded	managedAppRemediationAction	Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from managedAppProtection. Possible values are: block, wipe, warn.
pinRequiredInsteadOfBiometricTimeout	Duration	Timeout in minutes for an app pin instead of non biometrics passcode Inherited from managedAppProtection
allowedOutboundClipboardSharingExceptionLength	Int32	Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed. Inherited from managedAppProtection
notificationRestriction	managedAppNotificationRestriction	Specify app notification restriction Inherited from managedAppProtection. Possible values are: allow, blockOrganizationalData, block.
previousPinBlockCount	Int32	Requires a pin to be unique from the number specified in this property. Inherited from managedAppProtection
managedBrowser	managedBrowserType	Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Inherited from managedAppProtection. Possible values are: notConfigured, microsoftEdge.
maximumAllowedDeviceThreatLevel	managedAppDeviceThreatLevel	Maximum allowed device threat level, as reported by the MTD app Inherited from managedAppProtection. Possible values are: notConfigured, secured, low, medium, high.
mobileThreatDefenseRemediationAction	managedAppRemediationAction	Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from managedAppProtection. Possible values are: block, wipe, warn.
mobileThreatDefensePartnerPriority	mobileThreatDefensePartnerPriority	Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null Inherited from managedAppProtection. Possible values are: defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender, unknownFutureValue.
blockDataIngestionIntoOrganizationDocuments	Boolean	Indicates whether a user can bring data into org documents. Inherited from managedAppProtection
allowedDataIngestionLocations	managedAppDataIngestionLocation collection	Data storage locations where a user may store managed data. Inherited from managedAppProtection. Possible values are: oneDriveForBusiness, sharePoint, camera, photoLibrary.
appActionIfUnableToAuthenticateUser	managedAppRemediationAction	If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from managedAppProtection. Possible values are: block, wipe, warn.
dialerRestrictionLevel	managedAppPhoneNumberRedirectLevel	The classes of dialer apps that are allowed to click-to-open a phone number. Inherited from managedAppProtection. Possible values are: allApps, managedApps, customApp, blocked.
gracePeriodToBlockAppsDuringOffClockHours	Duration	A grace period before blocking app access during off clock hours. Inherited from managedAppProtection
protectedMessagingRedirectAppType	messagingRedirectAppType	Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Inherited from managedAppProtection. Possible values are: anyApp, anyManagedApp, specificApps, blocked.
isAssigned	Boolean	Indicates if the policy is deployed to any inclusion groups or not. Inherited from targetedManagedAppProtection
targetedAppManagementLevels	appManagementLevel	The intended app management levels for this policy Inherited from targetedManagedAppProtection. Possible values are: unspecified, unmanaged, mdm, androidEnterprise, androidEnterpriseDedicatedDevicesWithAzureAdSharedMode, androidOpenSourceProjectUserAssociated, androidOpenSourceProjectUserless, unknownFutureValue.
appGroupType	targetedManagedAppGroupType	Public Apps selection: group or individual Inherited from targetedManagedAppProtection. Possible values are: selectedPublicApps, allCoreMicrosoftApps, allMicrosoftApps, allApps.
appDataEncryptionType	managedAppDataEncryptionType	Type of encryption which should be used for data in a managed app. Possible values are: useDeviceSettings, afterDeviceRestart, whenDeviceLockedExceptOpenFiles, whenDeviceLocked.
minimumRequiredSdkVersion	String	Versions less than the specified version will block the managed app from accessing company data.
deployedAppCount	Int32	Count of apps to which the current policy is deployed.
faceIdBlocked	Boolean	Indicates whether use of the FaceID is allowed in place of a pin if PinRequired is set to True.
exemptedAppProtocols	keyValuePair collection	Apps in this list will be exempt from the policy and will be able to receive data from managed apps.
minimumWipeSdkVersion	String	Versions less than the specified version will block the managed app from accessing company data.
allowedIosDeviceModels	String	Semicolon seperated list of device models allowed, as a string, for the managed app to work.
appActionIfIosDeviceModelNotAllowed	managedAppRemediationAction	Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: block, wipe, warn.
appActionIfAccountIsClockedOut	managedAppRemediationAction	Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: block, wipe, warn.
thirdPartyKeyboardsBlocked	Boolean	Defines if third party keyboards are allowed while accessing a managed app
filterOpenInToOnlyManagedApps	Boolean	Defines if open-in operation is supported from the managed app to the filesharing locations selected. This setting only applies when AllowedOutboundDataTransferDestinations is set to ManagedApps and DisableProtectionOfManagedOutboundOpenInData is set to False.
disableProtectionOfManagedOutboundOpenInData	Boolean	Disable protection of data transferred to other apps through IOS OpenIn option. This setting is only allowed to be True when AllowedOutboundDataTransferDestinations is set to ManagedApps.
protectInboundDataFromUnknownSources	Boolean	Protect incoming data from unknown source. This setting is only allowed to be True when AllowedInboundDataTransferSources is set to AllApps.
customBrowserProtocol	String	A custom browser protocol to open weblink on iOS. When this property is configured, ManagedBrowserToOpenLinksRequired should be true.
customDialerAppProtocol	String	Protocol of a custom dialer app to click-to-open a phone number on iOS, for example, skype:.
managedUniversalLinks	String collection	A list of custom urls that are allowed to invocate a managed app
exemptedUniversalLinks	String collection	A list of custom urls that are allowed to invocate an unmanaged app
minimumWarningSdkVersion	String	Versions less than the specified version will result in warning message on the managed app from accessing company data.
messagingRedirectAppUrlScheme	String	When a specific app redirection is enforced by protectedMessagingRedirectAppType in an App Protection Policy, this value defines the app url redirect schemes which are allowed to be used.

Response

If successful, this method returns a 201 Created response code and a iosManagedAppProtection object in the response body.

Example

Request

Here is an example of the request.

POST https://graph.microsoft.com/beta/deviceAppManagement/iosManagedAppProtections
Content-type: application/json
Content-length: 3883

{
  "@odata.type": "#microsoft.graph.iosManagedAppProtection",
  "displayName": "Display Name value",
  "description": "Description value",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "version": "Version value",
  "periodOfflineBeforeAccessCheck": "-PT17.1357909S",
  "periodOnlineBeforeAccessCheck": "PT35.0018757S",
  "allowedInboundDataTransferSources": "managedApps",
  "allowedOutboundDataTransferDestinations": "managedApps",
  "organizationalCredentialsRequired": true,
  "allowedOutboundClipboardSharingLevel": "managedAppsWithPasteIn",
  "dataBackupBlocked": true,
  "deviceComplianceRequired": true,
  "managedBrowserToOpenLinksRequired": true,
  "saveAsBlocked": true,
  "periodOfflineBeforeWipeIsEnforced": "-PT3M22.1587532S",
  "pinRequired": true,
  "maximumPinRetries": 1,
  "simplePinBlocked": true,
  "minimumPinLength": 0,
  "pinCharacterSet": "alphanumericAndSymbol",
  "periodBeforePinReset": "PT3M29.6631862S",
  "allowedDataStorageLocations": [
    "sharePoint"
  ],
  "contactSyncBlocked": true,
  "printBlocked": true,
  "fingerprintBlocked": true,
  "disableAppPinIfDevicePinIsSet": true,
  "maximumRequiredOsVersion": "Maximum Required Os Version value",
  "maximumWarningOsVersion": "Maximum Warning Os Version value",
  "maximumWipeOsVersion": "Maximum Wipe Os Version value",
  "minimumRequiredOsVersion": "Minimum Required Os Version value",
  "minimumWarningOsVersion": "Minimum Warning Os Version value",
  "minimumRequiredAppVersion": "Minimum Required App Version value",
  "minimumWarningAppVersion": "Minimum Warning App Version value",
  "minimumWipeOsVersion": "Minimum Wipe Os Version value",
  "minimumWipeAppVersion": "Minimum Wipe App Version value",
  "appActionIfDeviceComplianceRequired": "wipe",
  "appActionIfMaximumPinRetriesExceeded": "wipe",
  "pinRequiredInsteadOfBiometricTimeout": "-PT3M9.8396734S",
  "allowedOutboundClipboardSharingExceptionLength": 14,
  "notificationRestriction": "blockOrganizationalData",
  "previousPinBlockCount": 5,
  "managedBrowser": "microsoftEdge",
  "maximumAllowedDeviceThreatLevel": "secured",
  "mobileThreatDefenseRemediationAction": "wipe",
  "mobileThreatDefensePartnerPriority": "thirdPartyPartnerOverDefender",
  "blockDataIngestionIntoOrganizationDocuments": true,
  "allowedDataIngestionLocations": [
    "sharePoint"
  ],
  "appActionIfUnableToAuthenticateUser": "wipe",
  "dialerRestrictionLevel": "managedApps",
  "gracePeriodToBlockAppsDuringOffClockHours": "PT2M4.5004762S",
  "protectedMessagingRedirectAppType": "anyManagedApp",
  "isAssigned": true,
  "targetedAppManagementLevels": "unmanaged",
  "appGroupType": "allCoreMicrosoftApps",
  "appDataEncryptionType": "afterDeviceRestart",
  "minimumRequiredSdkVersion": "Minimum Required Sdk Version value",
  "deployedAppCount": 0,
  "faceIdBlocked": true,
  "exemptedAppProtocols": [
    {
      "@odata.type": "microsoft.graph.keyValuePair",
      "name": "Name value",
      "value": "Value value"
    }
  ],
  "minimumWipeSdkVersion": "Minimum Wipe Sdk Version value",
  "allowedIosDeviceModels": "Allowed Ios Device Models value",
  "appActionIfIosDeviceModelNotAllowed": "wipe",
  "appActionIfAccountIsClockedOut": "wipe",
  "thirdPartyKeyboardsBlocked": true,
  "filterOpenInToOnlyManagedApps": true,
  "disableProtectionOfManagedOutboundOpenInData": true,
  "protectInboundDataFromUnknownSources": true,
  "customBrowserProtocol": "Custom Browser Protocol value",
  "customDialerAppProtocol": "Custom Dialer App Protocol value",
  "managedUniversalLinks": [
    "Managed Universal Links value"
  ],
  "exemptedUniversalLinks": [
    "Exempted Universal Links value"
  ],
  "minimumWarningSdkVersion": "Minimum Warning Sdk Version value",
  "messagingRedirectAppUrlScheme": "Messaging Redirect App Url Scheme value"
}

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 4055

{
  "@odata.type": "#microsoft.graph.iosManagedAppProtection",
  "displayName": "Display Name value",
  "description": "Description value",
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "id": "5bc789cb-89cb-5bc7-cb89-c75bcb89c75b",
  "version": "Version value",
  "periodOfflineBeforeAccessCheck": "-PT17.1357909S",
  "periodOnlineBeforeAccessCheck": "PT35.0018757S",
  "allowedInboundDataTransferSources": "managedApps",
  "allowedOutboundDataTransferDestinations": "managedApps",
  "organizationalCredentialsRequired": true,
  "allowedOutboundClipboardSharingLevel": "managedAppsWithPasteIn",
  "dataBackupBlocked": true,
  "deviceComplianceRequired": true,
  "managedBrowserToOpenLinksRequired": true,
  "saveAsBlocked": true,
  "periodOfflineBeforeWipeIsEnforced": "-PT3M22.1587532S",
  "pinRequired": true,
  "maximumPinRetries": 1,
  "simplePinBlocked": true,
  "minimumPinLength": 0,
  "pinCharacterSet": "alphanumericAndSymbol",
  "periodBeforePinReset": "PT3M29.6631862S",
  "allowedDataStorageLocations": [
    "sharePoint"
  ],
  "contactSyncBlocked": true,
  "printBlocked": true,
  "fingerprintBlocked": true,
  "disableAppPinIfDevicePinIsSet": true,
  "maximumRequiredOsVersion": "Maximum Required Os Version value",
  "maximumWarningOsVersion": "Maximum Warning Os Version value",
  "maximumWipeOsVersion": "Maximum Wipe Os Version value",
  "minimumRequiredOsVersion": "Minimum Required Os Version value",
  "minimumWarningOsVersion": "Minimum Warning Os Version value",
  "minimumRequiredAppVersion": "Minimum Required App Version value",
  "minimumWarningAppVersion": "Minimum Warning App Version value",
  "minimumWipeOsVersion": "Minimum Wipe Os Version value",
  "minimumWipeAppVersion": "Minimum Wipe App Version value",
  "appActionIfDeviceComplianceRequired": "wipe",
  "appActionIfMaximumPinRetriesExceeded": "wipe",
  "pinRequiredInsteadOfBiometricTimeout": "-PT3M9.8396734S",
  "allowedOutboundClipboardSharingExceptionLength": 14,
  "notificationRestriction": "blockOrganizationalData",
  "previousPinBlockCount": 5,
  "managedBrowser": "microsoftEdge",
  "maximumAllowedDeviceThreatLevel": "secured",
  "mobileThreatDefenseRemediationAction": "wipe",
  "mobileThreatDefensePartnerPriority": "thirdPartyPartnerOverDefender",
  "blockDataIngestionIntoOrganizationDocuments": true,
  "allowedDataIngestionLocations": [
    "sharePoint"
  ],
  "appActionIfUnableToAuthenticateUser": "wipe",
  "dialerRestrictionLevel": "managedApps",
  "gracePeriodToBlockAppsDuringOffClockHours": "PT2M4.5004762S",
  "protectedMessagingRedirectAppType": "anyManagedApp",
  "isAssigned": true,
  "targetedAppManagementLevels": "unmanaged",
  "appGroupType": "allCoreMicrosoftApps",
  "appDataEncryptionType": "afterDeviceRestart",
  "minimumRequiredSdkVersion": "Minimum Required Sdk Version value",
  "deployedAppCount": 0,
  "faceIdBlocked": true,
  "exemptedAppProtocols": [
    {
      "@odata.type": "microsoft.graph.keyValuePair",
      "name": "Name value",
      "value": "Value value"
    }
  ],
  "minimumWipeSdkVersion": "Minimum Wipe Sdk Version value",
  "allowedIosDeviceModels": "Allowed Ios Device Models value",
  "appActionIfIosDeviceModelNotAllowed": "wipe",
  "appActionIfAccountIsClockedOut": "wipe",
  "thirdPartyKeyboardsBlocked": true,
  "filterOpenInToOnlyManagedApps": true,
  "disableProtectionOfManagedOutboundOpenInData": true,
  "protectInboundDataFromUnknownSources": true,
  "customBrowserProtocol": "Custom Browser Protocol value",
  "customDialerAppProtocol": "Custom Dialer App Protocol value",
  "managedUniversalLinks": [
    "Managed Universal Links value"
  ],
  "exemptedUniversalLinks": [
    "Exempted Universal Links value"
  ],
  "minimumWarningSdkVersion": "Minimum Warning Sdk Version value",
  "messagingRedirectAppUrlScheme": "Messaging Redirect App Url Scheme value"
}