Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry Web Services 12.10
  3. Blackberry Web Services Development Guide
  4. Using BlackBerry Web Services APIs
  5. Administrative roles required for using SOAP APIs

Administrative roles required for using SOAP APIs

An API request can only be completed if the application uses an administrator account with the required permissions. The following tables indicate which preconfigured roles have the permissions that are required for each API. These results have been tested and verified with 
BlackBerry UEM
.
For more information about permissions for preconfigured roles, see the BlackBerry UEM Administration Guide.

BWS interface

API
Security
Enterprise
Senior Helpdesk
Junior Helpdesk
Self service
User with no role
assignEmailProfilesToUser
√
√
assignGroupsToGroup
√
√
√
assignSWConfigsToGroup
√
√
√
assignSWConfigsToUser
√
√
√
assignUsersToGroup
√
√
√
assignVPNConfigsToGroup
√
√
√
assignWLANConfigsToGroup
√
√
√
clearGroupsITPolicy
√
√
√
clearUsersITPolicy
√
√
√
createGroups
√
√
√
createUserEmailProfiles
√
√
√
createUsers
 - create a user account
√
√
√
createUsers
 - create a user account with any available activation type
√
√
√
createUsers
 - create a local user account (not integrated with the user directory)
√
√
√
createUsers
 - create an administrator account
√
deleteGroups
√
√
deleteUserEmailProfiles
√
√
deleteUsers
√
√
√
echo
√
√
√
√
√
√
getBESHAPools
√
√
getDevicesDetail
√
√
√
√
getEmailProfiles
√
√
√
√
getGroups
√
√
√
√
getGroupsDetail
√
√
√
√
getGroupsDetail
 - verbose information
√
√
√
√
getITPolicies
√
√
√
√
getMailStoreUsers
√
√
√
√
getRoles
√
√
√
getRolesDetail
√
getServers
√
√
getServersDetail
√
√
getSWConfigApplications
√
√
√
√
getSWConfigs
√
√
√
√
getSystemInfo
√
√
√
√
√
√
getUserActivations
√
√
√
√
getUsers
√
√
√
√
getUsersDetail
√
√
√
√
getVPNConfigs
√
√
√
√
getWLANConfigs
√
√
√
√
setDevicesLock
√
√
√
√
setDevicesPassword
√
√
√
√
setDevicesWipe
√
√
√
√
setDevicesWorkSpaceState
√
√
√
√
setGroupsITPolicy
√
√
√
setUsersActivationPassword
√
√
√
√
setUsersITPolicy
√
√
√
setUsersResendITPolicy
√
√
√
√
setUsersServer
√
√
unassignEmailProfilesFromUSer
√
√
unassignSWConfigsFromGroup
√
√
√
unassignSWConfigsFromUser
√
√
√
unassignUsersFromGroup
√
√
√
unassignVPNConfigsFromGroup
√
√
√
unassignWLANConfigsFromGroup
√
√
√

BWSUtil interface

All requests in BWSUtil (
getAuthenticators()
, 
getEncodedUsername()
, and 
getLocales()
) are unauthenticated, so they do not require an administrative role or any administrative permissions.