Resource Definition to Add a Windows Policy
A sample resource definition, together with details on the information that is added in the JSON are as follows:
Sample definition JSON to add a policy
The following are sample configurations that can be used in a JSON to add a policy on Windows devices:
Property definitions
Property | Description | Data Type | Example | ||
---|---|---|---|---|---|
| The name of the policy that is applied to the Windows device. | Yes | N/A | String | |
| The action that the monitoring task takes when a policy is violated. The following are the three types of actions that can be applied: Enforce,Warn,Monitor. | Yes | N/A | String | Enforce |
| The ownership type of the device. The ownership type named cope is not supported when working with Windows 8.1. | Yes | BYOD | String | BYOD |
| Profile details. | Yes | N/A | ||
profileName
| The name of the profile being added. | Yes | N/A | String | Marketing profile |
deviceType
| The code used to define the type of the device platform. The code 2 is used to define the Windows platform. | Yes | 2 | Integer | 2 |
profileFeaturesList
| The list of features that belong to the selected profile. | Yes | N/A | ||
roles | The role that this passcode can be applied to. If you wish to apply this policy to any policy, state ANY . Otherwise, specify the respective name of the role. | Yes | N/A | ANY |
profileFeaturesList - common
Property | Description | Data Type | Example | ||
---|---|---|---|---|---|
featureCode | The code that defines the policy you wish to add. The available feature codes are as follows: PASSCODE_POLICY, CAMERA and ENCRYPT_STORAGE. | Yes | String | PASSCODE_POLICY | |
deviceTypeId | The code used to define the type of the device platform. The code 2 is used to define the Windows platform. | Yes | 2 | Integer | 2 |
content | The list of parameters that define the policy. For more information, see profileFeaturesList - policy based. | Yes | N/A |
profileFeaturesList - policy based
Passcode Policy
Property | Description | Data Type | Example | ||
---|---|---|---|---|---|
maxFailedAttempts | The maximum number of times the end-user can enter his/her device passcode incorrectly. EMM will take different courses of action based on the OS when the failed attempts exceed the maximum failed attempts. | Yes | N/A | Integer | 3 |
minLength | The minimum number of alphanumerical values that the end-user can enter as his/her passcode. However, if the "Allow Simple" option is set, this rule will be overridden and the user will be allowed to have a passcode of even one alphanumerical value. | Yes | N/A | Integer | 4 |
pinHistory | The end-user will not be allowed to reuse a passcode that he/she previously entered until he/she exceeds the set pin history length (e.g., if the pin history length is 3 and your passcode currently is 21345, you can not enter 21345 as the passcode in the next three consecutive passcode rotation cycles ). | Yes | N/A | Integer | 3 |
minComplexChars | The minimum number of special characters (e.g., @ # etc.) that the end-user will have to enter in his/her passcode. However, if the "Allow Simple" option is set, this rule will be overridden and the user will be allowed to have a passcode without a single complex character. | Yes | N/A | Integer | 1 |
maxPINAgeInDays | The number of days after which the device owner has to change his/her passcode. | Yes | N/A | Integer | 60 |
requireAlphanumeric | Whether or not it is mandatory for the end-user to have a mix of digits and characters in his/her passcode. | Yes | false | Boolean | true |
allowSimple | If this field is set to "true", the device owner will be able to have a simple passcode (e.g., a, 123,abc, a1bc) and the following criteria in the passcode policy will not be applicable:
If you wish to apply a passcode policy that requires the user to comply to a passcode policy with a minimum number of complex characters, uncheck the "Allow Simple Values" option via the UI or set this field to "false" when working with the REST API. | Yes | false | Boolean | true |
enablePassword | Specifies if the device lock is enabled. | Yes | false | Boolean | true |
Camera Enable/Disable
Property | Description | Data Type | Example | ||
---|---|---|---|---|---|
| Enable of disable the camera on the specified Windows devices. | Yes | true | Boolean | false |
Encrypt Storage
Property | Description | Data Type | Example | ||
---|---|---|---|---|---|
| Enable or disable storage encryption on Windows devices. | Yes | true | Boolean | false |