[Index]
Model ref.: device/exchangeonline/MobileDeviceMailboxPolicy
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"AdminDisplayName": {
"__type_requested": "System.String",
"required": false,
"name": "AdminDisplayName",
"title": "AdminDisplayName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"UNCAccessEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The UNCAccessEnabled parameter specifies whether access to Microsoft Windows file shares is enabled from the mobile device. In on-premises Exchange organizations, access to specific shares is configured on the Exchange ActiveSync virtual directory.",
"title": "UNCAccessEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "UNCAccessEnabled"
},
"AllowPOPIMAPEmail": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access by third-party email programs.",
"title": "AllowPOPIMAPEmail",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowPOPIMAPEmail"
},
"AllowDesktopSync": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowDesktopSync parameter specifies whether the mobile device can synchronize with a desktop computer through a cable. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowDesktopSync",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowDesktopSync"
},
"PasswordHistory": {
"__type_requested": "Int32",
"__type_mapping_type": "Integer",
"description": "The PasswordHistory parameter specifies the number of unique new passwords that need to be created on the mobile device before an old password can be reused.\nYou can enter any number from 0 through 50. The default value is 0.",
"title": "PasswordHistory",
"required": false,
"readonly": false,
"type": "integer",
"name": "PasswordHistory"
},
"AllowBrowser": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't affect third-party browsers.",
"title": "AllowBrowser",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowBrowser"
},
"AllowWiFi": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowWiFi parameter specifies whether wireless Internet access is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowWiFi",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowWiFi"
},
"DeviceEncryptionEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The DeviceEncryptionEnabled parameter specifies whether encryption is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $false.\nWhen this parameter is set to $true, device encryption is enabled on the mobile device.",
"title": "DeviceEncryptionEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "DeviceEncryptionEnabled"
},
"RequireStorageCardEncryption": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The RequireStorageCardEncryption parameter specifies whether storage card encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false.\nSetting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true.",
"title": "RequireStorageCardEncryption",
"required": false,
"readonly": false,
"type": "boolean",
"name": "RequireStorageCardEncryption"
},
"AllowRemoteDesktop": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowRemoteDesktop parameter specifies whether the mobile device can initiate a remote desktop connection. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowRemoteDesktop",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowRemoteDesktop"
},
"MinPasswordLength": {
"__type_requested": "Int32",
"__type_mapping_type": "Integer",
"description": "The MinPasswordLength parameter specifies the minimum number of characters in the mobile device password.\nYou can enter any number from 1 through 16 or the value $null. The default value is blank. The maximum password length is 16 characters.",
"title": "MinPasswordLength",
"required": false,
"readonly": false,
"type": "integer",
"name": "MinPasswordLength"
},
"DevicePolicyRefreshInterval": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The DevicePolicyRefreshInterval parameter specifies how often the policy is sent to the mobile device.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds.\nThe default value is Unlimited.",
"title": "DevicePolicyRefreshInterval",
"required": false,
"readonly": false,
"type": "string",
"name": "DevicePolicyRefreshInterval"
},
"ObjectClass": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"required": false,
"name": "ObjectClass",
"title": "ObjectClass",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"Id": {
"__type_requested": "System.String",
"required": false,
"name": "Id",
"title": "Id",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"AllowMicrosoftPushNotifications": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "This parameter is available only in the cloud-based service.\nThe AllowMicrosoftPushNotifications parameter specifies whether push notifications are enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowMicrosoftPushNotifications",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowMicrosoftPushNotifications"
},
"AllowConsumerEmail": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowConsumerEmail parameter specifies whether the user can configure a personal email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access to email accounts using third-party mobile device email programs.",
"title": "AllowConsumerEmail",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowConsumerEmail"
},
"AllowUnsignedApplications": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowUnsignedApplications",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowUnsignedApplications"
},
"WSSAccessEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The WSSAccessEnabled parameter specifies whether access to Microsoft Windows SharePoint Services is enabled from the mobile device. In on-premises Exchange organizations, access to specific shares is configured on the Exchange ActiveSync virtual directory.",
"title": "WSSAccessEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "WSSAccessEnabled"
},
"AllowApplePushNotifications": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "This parameter is available only in the cloud-based service.\nThe AllowApplePushNotifications parameter specifies whether push notifications are allowed for Apple mobile devices. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowApplePushNotifications",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowApplePushNotifications"
},
"PSShowComputerName": {
"__type_requested": "System.Boolean",
"required": false,
"name": "PSShowComputerName",
"title": "PSShowComputerName",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"PasswordRecoveryEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The PasswordRecoveryEnabled parameter specifies whether the recovery password for the mobile device is stored in Exchange. Valid input for this parameter is $true or $false. The default value is $false.\nWhen set to $true, this parameter enables you to store the recovery password for the mobile device in Exchange. The recovery password can be viewed from Outlook on the web or the Exchange admin center.",
"title": "PasswordRecoveryEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "PasswordRecoveryEnabled"
},
"PSComputerName": {
"__type_requested": "System.String",
"required": false,
"name": "PSComputerName",
"title": "PSComputerName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"AllowIrDA": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile device. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowIrDA",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowIrDA"
},
"IrmEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mobile device. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "IrmEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "IrmEnabled"
},
"AllowInternetSharing": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowInternetSharing parameter specifies whether the mobile device can be used as a modem to connect a computer to the Internet. This process is also known as tethering. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowInternetSharing",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowInternetSharing"
},
"AlphanumericPasswordRequired": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AlphanumericPasswordRequired parameter specifies whether the password for the mobile device must be alphanumeric. Valid input for this parameter is $true or $false. The default value is $false.",
"title": "AlphanumericPasswordRequired",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AlphanumericPasswordRequired"
},
"ObjectState": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectState",
"title": "ObjectState",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"RequireSignedSMIMEAlgorithm": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The RequireSignedSMIMEAlgorithm parameter specifies the algorithm that's used to sign S/MIME messages on the mobile device.\nValid values for this parameter are SHA1 or MD5. The default value is SHA1.",
"title": "RequireSignedSMIMEAlgorithm",
"required": false,
"readonly": false,
"type": "string",
"name": "RequireSignedSMIMEAlgorithm"
},
"IsDefault": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The IsDefault parameter specifies whether this policy is the default mobile device mailbox policy. Valid input for this parameter is $true or $false. The default value for the built-in mobile device mailbox policy named Default is $true. The default value for new mobile device mailbox policies that you create is $false.\nThere can be only one default policy. If another policy is currently set as the default, and you set this parameter to $true, this policy becomes the default policy. The value of this parameter on the other policy is automatically changed to $false, and that policy is no longer the default policy.",
"title": "IsDefault",
"required": false,
"readonly": false,
"type": "boolean",
"name": "IsDefault"
},
"AllowStorageCard": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowStorageCard parameter specifies whether the mobile device can access information stored on a storage card. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowStorageCard",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowStorageCard"
},
"MaxEmailHTMLBodyTruncationSize": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited.\nUnqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096.",
"title": "MaxEmailHTMLBodyTruncationSize",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxEmailHTMLBodyTruncationSize"
},
"RequireSignedSMIMEMessages": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The RequireSignedSMIMEMessages parameter specifies whether the mobile device must send signed S/MIME messages. Valid input for this parameter is $true or $false. The default value is $false.",
"title": "RequireSignedSMIMEMessages",
"required": false,
"readonly": false,
"type": "boolean",
"name": "RequireSignedSMIMEMessages"
},
"AttachmentsEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AttachmentsEnabled parameter specifies whether attachments can be downloaded on the mobile device. Valid input for this parameter is $true or $false. The default value is $true.\nWhen set to $false, this parameter blocks the user from downloading attachments on the mobile device.",
"title": "AttachmentsEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AttachmentsEnabled"
},
"DistinguishedName": {
"__type_requested": "System.String",
"required": false,
"name": "DistinguishedName",
"title": "DistinguishedName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"MaxPasswordFailedAttempts": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxPasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile device.\nYou can enter any number from 4 through 16 or the value Unlimited. The default value is Unlimited.",
"title": "MaxPasswordFailedAttempts",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxPasswordFailedAttempts"
},
"AllowHTMLEmail": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowHTMLEmail parameter specifies whether HTML-formatted email is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. If set to $false, all email is converted to plain text before synchronization occurs.",
"title": "AllowHTMLEmail",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowHTMLEmail"
},
"OriginatingServer": {
"__type_requested": "System.String",
"required": false,
"name": "OriginatingServer",
"title": "OriginatingServer",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"Name": {
"__type_requested": "String",
"__type_mapping_type": "String",
"description": "The Name parameter specifies the name of the mobile device mailbox policy. You can use any value that uniquely identifies the policy. For example:\nName\nDistinguished name (DN)\nGUID\nThe name of the built-in mobile device mailbox policy is Default.",
"title": "Name",
"required": true,
"readonly": false,
"type": "string",
"name": "Name"
},
"UnapprovedInROMApplicationList": {
"__type_requested": "MultiValuedProperty",
"__type_mapping_type": "String[]",
"description": "The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM on the mobile device.",
"title": "UnapprovedInROMApplicationList",
"items": {
"type": "string"
},
"required": false,
"readonly": false,
"type": "array",
"name": "UnapprovedInROMApplicationList"
},
"MinPasswordComplexCharacters": {
"__type_requested": "Int32",
"__type_mapping_type": "Integer",
"description": "The MinPasswordComplexCharacters parameter specifies the character sets that are required in the password of the mobile device. The character sets are:\nLower case letters.\nUpper case letters.\nDigits 0 through 9.\nSpecial characters (for example, exclamation marks).\nA valid value for this parameter is an integer from 1 through 4. The default value is 1.\nFor Windows Phone 8 devices, the value specifies the number of character sets that are required in the password. For example, the value 3 requires at least one character from any three of the character sets.\nFor Windows Phone 10 devices, the value specifies the following password complexity requirements:\nDigits only.\nDigits and lower case letters.\nDigits, lower case letters, and upper case letters.\nDigits, lower case letters, upper case letters, and special characters.",
"title": "MinPasswordComplexCharacters",
"required": false,
"readonly": false,
"type": "integer",
"name": "MinPasswordComplexCharacters"
},
"WhenCreatedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreatedUTC",
"title": "WhenCreatedUTC",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"ApprovedApplicationList": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.SystemConfiguration.ApprovedApplicationCollection",
"__type_mapping_type": "Unknown",
"description": "The ApprovedApplicationList parameter specifies a configured list of approved applications for the device.",
"title": "ApprovedApplicationList",
"required": false,
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "ApprovedApplicationList"
},
"WhenCreated": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreated",
"title": "WhenCreated",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"AllowUnsignedInstallationPackages": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages are allowed to run on the mobile device. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowUnsignedInstallationPackages",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowUnsignedInstallationPackages"
},
"PasswordEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The PasswordEnabled parameter specifies whether a password is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false.\nWhen set to $true, this parameter requires the user to set a password on the mobile device.",
"title": "PasswordEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "PasswordEnabled"
},
"ExchangeVersion": {
"__type_requested": "System.String",
"required": false,
"name": "ExchangeVersion",
"title": "ExchangeVersion",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"RequireEncryptedSMIMEMessages": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The RequireEncryptedSMIMEMessages parameter specifies whether the mobile device must send encrypted S/MIME messages. Valid input for this parameter is $true or $false. The default value is $false.",
"title": "RequireEncryptedSMIMEMessages",
"required": false,
"readonly": false,
"type": "boolean",
"name": "RequireEncryptedSMIMEMessages"
},
"MaxEmailAgeFilter": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the mobile device. Valid values for this parameter are:\nAll\nOneDay\nThreeDays\nOneWeek\nTwoWeeks\nOneMonth\nThe default value is All.",
"title": "MaxEmailAgeFilter",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxEmailAgeFilter"
},
"RunspaceId": {
"__type_requested": "System.Guid",
"required": false,
"name": "RunspaceId",
"title": "RunspaceId",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"AllowNonProvisionableDevices": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowNonProvisionableDevices parameter specifies whether all mobile devices can synchronize with Exchange. Valid input for this parameter is $true or $false. The default value is $true.\nWhen set to $true, this parameter enables all mobile devices to synchronize with Exchange, regardless of whether the device can enforce all settings that are defined by the policy. This also includes mobile devices managed by a separate device management system. When set to $false, this parameter blocks mobile devices that aren't provisioned from synchronizing with Exchange.",
"title": "AllowNonProvisionableDevices",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowNonProvisionableDevices"
},
"RequireManualSyncWhenRoaming": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The RequireManualSyncWhenRoaming parameter specifies whether the mobile device must synchronize manually while roaming. Valid input for this parameter is $true or $false. The default value is $false.",
"title": "RequireManualSyncWhenRoaming",
"required": false,
"readonly": false,
"type": "boolean",
"name": "RequireManualSyncWhenRoaming"
},
"ObjectCategory": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectCategory",
"title": "ObjectCategory",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"MaxEmailBodyTruncationSize": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited.\nUnqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096.",
"title": "MaxEmailBodyTruncationSize",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxEmailBodyTruncationSize"
},
"Guid": {
"__type_requested": "System.Guid",
"required": false,
"name": "Guid",
"title": "Guid",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"DomainController": {
"__type_requested": "Fqdn",
"__type_mapping_type": "String",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.",
"title": "DomainController",
"required": false,
"readonly": false,
"type": "string",
"name": "DomainController"
},
"AllowBluetooth": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The AllowBluetooth parameter specifies whether the Bluetooth capabilities of the mobile device are allowed. The available options are Disable, HandsfreeOnly, and Allow. The default value is Allow.",
"title": "AllowBluetooth",
"required": false,
"readonly": false,
"type": "string",
"name": "AllowBluetooth"
},
"PasswordExpiration": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The PasswordExpiration parameter specifies how long a password can be used on a mobile device before the user is forced to change the password. This parameter accepts the following values:\nTimespan ddd.hh:mm:ss, where ddd = days, hh = hours, mm = minutes and ss= seconds. The valid input range is 1.00:00:00 to 730.00:00:00 (one day to two years).\nThe value Unlimited.\nThe default value is Unlimited.",
"title": "PasswordExpiration",
"required": false,
"readonly": false,
"type": "string",
"name": "PasswordExpiration"
},
"MaxInactivityTimeLock": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxInactivityTimeLock parameter specifies the length of time that the mobile device can be inactive before the password is required to reactivate it. This parameter accepts the following values:\nTimespan hh:mm:ss, where hh = hours, mm = minutes and ss= seconds. The valid input range is 00:01:00 to 01:00:00 (one minute to one hour).\nThe value Unlimited.\nThe default value is Unlimited.",
"title": "MaxInactivityTimeLock",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxInactivityTimeLock"
},
"IsValid": {
"__type_requested": "System.Boolean",
"required": false,
"name": "IsValid",
"title": "IsValid",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"OrganizationId": {
"__type_requested": "System.String",
"required": false,
"name": "OrganizationId",
"title": "OrganizationId",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"RequireDeviceEncryption": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The RequireDeviceEncryption parameter specifies whether encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false.",
"title": "RequireDeviceEncryption",
"required": false,
"readonly": false,
"type": "boolean",
"name": "RequireDeviceEncryption"
},
"AllowSMIMESoftCerts": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowSMIMESoftCerts",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowSMIMESoftCerts"
},
"AllowSimplePassword": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowSimplePassword parameter specifies whether a simple password is allowed on the mobile device. A simple password is a password that has a specific pattern, such as 1111 or 1234. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowSimplePassword",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowSimplePassword"
},
"WhenChanged": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChanged",
"title": "WhenChanged",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"WhenChangedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChangedUTC",
"title": "WhenChangedUTC",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"RequireEncryptionSMIMEAlgorithm": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The RequireEncryptionSMIMEAlgorithm parameter specifies the algorithm that's required to encrypt S/MIME messages on a mobile device. The valid values for this parameter are:\nDES\nTripleDES\nRC240bit\nRC264bit\nRC2128bit\nThe default value is TripleDES.",
"title": "RequireEncryptionSMIMEAlgorithm",
"required": false,
"readonly": false,
"type": "string",
"name": "RequireEncryptionSMIMEAlgorithm"
},
"MaxCalendarAgeFilter": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the mobile device. Valid values for this parameter are:\nAll\nTwoWeeks\nOneMonth\nThreeMonths\nSixMonths\nThe default value is All.",
"title": "MaxCalendarAgeFilter",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxCalendarAgeFilter"
},
"AllowTextMessaging": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowTextMessaging parameter specifies whether text messaging is allowed from the mobile device. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowTextMessaging",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowTextMessaging"
},
"Identity": {
"__type_requested": "System.String",
"required": false,
"name": "Identity",
"title": "Identity",
"__type_mapping_type": "String",
"readonly": true,
"type": "string",
"description": "The Identity parameter specifies the policy name."
},
"AllowGooglePushNotifications": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "This parameter is available only in the cloud-based service.\nThe AllowGooglePushNotifications parameter controls whether the user can receive push notifications from Google for Outlook on the web for devices. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowGooglePushNotifications",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowGooglePushNotifications"
},
"MobileOTAUpdateMode": {
"__type_requested": "System.String",
"required": false,
"name": "MobileOTAUpdateMode",
"title": "MobileOTAUpdateMode",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"AllowMobileOTAUpdate": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowMobileOTAUpdate parameter specifies whether the policy can be sent to the mobile device over a cellular data connection. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowMobileOTAUpdate",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowMobileOTAUpdate"
},
"AllowSMIMEEncryptionAlgorithmNegotiation": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The AllowSMIMEEncryptionAlgorithmNegotiation parameter specifies whether the messaging application on the mobile device can negotiate the encryption algorithm if a recipient's certificate doesn't support the specified encryption algorithm. Valid values for this parameter are:\nAllowAnyAlgorithmNegotiation\nBlockNegotiation\nOnlyStrongAlgorithmNegotiation\nThe default value is AllowAnyAlgorithmNegotiation.",
"title": "AllowSMIMEEncryptionAlgorithmNegotiation",
"required": false,
"readonly": false,
"type": "string",
"name": "AllowSMIMEEncryptionAlgorithmNegotiation"
},
"AllowExternalDeviceManagement": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the mobile device. Valid input for this parameter is $true or $false. The default value is $false.",
"title": "AllowExternalDeviceManagement",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowExternalDeviceManagement"
},
"AllowCamera": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowCamera parameter specifies whether the mobile device's camera is allowed. Valid input for this parameter is $true or $false. The default value is $true.",
"title": "AllowCamera",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowCamera"
},
"MaxAttachmentSize": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile device. Valid input for this parameter is a size value between 0 and 2147482624 bytes (approximately 2 GB), or the value Unlimited. The default value is Unlimited.\nUnqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4096 or 4KB.\nThe maximum value is 1024 bytes (one kilobyte) less than two gigabytes (2*1024^3), so these are the maximum qualified values you can use with this parameter.\n2097151KB\n2047.999024MB\n1.999999047GB",
"title": "MaxAttachmentSize",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxAttachmentSize"
}
},
"schema_version": "2017.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/exchangeonline/MobileDeviceMailboxPolicy/add/ |
|
The GUI Add form of device/exchangeonline/MobileDeviceMailboxPolicy as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/exchangeonline/MobileDeviceMailboxPolicy | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/exchangeonline/MobileDeviceMailboxPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid1]", "/api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangeonline/MobileDeviceMailboxPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/exchangeonline/MobileDeviceMailboxPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/exchangeonline/MobileDeviceMailboxPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid1]", "/api/v0/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangeonline/MobileDeviceMailboxPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangeonline/MobileDeviceMailboxPolicy |
|
{"hrefs": ["/api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangeonline/MobileDeviceMailboxPolicy |
|
{"hrefs": ["/api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid1]", "/api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangeonline/MobileDeviceMailboxPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangeonline/MobileDeviceMailboxPolicy/export/ |
|
{ "hrefs":["/api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid1]", "/api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/exchangeonline/MobileDeviceMailboxPolicy and the JSON format can be used to import instances of device/exchangeonline/MobileDeviceMailboxPolicy.
GET http://[host-proxy]/api/device/exchangeonline/MobileDeviceMailboxPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/exchangeonline/MobileDeviceMailboxPolicy | POST | /api/device/exchangeonline/MobileDeviceMailboxPolicy/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/exchangeonline/MobileDeviceMailboxPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/exchangeonline/MobileDeviceMailboxPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/exchangeonline/MobileDeviceMailboxPolicy/ |
|
The device/exchangeonline/MobileDeviceMailboxPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangeonline/MobileDeviceMailboxPolicy instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "Name",
"direction": "asc",
"current": "/api/device/exchangeonline/MobileDeviceMailboxPolicy/?skip=0&limit=3&order_by=Name&direction=asc&traversal=down"
},
"operations": [
"move"
],
"meta": {
"model_type": "device/exchangeonline/MobileDeviceMailboxPolicy",
"summary_attrs": [
{
"name": "Name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"get",
"list",
"add",
"remove",
"update",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"schema_version": "2017.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/device/exchangeonline/MobileDeviceMailboxPolicy/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/exchangeonline/MobileDeviceMailboxPolicy/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/exchangeonline/MobileDeviceMailboxPolicy/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchangeonline/MobileDeviceMailboxPolicy",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/exchangeonline/MobileDeviceMailboxPolicy/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/exchangeonline/MobileDeviceMailboxPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/exchangeonline/MobileDeviceMailboxPolicy/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/exchangeonline/MobileDeviceMailboxPolicy/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/exchangeonline/MobileDeviceMailboxPolicy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/exchangeonline/MobileDeviceMailboxPolicy/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/exchangeonline/MobileDeviceMailboxPolicy/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/exchangeonline/MobileDeviceMailboxPolicy. | GET | /api/device/exchangeonline/MobileDeviceMailboxPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangeonline/MobileDeviceMailboxPolicy as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangeonline/MobileDeviceMailboxPolicy/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangeonline/MobileDeviceMailboxPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangeonline/MobileDeviceMailboxPolicy | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/exchangeonline/MobileDeviceMailboxPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/exchangeonline/MobileDeviceMailboxPolicy and the JSON format can be used to import instances of device/exchangeonline/MobileDeviceMailboxPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid] | hierarchy=[hierarchy] | The device/exchangeonline/MobileDeviceMailboxPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangeonline/MobileDeviceMailboxPolicy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangeonline/MobileDeviceMailboxPolicy/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |