Setting a Passcode Policy on Android Devices

Description Set a password policy on Android devices.

Resource Path /password-policy

URL /mdm-android-agent/operation/password-policy

HTTP Method POST

Request/Response Format application/json

cURL command

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-android-agent/operation/password-policy

For more information on how to generate the EMM API token, see Generating the OAuth 2.0 Access Token.
Define the path to the JSON file, which includes the required properties to carry out the operation, as the <JSON_PAYLOAD> value. For more information, see the Sample JSON Definition.
By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Example:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer e56974e8bf5df15748f89c6c5da9835d" -d @'operation.json' -k -v https://localhost:9443/mdm-android-agent/operation/password-policy

Sample output

> POST /mdm-android-agent/operation/password-policy HTTP/1.1
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8| zlib/1.2.5
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer e56974e8bf5df15748f89c6c5da9835d
> Content-Length: 216
< HTTP/1.1 201 Created
< Date: Wed, 10 Jun 2015 12:30:39 GMT
< Content-Length: 0
< Server: WSO2 Carbon Server

Sample JSON Definition

{  
   "operation":{  
      "maxFailedAttempts":3,
      "minLength":5,
      "pinHistory":3,
      "minComplexChars":1,
      "maxPINAgeInDays":60,
      "requireAlphanumeric":true,
      "allowSimple":true
   },
   "deviceIDs":[  
      "d8:50:e6:2f:6a:8b",
      "a5:60:e6:2g:6a:5b"
   ]
}

Property	Description	Data Type
operation	This specifies the operation that is to be applied on the Android device.	-
`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. Android devices will be automatically reset to the original factory settings .	Integer
`minLength`	The minimum number of alphanumerical values that the end-user can enter as his/her passcode. By default, Android devices come with a minimum passcode length setting of 4. Therefore the minimum passcode length policy will only get effective if the minimum passcode length is greater then the default passcode length of the device. For example, if the admin applies a policy for the minimum passcode length as 3, the policy will not get effective. Furthermore, 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.	Integer
`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 ).	Integer
`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.	Integer
`maxPINAgeInDays`	The number of days after which the device owner has to change his/her passcode.	Integer
`requireAlphanumeric`	Whether or not it is mandatory for the end-user to have a mix of digits and characters in his/her passcode.	Boolean
`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: Minimum length Minimum complex characters 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, you need to uncheck the 'Allow Simple Values' option via the UI or set this field to "false" when working with the REST API.	Boolean
`deviceIDS`	ID of the Android device. Multiple device IDs can be added by using comma separated values. For more information on retrieving the device ID, see Retrieving the ID of an Android device.	String