This documentation is for WSO2 Enterprise Mobility Manager 2.1.0. View documentation for the latest release.
Whitelisting or Blacklisting Applications on Android Devices - Enterprise Mobility Manager 2.1.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata
Description

Whitelist or blacklist applications using this API. In whitelisting you define the applications that a user is allowed to use on the device and in blacklisting you define the applications that a user is not allowed to use on a device.

Resource Path
  • Adding a policy that is in the inactive state /inactive-policy.
  • Adding a policy that is in the active state /active-policy.
URL/mdm-admin/policies/inactive-policy or /mdm-admin/policies/active-policy
HTTP MethodPOST
Request/Response Formatapplication/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-admin/policies/inactive-policy
 
or
 
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-admin/policies/active-policy
  • For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
  • Define the path to the JSON file, which includes the required properties to add a policy as the 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 33392fb365b3ac693b405b565ddc8a3a" -d @'policy.json' -k -v https://localhost:9443/mdm-admin/policies/inactive-policy
 
or
 
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'policy.json' -k -v https://localhost:9443/mdm-admin/policies/active-policy
 Sample output
> POST /mdm-admin/policies/active-policy HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a
> Content-Length: 420
< HTTP/1.1 201 Created
< Date: Thu, 25 Feb 2016 06:30:18 GMT
< Content-Type: application/json
< Content-Length: 76
< Server: WSO2 Carbon Server
{"statusCode":201,"messageFromServer":"Policy has been added successfully."}
Sample JSON Definition 
{   
   "policyName":"blacklist",
   "description":"",
   "compliance":"enforce",
   "ownershipType":"ANY",
   "profile":{   
      "profileName":"blacklist",
      "deviceType":{   
         "id":1
      },
      "profileFeaturesList":[   
         {   
            "featureCode":"APP-RESTRICTION",
            "deviceTypeId":1,
            "content":{   
               "restriction-type":"black-list",
               "restricted-applications":[   
                  {   
                     "appName":"app name1",
                     "packageName":"package1"
                  },
                  {   
                     "appName":"app name2",
                     "packageName":"package2"
                  },
                  {   
                     "appName":"app name3",
                     "packageName":"package3"
                  }
               ]
            }
         }
      ]
   },
   "roles":[   
      "ANY"
   ]
}
{   
   "policyName":"whitelist",
   "description":"",
   "compliance":"enforce",
   "ownershipType":"ANY",
   "profile":{   
      "profileName":"whitelist",
      "deviceType":{   
         "id":1
      },
      "profileFeaturesList":[   
         {   
            "featureCode":"APP-RESTRICTION",
            "deviceTypeId":1,
            "content":{   
               "restriction-type":"white-list",
               "restricted-applications":[   
                  {   
                     "appName":"app name1",
                     "packageName":"package1"
                  },
                  {   
                     "appName":"app name2",
                     "packageName":"package2"
                  },
                  {   
                     "appName":"app name3",
                     "packageName":"package3"
                  }
               ]
            }
         }
      ]
   },
   "roles":[   
      "ANY"
   ]
}
PropertyDescriptionData
Type 
policyNameThe name of the policy.String
DescriptionProvide a description on what the policy is based on.String
Compliance

Define the non-compliance rules. WSO2 EMM provides the following non-compliance rules:

  • Enforce - Forcefully enforce the policies on the devices.
  • Warning - If the device does not adhere to the given policies a warning message will be sent.
  • Monitor - If the device does not adhere to the given policies the server is notified of the violation unknown to the user and the administrator can take the necessary actions with regard to the reported.
String
ownershipType

Define the define ownership type using the values given below:

  • ANY - The policy will be applied on the BYOD and COPE device types.
  • BYOD (Bring Your Own Device) - The policy will only be applied on the BYOD device type.
  • COPE (Corporate-Owned, Personally-Enabled) - The policy will only be applied on the COPE device type.
String
profileProvide the policy profile details.-
profileNameThe name of the policy that is being added.String
deviceType

The ID used to define the type of the device platform.

For more information on the unique ID for the device platforms supported by the EMM, see Getting Details of the Devices Supported via WSO2 EMM.

Integer
profileFeaturesListLists the features that belong to the profile.-
featureCode

Provide the code that defines the policy you wish to add.

String
deviceTypeIdThe ID used to define the type of the device platform.Integer
content

The list of parameters that define the policy.

For more information on the feature list for Windows policies, see profileFeaturesList - policy based.

String

restriction-type

Define the application restriction type using the values given below:

  • black-list: Define the applications that needs to be restricted in a device.
  • white-list: Define the applications that are only allowed to be used in a device and restrict the other applications from being used.
String

restricted-applications

Provides the details of the applications that are restricted.-

appName

The name of the application.String
packageName

Define the exact name of the application package. You can use one of the following methods to get the package name.

  • Go to the respective application in the play store and copy the ID or package name from the URL.
    Example: The play store application URL for the Viber app is https://play.google.com/store/apps/details?id=com.viber.voip&hl=en. Therefore, the package name or the application ID is: id=com.viber.voip 
  • Download the System Info for Android to your device from the play store.
    Once the application is successfully installed go to the Tasks tab and you will see the package name under the respective application.
String
rolesDefine the roles the policy needs to be applied on. The policy will be applied on the respective user roles devices.String array

If you wish to add a new policy criteria than what is already supported (roles) you can do so by defining a new policy criteria within the "policyCriterias" :[] field

  • No labels