diff --git a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/pom.xml b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/pom.xml
index 017ff5400c..c2ea041777 100644
--- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/pom.xml
+++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/pom.xml
@@ -143,6 +143,11 @@
org.wso2.carbon.device.mgt.common
provided
+
+ org.wso2.carbon.devicemgt
+ org.wso2.carbon.apimgt.annotations
+ provided
+
org.wso2.carbon.devicemgt
org.wso2.carbon.device.mgt.core
diff --git a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceManagementAdminService.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceManagementAdminService.java
index e24f6fbfad..d752a30779 100644
--- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceManagementAdminService.java
+++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceManagementAdminService.java
@@ -24,15 +24,16 @@ import io.swagger.annotations.ExtensionProperty;
import io.swagger.annotations.Extension;
import io.swagger.annotations.Tag;
import io.swagger.annotations.Api;
-import io.swagger.annotations.AuthorizationScope;
-import io.swagger.annotations.Authorization;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import io.swagger.annotations.ResponseHeader;
+import org.wso2.carbon.apimgt.annotations.api.Scope;
+import org.wso2.carbon.apimgt.annotations.api.Scopes;
import org.wso2.carbon.device.mgt.common.operation.mgt.Activity;
import org.wso2.carbon.mdm.services.android.bean.wrapper.*;
+import org.wso2.carbon.mdm.services.android.util.AndroidConstants;
import javax.validation.Valid;
import javax.ws.rs.Consumes;
@@ -64,6 +65,160 @@ import java.util.List;
@Api(value = "Android Device Management Administrative Service", description = "Device management related admin APIs.")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
+@Scopes(
+ scopes = {
+ @Scope(
+ name = "Lock Device",
+ description = "Hard lock own device",
+ key = "cdmf:android:lock-devices",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/lock"}
+ ),
+ @Scope(
+ name = "Unlock Device",
+ description = "Unlock permanently locked device",
+ key = "cdmf:android:unlock-devices",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/unlock"}
+ ),
+ @Scope(
+ name = "Get Location",
+ description = "Request device location coordinates",
+ key = "cdmf:android:location",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/location"}
+ ),
+ @Scope(
+ name = "Clear Password",
+ description = "Clear the password on Android devices",
+ key = "cdmf:android:clear-password",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/clear-password"}
+ ),
+ @Scope(
+ name = "Control Camera",
+ description = "Enabling or Disabling the Camera on Android Devices",
+ key = "cdmf:android:control-camera",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/camera"}
+ ),
+ @Scope(
+ name = "Get Info",
+ description = "Requesting device information from Android Devices",
+ key = "cdmf:android:info",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/info"}
+ ),
+ @Scope(
+ name = "Get Logs",
+ description = "Requesting Logcat Details from Android Devices",
+ key = "cdmf:android:logcat",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/logcat"}
+ ),
+ @Scope(
+ name = "Enterprise Wipe",
+ description = "Enterprise Wiping Android Devices",
+ key = "cdmf:android:enterprise-wipe",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/enterprise-wipe"}
+ ),
+ @Scope(
+ name = "Factory Reset",
+ description = "Factory Resetting Android Devices",
+ key = "cdmf:android:wipe",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/wipe"}
+ ),
+ @Scope(
+ name = "Get Installed Applications",
+ description = "Get list of installed applications",
+ key = "cdmf:android:applications",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/applications"}
+ ),
+ @Scope(
+ name = "Ring Device",
+ description = "Ring Android devices",
+ key = "cdmf:android:ring",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/ring"}
+ ),
+ @Scope(
+ name = "Reboot Device",
+ description = "Reboot Android devices",
+ key = "cdmf:android:reboot",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/reboot"}
+ ),
+ @Scope(
+ name = "Mute Device",
+ description = "Mute Android devices",
+ key = "cdmf:android:mute",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/mute"}
+ ),
+ @Scope(
+ name = "Install Applications",
+ description = "Installing an Application on Android Devices",
+ key = "cdmf:android:install-application",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/install-app"}
+ ),
+ @Scope(
+ name = "Update Applications",
+ description = "Updating an Application on Android Devices",
+ key = "cdmf:android:update-application",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/update-app"}
+ ),
+ @Scope(
+ name = "Uninstall Applications",
+ description = "Uninstalling an Application on Android Devices",
+ key = "cdmf:android:uninstall-application",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/uninstall-app"}
+ ),
+ @Scope(
+ name = "Blacklist Applications",
+ description = "Blacklisting applications on Android Devices",
+ key = "cdmf:android:blacklist-applications",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/blacklist-app"}
+ ),
+ @Scope(
+ name = "Upgrade Firmware",
+ description = "Upgrading Firmware of Android Devices",
+ key = "cdmf:android:upgrade-firmware",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/upgrade"}
+ ),
+ @Scope(
+ name = "Configure VPN",
+ description = "Configure VPN on Android Device",
+ key = "cdmf:android:configure-vpn",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/vpn"}
+ ),
+ @Scope(
+ name = "Send Notification",
+ description = "Sending a notification to Android Device",
+ key = "cdmf:android:send-notification",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/send-notification"}
+ ),
+ @Scope(
+ name = "Configure Wi-Fi",
+ description = "Configure Wi-Fi on Android Device",
+ key = "cdmf:android:configure-wifi",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/wifi"}
+ ),
+ @Scope(
+ name = "Encrypt Storage",
+ description = "Encrypting storage on Android Device",
+ key = "cdmf:android:encrypt-storage",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/encrypt"}
+ ),
+ @Scope(
+ name = "Change Password",
+ description = "Changing the lock code of an Android Device",
+ key = "cdmf:android:change-lock-code",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/change-lock-code"}
+ ),
+ @Scope(
+ name = "Password Policy",
+ description = "Set password policy of an Android Device",
+ key = "cdmf:android:set-password-policy",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/password-policy"}
+ ),
+ @Scope(
+ name = "Add Web clip",
+ description = "Setting a Web Clip on Android Devices",
+ key = "cdmf:android:set-webclip",
+ permissions = {"/device-mgt/devices/owning-device/operations/android/webclip"}
+ )
+ }
+)
public interface DeviceManagementAdminService {
@POST
@@ -76,13 +231,10 @@ public interface DeviceManagementAdminService {
"permanently locks the device or screen locking an Android device.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/lock",
- description = "Lock Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:lock-devices")
+ })
}
)
@ApiResponses(value = {
@@ -142,13 +294,10 @@ public interface DeviceManagementAdminService {
notes = "Unlock devices that were locked permanently using the hard lock operation. Devices that are hard locked can only be unlocked by the EMM administrator.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/unlock",
- description = "Unlock Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:unlock-devices")
+ })
}
)
@ApiResponses(value = {
@@ -208,13 +357,10 @@ public interface DeviceManagementAdminService {
"Example: In situations where you have lost your device and need to find out where it is, you can use this REST API to get the location of the device.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/location",
- description = "Get Device Location") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:location")
+ })
}
)
@ApiResponses(value = {
@@ -270,13 +416,10 @@ public interface DeviceManagementAdminService {
notes = "Clear the password on Android devices",
response = Activity.class,
tags = "Android Device Management Administrative Service.",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/clear-password",
- description = "Clear Password of Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:clear-password")
+ })
}
)
@ApiResponses(value = {
@@ -331,13 +474,11 @@ public interface DeviceManagementAdminService {
notes = "Enable or disable the camera on Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/devices/owning-device/operations/android/camera", description = "Manage Camera") }
- )
- }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:control-camera")
+ })
+ } )
@ApiResponses(value = {
@ApiResponse(
code = 201,
@@ -398,13 +539,10 @@ public interface DeviceManagementAdminService {
"the list of operations that needs to be executed on the device",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/info",
- description = "Get Device Information") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:info")
+ })
}
)
@ApiResponses(value = {
@@ -464,13 +602,10 @@ public interface DeviceManagementAdminService {
"the list of operations that needs to be executed on the device.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/logcat",
- description = "Get Logs") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:logcat")
+ })
}
)
@ApiResponses(value = {
@@ -529,13 +664,10 @@ public interface DeviceManagementAdminService {
"personal data intact. You are able to enterprise wipe Android devices using this REST API.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/enterprise-wipe",
- description = "Enterprise Wipe") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:enterprise-wipe")
+ })
}
)
@ApiResponses(value = {
@@ -592,13 +724,10 @@ public interface DeviceManagementAdminService {
"to restore them back to the original system.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/wipe",
- description = "Factory Reset") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:wipe")
+ })
}
)
@ApiResponses(value = {
@@ -659,13 +788,10 @@ public interface DeviceManagementAdminService {
"on the device.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/applications",
- description = "Get Installed Application") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:applications")
+ })
}
)
@ApiResponses(value = {
@@ -722,13 +848,10 @@ public interface DeviceManagementAdminService {
notes = "Ring Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/ring",
- description = "Ring Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:ring")
+ })
}
)
@ApiResponses(value = {
@@ -785,13 +908,10 @@ public interface DeviceManagementAdminService {
notes = "Reboot or restart your Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/reboot",
- description = "Reboot Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:reboot")
+ })
}
)
@ApiResponses(value = {
@@ -840,6 +960,7 @@ public interface DeviceManagementAdminService {
List deviceIDs);
@POST
+ @Path("/mute")
@ApiOperation(
consumes = MediaType.APPLICATION_JSON,
httpMethod = "POST",
@@ -847,13 +968,10 @@ public interface DeviceManagementAdminService {
notes = "Mute or enable a silent profile for Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/mute",
- description = "Mute Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:mute")
+ })
}
)
@ApiResponses(value = {
@@ -894,7 +1012,6 @@ public interface DeviceManagementAdminService {
message = "Internal Server Error. \n " +
"Server error occurred while adding a new device mute operation.")
})
- @Path("/mute")
Response muteDevice(
@ApiParam(
name = "deviceIDs",
@@ -913,13 +1030,10 @@ public interface DeviceManagementAdminService {
" the application installation will happen in silent mode, else the device user's consent will be required.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/install-app",
- description = "Install Applications") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:install-application")
+ })
}
)
@ApiResponses(value = {
@@ -981,13 +1095,10 @@ public interface DeviceManagementAdminService {
"mode, else the device user's consent is required.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/update-app",
- description = "Update installed applications") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:update-application")
+ })
}
)
@ApiResponses(value = {
@@ -1046,13 +1157,10 @@ public interface DeviceManagementAdminService {
notes = "Uninstall an application from Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/uninstall-app",
- description = "Uninstall Applications") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:uninstall-application")
+ })
}
)
@ApiResponses(value = {
@@ -1115,13 +1223,10 @@ public interface DeviceManagementAdminService {
"COPE devices. Applications can be blacklisted via the application restriction policy too.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/blacklist-app",
- description = "Blacklist Applications") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:blacklist-applications")
+ })
}
)
@ApiResponses(value = {
@@ -1176,17 +1281,14 @@ public interface DeviceManagementAdminService {
consumes = MediaType.APPLICATION_JSON,
produces = MediaType.APPLICATION_JSON,
httpMethod = "POST",
- value = "UUpgrading Firmware of Android Devices",
+ value = "Upgrading Firmware of Android Devices",
notes = "Upgrade the firmware of Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/upgrade",
- description = "Upgrade Firmware") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:upgrade-firmware")
+ })
}
)
@ApiResponses(value = {
@@ -1247,13 +1349,10 @@ public interface DeviceManagementAdminService {
notes = "Configure VPN on Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/vpn",
- description = "Add VPN") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:configure-vpn")
+ })
}
)
@ApiResponses(value = {
@@ -1310,13 +1409,10 @@ public interface DeviceManagementAdminService {
notes = "Send a notification or message to Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/send-notification",
- description = "Send Notifications") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:send-notification")
+ })
}
)
@ApiResponses(value = {
@@ -1374,13 +1470,10 @@ public interface DeviceManagementAdminService {
notes = "Configure Wi-Fi on Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/wifi",
- description = "Add Wifi Configuration") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:configure-wifi")
+ })
}
)
@ApiResponses(value = {
@@ -1439,13 +1532,10 @@ public interface DeviceManagementAdminService {
notes = "Encrypt the data stored on Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/encrypt",
- description = "Encrypt Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:encrypt-storage")
+ })
}
)
@ApiResponses(value = {
@@ -1504,13 +1594,10 @@ public interface DeviceManagementAdminService {
notes = "Change the lock code on Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/change-lock-code",
- description = "Change Password of Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:change-lock-code")
+ })
}
)
@ApiResponses(value = {
@@ -1569,13 +1656,10 @@ public interface DeviceManagementAdminService {
notes = "Set a password policy on Android devices.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/password-policy",
- description = "Set Password Policy") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:set-password-policy")
+ })
}
)
@ApiResponses(value = {
@@ -1624,7 +1708,7 @@ public interface DeviceManagementAdminService {
PasswordPolicyBeanWrapper passwordPolicyBeanWrapper);
@POST
- @Path("set-webclip")
+ @Path("/set-webclip")
@ApiOperation(
consumes = MediaType.APPLICATION_JSON,
httpMethod = "POST",
@@ -1632,13 +1716,10 @@ public interface DeviceManagementAdminService {
notes = "Set a web clip on Android devices. A web clip is used to add a bookmark to a web application.",
response = Activity.class,
tags = "Android Device Management Administrative Service",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(
- scope = "/device-mgt/devices/owning-device/operations/android/webclip",
- description = "Add Webclips") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:set-webclip")
+ })
}
)
@ApiResponses(value = {
diff --git a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceManagementService.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceManagementService.java
index 4bf71b564a..777c9582bc 100644
--- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceManagementService.java
+++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceManagementService.java
@@ -18,22 +18,14 @@
*/
package org.wso2.carbon.mdm.services.android.services;
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-import io.swagger.annotations.Authorization;
-import io.swagger.annotations.AuthorizationScope;
-import io.swagger.annotations.Extension;
-import io.swagger.annotations.ExtensionProperty;
-import io.swagger.annotations.Info;
-import io.swagger.annotations.ResponseHeader;
-import io.swagger.annotations.SwaggerDefinition;
-import io.swagger.annotations.Tag;
+import io.swagger.annotations.*;
+
+import org.wso2.carbon.apimgt.annotations.api.Scope;
+import org.wso2.carbon.apimgt.annotations.api.Scopes;
import org.wso2.carbon.device.mgt.common.operation.mgt.Operation;
import org.wso2.carbon.mdm.services.android.bean.wrapper.AndroidApplication;
import org.wso2.carbon.mdm.services.android.bean.wrapper.AndroidDevice;
+import org.wso2.carbon.mdm.services.android.util.AndroidConstants;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
@@ -72,6 +64,22 @@ import java.util.List;
@Path("/devices")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
+@Scopes(
+ scopes = {
+ @Scope(
+ name = "Enroll Device",
+ description = "Register an Android device",
+ key = "cdmf:android:enroll",
+ permissions = {"/device-mgt/devices/enroll/android"}
+ ),
+ @Scope(
+ name = "Un-enroll Device",
+ description = "Unregister an Android device",
+ key = "cdmf:android:disenroll",
+ permissions = {"/device-mgt/devices/disenroll/android"}
+ )
+ }
+)
public interface DeviceManagementService {
@PUT
@@ -83,12 +91,10 @@ public interface DeviceManagementService {
value = "Updating the Application Details on Android Devices",
notes = "Update the details of the applications that are installed on Android devices.",
tags = "Android Device Management",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/devices/enroll/android",
- description = "Enroll Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:enroll")
+ })
}
)
@ApiResponses(value = {
@@ -150,12 +156,10 @@ public interface DeviceManagementService {
"The server then updates the status of the operations that were carried out on the device.",
response = Operation.class,
tags = "Android Device Management",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/devices/enroll/android",
- description = "Enroll Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:enroll")
+ })
}
)
@ApiResponses(value = {
@@ -216,12 +220,10 @@ public interface DeviceManagementService {
" you can use this REST API to register an Android device with WSO2 EMM, without having to install" +
" an Android Agent. This API can be mainly used to test the device enrollment process.",
tags = "Android Device Management",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/devices/enroll/android",
- description = "Enroll Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:enroll")
+ })
}
)
@ApiResponses(value = {
@@ -273,12 +275,10 @@ public interface DeviceManagementService {
value = "Getting the Registration Status of an Android Device",
notes = "Use this REST API to retrieve the registration status of an Android device.",
tags = "Android Device Management",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/devices/enroll/android",
- description = "Enroll Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:enroll")
+ })
}
)
@ApiResponses(value = {
@@ -328,12 +328,10 @@ public interface DeviceManagementService {
value = "Updating the Registration Details of an Android Device",
notes = "Use this REST API to update the registration details of an Android device.",
tags = "Android Device Management",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/devices/enroll/android",
- description = "Enroll Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:enroll")
+ })
}
)
@ApiResponses(
@@ -386,11 +384,10 @@ public interface DeviceManagementService {
value = "Unregistering an Android Device",
notes = "Use this REST API to unregister an Android device.",
tags = "Android Device Management",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/devices/disenroll/android", description = "Disenroll Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:disenroll")
+ })
}
)
@ApiResponses(value = {
diff --git a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceTypeConfigurationService.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceTypeConfigurationService.java
index 3eab30e353..09a731df4d 100644
--- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceTypeConfigurationService.java
+++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceTypeConfigurationService.java
@@ -24,16 +24,17 @@ import io.swagger.annotations.ExtensionProperty;
import io.swagger.annotations.Extension;
import io.swagger.annotations.Tag;
import io.swagger.annotations.Api;
-import io.swagger.annotations.AuthorizationScope;
-import io.swagger.annotations.Authorization;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import io.swagger.annotations.ResponseHeader;
+import org.wso2.carbon.apimgt.annotations.api.Scope;
+import org.wso2.carbon.apimgt.annotations.api.Scopes;
import org.wso2.carbon.device.mgt.common.configuration.mgt.PlatformConfiguration;
import org.wso2.carbon.mdm.services.android.bean.AndroidPlatformConfiguration;
import org.wso2.carbon.mdm.services.android.exception.AndroidAgentException;
+import org.wso2.carbon.mdm.services.android.util.AndroidConstants;
import javax.validation.Valid;
import javax.ws.rs.*;
@@ -61,6 +62,28 @@ import javax.ws.rs.core.Response;
@Path("/configuration")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
+@Scopes(
+ scopes = {
+ @Scope(
+ name = "Enroll Device",
+ description = "Register an Android device",
+ key = "cdmf:android:enroll",
+ permissions = {"/device-mgt/devices/enroll/android"}
+ ),
+ @Scope(
+ name = "View Configurations",
+ description = "Getting Android Platform Configurations",
+ key = "cdmf:android:view-configuration",
+ permissions = {"/device-mgt/platform-configurations/view"}
+ ),
+ @Scope(
+ name = "Manage Configurations",
+ description = "Updating Android Platform Configurations",
+ key = "cdmf:android:manage-configuration",
+ permissions = {"/device-mgt/platform-configurations/manage"}
+ )
+ }
+)
public interface DeviceTypeConfigurationService {
@GET
@@ -71,12 +94,10 @@ public interface DeviceTypeConfigurationService {
notes = "Get the Android platform configuration details using this REST API.",
response = PlatformConfiguration.class,
tags = "Android Configuration Management",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/platform-configurations/view",
- description = "View Configurations") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:view-configuration")
+ })
}
)
@ApiResponses(value = {
@@ -127,12 +148,10 @@ public interface DeviceTypeConfigurationService {
value = "Updating Android Platform Configurations",
notes = "Update the Android platform configurations using this REST API.",
tags = "Android Configuration Management",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/platform-configurations/manage",
- description = "Manage Configurations") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:manage-configuration")
+ })
}
)
@ApiResponses(value = {
@@ -184,12 +203,10 @@ public interface DeviceTypeConfigurationService {
"registration process.",
response = String.class,
tags = "Android Configuration Management",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/devices/enroll/android",
- description = "Enroll Device") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:enroll")
+ })
}
)
@ApiResponses(value = {
diff --git a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/EventReceiverService.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/EventReceiverService.java
index 744655768d..89e8dd44c9 100644
--- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/EventReceiverService.java
+++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/EventReceiverService.java
@@ -24,15 +24,16 @@ import io.swagger.annotations.ExtensionProperty;
import io.swagger.annotations.Extension;
import io.swagger.annotations.Tag;
import io.swagger.annotations.Api;
-import io.swagger.annotations.AuthorizationScope;
-import io.swagger.annotations.Authorization;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import io.swagger.annotations.ResponseHeader;
+import org.wso2.carbon.apimgt.annotations.api.Scope;
+import org.wso2.carbon.apimgt.annotations.api.Scopes;
import org.wso2.carbon.mdm.services.android.bean.DeviceState;
import org.wso2.carbon.mdm.services.android.bean.wrapper.EventBeanWrapper;
+import org.wso2.carbon.mdm.services.android.util.AndroidConstants;
import javax.validation.Valid;
import javax.validation.constraints.Size;
@@ -61,6 +62,16 @@ import javax.ws.rs.core.Response;
@Path("/events")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
+@Scopes(
+ scopes = {
+ @Scope(
+ name = "Enroll Device",
+ description = "Register an Android device",
+ key = "cdmf:android:enroll",
+ permissions = {"/device-mgt/devices/enroll/android"}
+ )
+ }
+)
public interface EventReceiverService {
@POST
@@ -72,12 +83,10 @@ public interface EventReceiverService {
value = "Publishing Events",
notes = "Publish events received by the WSO2 EMM Android client to the WSO2 Data Analytics Server (DAS) using this API.",
tags = "Event Receiver",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/devices/enroll/android",
- description = "Publish Events to DAS") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:enroll")
+ })
}
)
@ApiResponses(
@@ -137,12 +146,10 @@ public interface EventReceiverService {
response = DeviceState.class,
responseContainer = "List",
tags = "Event Receiver",
- authorizations = {
- @Authorization(
- value="permission",
- scopes = { @AuthorizationScope(scope = "/device-mgt/devices/enroll/android",
- description = "Publish Events to DAS") }
- )
+ extensions = {
+ @Extension(properties = {
+ @ExtensionProperty(name = AndroidConstants.SCOPE, value = "cdmf:android:enroll")
+ })
}
)
@ApiResponses(
diff --git a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/util/AndroidConstants.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/util/AndroidConstants.java
index 62ed8afe05..c1e09b4c06 100644
--- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/util/AndroidConstants.java
+++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/util/AndroidConstants.java
@@ -26,6 +26,7 @@ public final class AndroidConstants {
public static final String DEVICE_TYPE_ANDROID = "android";
public static final String HEADER_CONTENT_TYPE = "Content-Type";
public static final String APPLICATION_JSON = "application/json";
+ public static final String SCOPE = "scope";
public final class DeviceProperties {
private DeviceProperties() {