API Description BWS for BDS BWS for UDS
assignGroupsToGroup Assign one or more groups to another group in the
BlackBerry Enterprise Service 10 domain. √ assignSWConfigsToGroup Assign one or more software configurations to a
group in the domain. Software configurations are used to install, remove, and manage applications on devices.
√
7
API Description BWS for BDS BWS for UDS assignSWConfigsToUser Assign one or more software configurations to a
user. Software configurations are used to install, remove, and manage applications on devices.
√
assignUsersToGroup Assign users to a group in the domain. √ √
assignVPNConfigsToGroup Assign one or more VPN profiles to a group. VPN profiles enable VPN connections for applications on devices.
√
assignWLANConfigsToGroup Assign one or more Wi-Fi profiles to a group. Wi-Fi profiles enable a connection between devices and your organization’s Wi-Fi networks.
√
clearGroupsITPolicy Remove the IT policy for one or more groups in the domain. IT policies are used to configure user permissions and security settings on devices.
√
clearUsersITPolicy Remove the IT policy for one or more users. If you do not assign a different IT policy to the users, the administration service applies the Default IT policy.
IT policies are used to configure user permissions and security settings on devices.
√ √
createGroups Create one or more groups in the domain. √ √
createUserEmailProfiles Assign an email profile to a user and define email settings for the user. Email profiles specify how devices connect to your organization's messaging server and synchronize email messages and organizer data using Microsoft ActiveSync.
√
createUsers Create one or more users. √ √
deleteGroups Delete one or more groups from the domain.
Deleting a group does not delete the users that are members of the group.
√ √
deleteUserEmailProfiles Remove one or more email profiles from a user.
Email profiles specify how devices connect to your organization's messaging server and synchronize email messages and organizer data using Microsoft ActiveSync.
√
deleteUsers Delete one or more users from the domain. √ √
API Description BWS for BDS BWS for UDS echo Test connectivity and authentication with the
administration service. √ √
getBESHAPools Look up high availability pools in the domain. √ getCapabilityDefinitions Retrieve the permissions that are associated with
administrative roles. √
getDevicesDetail Retrieve detailed information for one or more
devices. √ √
getEmailProfiles Look up email profiles that are available in the administration service. Email profiles specify how devices connect to your organization's messaging server and synchronize email messages and organizer data using Microsoft ActiveSync.
√ √
getGroups Look up groups in the domain. √ √
getGroupsDetail Retrieve detailed information about groups in the domain, including parent and child groups, users that are members, and the configuration settings that are assigned to the groups.
√ √
getITPolicies Look up IT policies that are available in the domain.
IT policies are used to configure user permissions and security settings on devices.
√ √
getMailStoreUsers Search for users in your organization's external user
directory. √ √
getPolicyRuleDefinitions Retrieve information about the configuration of policy rules. Policies are used to configure user permissions and security settings on devices. IT policies, Wi-Fi profiles, and VPN profiles are all classified as policies.
√
getRoles Look up the administrative roles that are available in the administration service. Administrative roles are assigned to administrator accounts to control what the user can do in the administration service.
√
getRolesDetail Retrieve detailed information about the administrative roles that are available in the administration service, including permissions data.
√
API Description BWS for BDS BWS for UDS
getServers Look up server instances in the domain. √
getServersDetail Retrieve detailed information about the server instances in the domain, including the host name, status, and services.
√
getSWConfigApplications Search for applications that administrators have
made available to distribute to devices. √ getSWConfigs Look up the software configurations that are
available in the domain. Software configurations are used to install, remove, and manage applications on devices.
√
getSystemInfo Retrieve property information about the domain, such as the version of the BlackBerry Web Services, the version of the server software, or the UID of the currently authenticated user.
√ √
getUserActivations Search for information about device activations in
the domain. √
getUsers Search for users in the domain. √ √
getUsersDetail Retrieve detailed information about users in the domain, including email accounts, groups, administrative roles, device information, and configuration settings.
√ √
getUsersReconciledApplications Retrieve a list of the applications that are installed
on one or more users' devices. √
getVPNConfigs Look up VPN profiles that are available in the domain. VPN profiles enable VPN connections for applications on devices.
√
getWLANConfigs Look up Wi-Fi profiles that are available in the domain. Wi-Fi profiles enable a connection between devices and an organization’s Wi-Fi networks.
√
setDevicesLock Lock one or more iOS or Android devices. √
setDevicesOwnerInfo Set the owner information to display on one or more
devices. √
API Description BWS for BDS BWS for UDS setDevicesPassword Lock and set a new password for one or more
devices. √ √
setDevicesWipe Delete all device data, or work data only, from one or more devices. You also have the option to remove devices from the domain without deleting any device data.
√ √
setDevicesWorkSpaceState Set the state of the work space for one or more iOS
or Android devices. √
setGroupsITPolicy Assign an IT policy to one or more groups, or remove an IT policy from one or more groups. IT policies are used to configure user permissions and security settings on devices.
√
setUsersActivationPassword Set or clear the activation password for one or more
users. √ √
setUsersITPolicy Assign an IT policy to one or more users, or remove an IT policy from one or more users. IT policies are used to configure user permissions and security settings on devices. If you remove an IT policy and do not assign a different IT policy to a user, the administration service applies the Default IT policy.
√ √
setUsersResendITPolicy Resend an IT policy to one or more users. IT policies are used to configure user permissions and security settings on devices.
√
setUsersResendReconciledApplica
tions Resend applications to the devices of one or more
users. √
setUsersServer Associate one or more users with a different server
in the domain. √
unassignGroupsFromGroup Remove one or more groups from another group in
the domain. √
unassignSWConfigsFromGroup Remove one or more software configurations from a
group in the domain. √
unassignSWConfigsFromUser Remove one or more software configurations from a user. Software configurations are used to install, remove, and manage applications on devices.
√
API Description BWS for BDS BWS for UDS unassignUsersFromGroup Remove one or more users from a group in the
domain. √ √
unassignVPNConfigsFromGroup Remove one or more VPN profiles from a group.
VPN profiles enable VPN connections for applications on devices.
√
unassignWLANConfigsFromGroup Remove one or more Wi-Fi profiles from a group.
Wi-Fi profiles enable a connection between devices and an organization’s Wi-Fi networks.
√