BWSService (BlackBerry Web Services for Enterprise Administration 12.0.0 API Reference)

Object
- BWSService

@Service
public class BWSService
extends Object

BlackBerry Web Services

Constructor Summary

Constructors
Constructor and Description

BWSService()

BWSService(ControllerPostConstruct controllerPostConstruct, ITenantRepository tenantRepository)

Constructors
Constructor and Description
`BWSService()`
`BWSService(ControllerPostConstruct controllerPostConstruct, ITenantRepository tenantRepository)`

Method Summary

Methods
Modifier and Type	Method and Description
`AssignEmailProfilesToUserResponse`	`assignEmailProfilesToUser(AssignEmailProfilesToUserRequest request)` Assign an email profile to a user and define email settings for the user.
`AssignGroupsToGroupResponse`	`assignGroupsToGroup(AssignGroupsToGroupRequest request)` Assign groups to a group.
`AssignSWConfigsToGroupResponse`	`assignSWConfigsToGroup(AssignSWConfigsToGroupRequest request)` Assign one or more software configurations to a group.
`AssignSWConfigsToUserResponse`	`assignSWConfigsToUser(AssignSWConfigsToUserRequest request)` Assign one or more software configurations to a user.
`AssignUsersToGroupResponse`	`assignUsersToGroup(AssignUsersToGroupRequest request)` Assign users to a group.
`AssignVPNConfigsToGroupResponse`	`assignVPNConfigsToGroup(AssignVPNConfigsToGroupRequest request)` Assign one or more VPN profiles to a group.
`AssignWLANConfigsToGroupResponse`	`assignWLANConfigsToGroup(AssignWLANConfigsToGroupRequest request)` Assign one or more Wi-Fi profiles to a group.
`ClearGroupsITPolicyResponse`	`clearGroupsITPolicy(ClearGroupsITPolicyRequest request)` Remove the IT policy for one or more groups.
`ClearUsersITPolicyResponse`	`clearUsersITPolicy(ClearUsersITPolicyRequest request)` Remove the IT policy for one or more users.
`CreateGroupsResponse`	`createGroups(CreateGroupsRequest request)` Create one or more groups.
`CreateUserEmailProfilesResponse`	`createUserEmailProfiles(CreateUserEmailProfilesRequest request)` Assign an email profile to a user and define email settings for the user.
`CreateUsersResponse`	`createUsers(CreateUsersRequest request)` Create one or more users.
`DeleteGroupsResponse`	`deleteGroups(DeleteGroupsRequest request)` Delete one or more groups.
`DeleteUserEmailProfilesResponse`	`deleteUserEmailProfiles(DeleteUserEmailProfilesRequest request)` Remove one or more email profiles from a user.
`DeleteUsersResponse`	`deleteUsers(DeleteUsersRequest request)` Delete one or more users.
`DeleteUsersEmailStatsResponse`	`deleteUsersEmailStats(DeleteUsersEmailStatsRequest request)`
`EchoResponse`	`echo(EchoRequest request)` Test connectivity and authentication with the administration service.
`GetBESHAPoolsResponse`	`getBESHAPools(GetBESHAPoolsRequest request)` Look up BES high availability (HA) pools.
`GetCapabilityDefinitionsResponse`	`getCapabilityDefinitions(GetCapabilityDefinitionsRequest request)`
`GetDeviceOSBundlesResponse`	`getDeviceOSBundles(GetDeviceOSBundlesRequest request)`
`GetDevicesDetailResponse`	`getDevicesDetail(GetDevicesDetailRequest request)` Retrieve detailed information for one or more devices.
`GetEmailProfilesResponse`	`getEmailProfiles(GetEmailProfilesRequest request)` Look up email profiles that are available.
`GetGroupsResponse`	`getGroups(GetGroupsRequest request)` Look up groups.
`GetGroupsDetailResponse`	`getGroupsDetail(GetGroupsDetailRequest request)` Retrieve detailed information about groups, including parent and child groups, users that are members, and the configuration settings that are assigned to the groups.
`GetITPoliciesResponse`	`getITPolicies(GetITPoliciesRequest request)` Look up IT policies that are available.
`GetMailStoreUsersResponse`	`getMailStoreUsers(GetMailStoreUsersRequest request)` Search for users in your organization's external user directory.
`GetPolicyRuleDefinitionsResponse`	`getPolicyRuleDefinitions(GetPolicyRuleDefinitionsRequest request)`
`GetReportDataResponse`	`getReportData(GetReportDataRequest request)`
`GetRolesResponse`	`getRoles(GetRolesRequest request)` Look up the administrative roles that are available in the administration service.
`GetRolesDetailResponse`	`getRolesDetail(GetRolesDetailRequest request)` Retrieve detailed information about the administrative roles that are available in the administration service, including permissions data.
`GetServersResponse`	`getServers(GetServersRequest request)` Look up server instances.
`GetServersDetailResponse`	`getServersDetail(GetServersDetailRequest request)` Retrieve detailed information about the server instances, including the host name, status, and services.
`GetSWConfigApplicationsResponse`	`getSWConfigApplications(GetSWConfigApplicationsRequest request)` Search for applications that administrators have made available to distribute to devices.
`GetSWConfigsResponse`	`getSWConfigs(GetSWConfigsRequest request)` Look up the software configurations that are available.
`GetSystemInfoResponse`	`getSystemInfo(GetSystemInfoRequest request)` Retrieve property information, for example, the version of the BlackBerry Web Services, the version of the server software, or the UID of the currently authenticated user.
`GetUserActivationsResponse`	`getUserActivations(GetUserActivationsRequest request)` Search for information about device activations.
`GetUsersResponse`	`getUsers(GetUsersRequest request)` Search for users.
`GetUsersDetailResponse`	`getUsersDetail(GetUsersDetailRequest request)` Retrieve detailed information about users including email accounts, groups, administrative roles, device information, and configuration settings.
`GetUsersReconciledApplicationsResponse`	`getUsersReconciledApplications(GetUsersReconciledApplicationsRequest request)`
`GetVPNConfigsResponse`	`getVPNConfigs(GetVPNConfigsRequest request)` Look up VPN profiles that are available.
`GetWLANConfigsResponse`	`getWLANConfigs(GetWLANConfigsRequest request)` Look up Wi-Fi profiles that are available.
`SetDevicesEmailRedirectionResponse`	`setDevicesEmailRedirection(SetDevicesEmailRedirectionRequest request)`
`SetDevicesLockResponse`	`setDevicesLock(SetDevicesLockRequest request)` Lock one or more devices.
`SetDevicesOwnerInfoResponse`	`setDevicesOwnerInfo(SetDevicesOwnerInfoRequest request)`
`SetDevicesPasswordResponse`	`setDevicesPassword(SetDevicesPasswordRequest request)` Lock and set a new password for one or more devices.
`SetDevicesSyncCalendarResponse`	`setDevicesSyncCalendar(SetDevicesSyncCalendarRequest request)`
`SetDevicesWipeResponse`	`setDevicesWipe(SetDevicesWipeRequest request)` Delete all device data, or work data only, from one or more devices.
`SetDevicesWorkSpaceStateResponse`	`setDevicesWorkSpaceState(SetDevicesWorkSpaceStateRequest request)` Set the work space state for one or more devices.
`SetGroupsITPolicyResponse`	`setGroupsITPolicy(SetGroupsITPolicyRequest request)` Assign an IT policies to, or remove an IT policy from, one or more groups.
`SetGroupsSendMessageResponse`	`setGroupsSendMessage(SetGroupsSendMessageRequest request)`
`SetUsersActivationPasswordResponse`	`setUsersActivationPassword(SetUsersActivationPasswordRequest request)` Set or clear the activation password for one or more users.
`SetUsersAutoSignatureResponse`	`setUsersAutoSignature(SetUsersAutoSignatureRequest request)`
`SetUsersEmailFilterRulesResponse`	`setUsersEmailFilterRules(SetUsersEmailFilterRulesRequest request)`
`SetUsersFolderRedirectionResponse`	`setUsersFolderRedirection(SetUsersFolderRedirectionRequest request)`
`SetUsersITPolicyResponse`	`setUsersITPolicy(SetUsersITPolicyRequest request)` Assign an IT policies to, or remove an IT policy from, one or more users.
`SetUsersPIMSyncConfigsResponse`	`setUsersPIMSyncConfigs(SetUsersPIMSyncConfigsRequest request)`
`SetUsersResendITPolicyResponse`	`setUsersResendITPolicy(SetUsersResendITPolicyRequest request)` Resend an IT policies to one or more users.
`SetUsersResendReconciledApplicationsResponse`	`setUsersResendReconciledApplications(SetUsersResendReconciledApplicationsRequest request)`
`SetUsersResendServiceBooksResponse`	`setUsersResendServiceBooks(SetUsersResendServiceBooksRequest request)`
`SetUsersSendMessageResponse`	`setUsersSendMessage(SetUsersSendMessageRequest request)`
`SetUsersServerResponse`	`setUsersServer(SetUsersServerRequest request)` Associate one or more users with a different server.
`UnassignEmailProfilesFromUserResponse`	`unassignEmailProfilesFromUser(UnassignEmailProfilesFromUserRequest request)` Remove one or more email profiles from a user.
`UnassignGroupsFromGroupResponse`	`unassignGroupsFromGroup(UnassignGroupsFromGroupRequest request)` Remove one or more groups from a group.
`UnassignSWConfigsFromGroupResponse`	`unassignSWConfigsFromGroup(UnassignSWConfigsFromGroupRequest request)` Remove one or more software configurations from a group.
`UnassignSWConfigsFromUserResponse`	`unassignSWConfigsFromUser(UnassignSWConfigsFromUserRequest request)` Remove one or more software configurations from a user.
`UnassignUsersFromGroupResponse`	`unassignUsersFromGroup(UnassignUsersFromGroupRequest request)` Remove one or more users from a group.
`UnassignVPNConfigsFromGroupResponse`	`unassignVPNConfigsFromGroup(UnassignVPNConfigsFromGroupRequest request)` Remove one or more VPN profiles from a group.
`UnassignWLANConfigsFromGroupResponse`	`unassignWLANConfigsFromGroup(UnassignWLANConfigsFromGroupRequest request)` Remove one or more Wi-Fi profiles from a group.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BWSService
```
public BWSService()
```
  - BWSService
```
public BWSService(ControllerPostConstruct controllerPostConstruct,
          ITenantRepository tenantRepository)
```
- Method Detail
  - assignEmailProfilesToUser
```
public AssignEmailProfilesToUserResponse assignEmailProfilesToUser(AssignEmailProfilesToUserRequest request)
```
    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.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    newUserEmailProfiles - List of new user email profiles to be created.
    
    Response:
    
    Contains the overall return status of a request to assign an email profile to a user and define email settings for the user, and lists the response for each email profile. Email profiles specify how devices connect to your organization's messaging server and synchronize email messages and organizer data.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - The user cannot be found.
    EMAIL_PROFILE_NOT_FOUND - Email profile cannot be found.
    EMAIL_PROFILE_ALREADY_ASSIGNED_TO_USER - User already has this exact or this type of email profile, or cannot assign additional email profiles.
    CANNOT_ASSIGN_EMAIL_PROFILE_TO_USER - The email profile could not be assigned to the user.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. Email profiles get queued to be delivered to the devices. The assignment to the user is immediate.
  - assignGroupsToGroup
```
public AssignGroupsToGroupResponse assignGroupsToGroup(AssignGroupsToGroupRequest request)
```
    Assign groups to a group.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    groups - List of groups to be assigned to the group.
    group - Group to assign the groups to.
    
    Response:
    
    Contains the overall return status of a request to assign one or more groups to a group, and lists the response for each group.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - The group cannot be found.
    GROUP_ALREADY_EXISTS_IN_GROUP - The group is already assigned to this group.
    CANNOT_ASSIGN_GROUP_TO_GROUP - The group cannot be assigned to group.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The group settings get queued to be delivered to the devices. The assignment to the group is immediate.
  - assignSWConfigsToGroup
```
public AssignSWConfigsToGroupResponse assignSWConfigsToGroup(AssignSWConfigsToGroupRequest request)
```
    Assign one or more software configurations to a group. Software configurations are used to install, remove, and manage applications on devices.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    swConfigs - List of software configurations to assign to the group.
    group - Group which will be assigned the software configurations.
    applicationDisposition - ApplicationDisposition that will be assigned to the applications.
    
    Response:
    
    Contains the overall return status of a request to assign one or more software configurations to a group, and lists the response for each software configuration. Software configurations are used to install, remove, and manage applications on devices.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - Group cannot be found.
    SWCONFIG_NOT_FOUND - Software configuration cannot be found.
    GROUP_ALREADY_HAS_SWCONFIG - Software configuration has already been assigned to the group.
    CANNOT_ASSIGN_SWCONFIG_TO_GROUP - An error occurred, the software configuration couldn't be assigned.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The SW configs get queued to be delivered to the devices. The assignment to the group is immediate.
  - assignSWConfigsToUser
```
public AssignSWConfigsToUserResponse assignSWConfigsToUser(AssignSWConfigsToUserRequest request)
```
    Assign one or more software configurations to a user. Software configurations are used to install, remove, and manage applications on devices.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    swConfigs - List of software configurations to assign to the group.
    user - User who will be assigned the software configurations.
    applicationDisposition - ApplicationDisposition that will be assigned to the applications.
    
    Response:
    
    Contains the overall return status of a request to assign one or more software configurations to a user, and lists the response for each software configuration. Software configurations are used to install, remove, and manage applications on devices.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - User cannot be found.
    SWCONFIG_NOT_FOUND - Software configuration cannot be found.
    USER_ALREADY_HAS_SWCONFIG - Software configuration has already been assigned to the user.
    CANNOT_ASSIGN_SWCONFIG_TO_USER - An error occurred, the software configuration couldn't be assigned.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The SW configs get queued to be delivered to the devices.
  - assignUsersToGroup
```
public AssignUsersToGroupResponse assignUsersToGroup(AssignUsersToGroupRequest request)
```
    Assign users to a group.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    users - List of users to be assigned to the group.
    group - Group to assign the users to.
    
    Response:
    
    Contains the overall return status of a request to assign one or more users to a group, and lists the response for each user.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - The user cannot be found.
    GROUP_NOT_FOUND - The group cannot be found.
    USER_ALREADY_EXISTS_IN_GROUP - The user is already assigned to this group.
    CANNOT_ASSIGN_USER_TO_GROUP - The user cannot be assigned to group.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The group settings get queued to be delivered to the devices. The assignment to the group is immediate
  - assignVPNConfigsToGroup
```
public AssignVPNConfigsToGroupResponse assignVPNConfigsToGroup(AssignVPNConfigsToGroupRequest request)
```
    Assign one or more VPN profiles to a group. VPN profiles enable VPN connections for applications on devices.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    vpnConfigs - List of VPN profiles to be assigned to the group.
    group - The group to assign the VPN profiles to.
    
    Response:
    
    Contains the overall return status of a request to assign one or more VPN profiles to a group, and lists the response for each VPN profile. VPN profiles enable VPN connections for applications on devices.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - Group cannot be found.
    VPN_CONFIG_NOT_FOUND - VPN profile cannot be found.
    CANNOT_ASSIGN_VPN_CONFIG_TO_GROUP - The VPN profile could not be assigned to the group.
    VPN_CONFIG_ALREADY_ASSIGNED_TO_GROUP - The VPN profile is already assigned to the group.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The VPN profiles get queued to be delivered to the devices. The assignment to the group is immediate.
  - assignWLANConfigsToGroup
```
public AssignWLANConfigsToGroupResponse assignWLANConfigsToGroup(AssignWLANConfigsToGroupRequest request)
```
    Assign one or more Wi-Fi profiles to a group. Wi-Fi profiles enable a connection between devices and an organization's Wi-Fi networks.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    wlanConfigs - List of Wi-Fi profiles to be assigned to the group.
    group - The group to assign the Wi-Fi profiles to.
    
    Response:
    
    Contains the overall return status of a request to assign one or more Wi-Fi profiles to a group, and lists the response for each Wi-Fi profile. Wi-Fi profiles enable a connection between devices and an organization's Wi-Fi networks.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - Group cannot be found.
    WLAN_CONFIG_NOT_FOUND - Wi-Fi profile cannot be found.
    CANNOT_ASSIGN_WLAN_CONFIG_TO_GROUP - The Wi-Fi profile could not be assigned to the group.
    WLAN_CONFIG_ALREADY_ASSIGNED_TO_GROUP - The Wi-Fi profile is already assigned to the group.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The Wi-Fi profiles get queued to be delivered to the devices. The assignment to the group is immediate.
  - clearGroupsITPolicy
```
public ClearGroupsITPolicyResponse clearGroupsITPolicy(ClearGroupsITPolicyRequest request)
```
    Remove the IT policy for one or more groups.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    groups - List of groups who will have their IT policy cleared.
    
    Response:
    
    Contains the overall return status of a request to remove an IT policy from a group, and lists the response for each group. IT policies are used to configure user permissions and security settings on devices.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - Group cannot be found.
    CANNOT_CLEAR_IT_POLICY - IT policy could not be cleared from the group.
    NO_IT_POLICY_TO_CLEAR - There is no IT policy assigned to the group to be cleared.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The IT policy gets queued to be removed from the devices. The unassignment from the group is immediate.
  - clearUsersITPolicy
```
public ClearUsersITPolicyResponse clearUsersITPolicy(ClearUsersITPolicyRequest request)
```
    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.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    users - List of users who will have their IT policy cleared.
    
    Response:
    
    Contains the overall return status of a request to remove an IT policy from a user, and lists the response for each user. IT policies are used to configure user permissions and security settings on devices.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - User cannot be found.
    CANNOT_CLEAR_IT_POLICY - IT policy could not be cleared from the user.
    NO_IT_POLICY_TO_CLEAR - There is no IT policy assigned to the user to be cleared.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The IT policy gets queued to be removed from the devices.
  - createGroups
```
public CreateGroupsResponse createGroups(CreateGroupsRequest request)
```
    Create one or more groups.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    newGroups - List of new Groups to be created.
    
    Response:
    
    Contains the overall return status of a request to create one or more groups, and lists the response for each group.
    
    Error codes specific to this API:
    
    GROUP_ALREADY_EXISTS - The group name already exists.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - createUserEmailProfiles
```
public CreateUserEmailProfilesResponse createUserEmailProfiles(CreateUserEmailProfilesRequest request)
```
    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.
    
    Deprecated:
    
    Use assignEmailProfilesToUser(AssignEmailProfilesToUserRequest)
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    newUserEmailProfiles - List of new user email profiles to be created.
    useADSettings - Not supported in a BlackBerry Enterprise Service 12 domain.
    
    Response:
    
    Contains the overall return status of a request to assign an email profile to a user and define email settings for the user, and lists the response for each email profile. Email profiles specify how devices connect to your organization's messaging server and synchronize email messages and organizer data.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - The user cannot be found.
    EMAIL_PROFILE_NOT_FOUND - Email profile cannot be found.
    CANNOT_CREATE_USER_EMAIL_PROFILE - User already has this exact or this type of email profile, or cannot assign additional email profiles.
    EMAIL_PROFILE_ALREADY_ASSIGNED_TO_USER - User already has this exact type of email profile
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. Email profiles get queued to be delivered to the devices. The assignment to the user is immediate.
  - createUsers
```
public CreateUsersResponse createUsers(CreateUsersRequest request)
```
    Create one or more users.
    Request:
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    newUsers - The list of new users to create. Can create standard device users or administrators. Visit docs.blackberry.com/BWSBES12 to see the BlackBerry Web Services Getting Started Guide for detailed information about how to configure newUsers to create different types of users.
    
    NewUser.activationTypeForNewAndReactivatedDevices - ignored, the user will be created with the default activation profile.
    
    NewUser.server - Not supported in a BlackBerry Enterprise Service 12 domain. It is recommended to set this to null.
    Response:
    
    Contains the overall return status of a request to create one or more users, and lists the response for each user.
    
    Error codes specific to this API:
    
    DIRECTORY_NOT_CONFIGURED - External directory is not configured.
    DIRECTORY_USER_NOT_FOUND - Directory user cannot be found.
    ROLE_NOT_FOUND - Role with the specified UID is not found.
    USER_CREATION_FAILED - Failed to create the user.
    USER_ALREADY_EXISTS - User already exists.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - deleteGroups
```
public DeleteGroupsResponse deleteGroups(DeleteGroupsRequest request)
```
    Delete one or more groups. Deleting a group does not delete the users that are members of the group.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    groups - List of groups to delete.
    
    Response:
    
    Contains the overall return status of a request to delete one or more groups, and lists the response for each group.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - Group cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The group settings get queued to be removed from the devices. The group removal is immediate.
  - deleteUserEmailProfiles
```
public DeleteUserEmailProfilesResponse deleteUserEmailProfiles(DeleteUserEmailProfilesRequest request)
```
    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.
    
    Deprecated:
    
    Use unassignEmailProfilesFromUser(UnassignEmailProfilesFromUserRequest)
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    individualRequests - Each individual request contains a User and list of UserEmailProfiles to delete for the user.
    
    Response:
    
    Contains the overall return status of a request to remove one or more email profiles from a user, and lists the response for each email profile. Email profiles specify how devices connect to your organization's messaging server and synchronize email messages and organizer data.
    
    Error codes specific to this API:
    
    USER_EMAIL_PROFILE_NOT_FOUND - User email profile cannot be found.
    USER_NOT_FOUND - User not found.
    EMAIL_PROFILE_NOT_ASSIGNED_TO_USER - The Email profile is not assigned to the user.
    CANNOT_UNASSIGN_EMAIL_PROFILE_FROM_USER - Cannot unassign email profile from user.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The email profiles get queued to be removed from the devices.
  - deleteUsers
```
public DeleteUsersResponse deleteUsers(DeleteUsersRequest request)
```
    Delete one or more users.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    users - List of users to delete.
    removeUserStateData - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    
    Response:
    
    Contains the overall return status of a request to delete one or more users, and lists the response for each user.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - The user cannot be found.
    INVALID_USER - The user data is not valid.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The device associations for the users are queued to be removed.
  - deleteUsersEmailStats
```
public DeleteUsersEmailStatsResponse deleteUsersEmailStats(DeleteUsersEmailStatsRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - echo
```
public EchoResponse echo(EchoRequest request)
```
    Test connectivity and authentication with the administration service. Pass a string that is returned in the results from the BlackBerry Web Services.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    text - String to echo.
    
    Response:
    
    Contains the echoed text of a request to test connectivity and authentication with the administration service.
    
    Error codes specific to this API:
    
    There are no error codes specific to this API.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getBESHAPools
```
public GetBESHAPoolsResponse getBESHAPools(GetBESHAPoolsRequest request)
```
    Look up BES high availability (HA) pools.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    name - Name of the BES HA pool to look up. Use empty string to get all pools.
    loadBESServices - Loads the BES services associated with the HA pool.
    loadFewerDetails - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    
    Response:
    
    Contains a collection of BES HA pools matching the look up.
    
    Error codes specific to this API:
    
    BESHAPOOL_NOT_FOUND - BES HA pool cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getCapabilityDefinitions
```
public GetCapabilityDefinitionsResponse getCapabilityDefinitions(GetCapabilityDefinitionsRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - getDeviceOSBundles
```
public GetDeviceOSBundlesResponse getDeviceOSBundles(GetDeviceOSBundlesRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - getDevicesDetail
```
public GetDevicesDetailResponse getDevicesDetail(GetDevicesDetailRequest request)
```
    Retrieve detailed information for one or more devices.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    devices - List of Devices to get detailed information for.
    loadServiceAttributes - Email service attributes (stats), etc.
    loadReconciledITPolicy - Load the reconciled IT
    
    Response:
    
    Contains the overall return status of a request to retrieve detailed information for one or more devices, and lists the response for each device.
    
    Error codes specific to this API:
    
    DEVICE_NOT_FOUND - The device cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getEmailProfiles
```
public GetEmailProfilesResponse getEmailProfiles(GetEmailProfilesRequest request)
```
    Look up email profiles that are available. Email profiles specify how devices connect to your organization's messaging server and synchronize email messages and organizer data.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    name - Name of the email profile to look up. Use empty string to get all email profiles.
    
    Response:
    
    Contains the look up results for email profiles. Email profiles specify how devices connect to your organization's messaging server and synchronize email messages and organizer data.
    
    Error codes specific to this API:
    
    EMAIL_PROFILE_NOT_FOUND - Email profile cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getGroupsDetail
```
public GetGroupsDetailResponse getGroupsDetail(GetGroupsDetailRequest request)
```
    Retrieve detailed information about groups, including parent and child groups, users that are members, and the configuration settings that are assigned to the groups.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    groups - Groups to retrieve detailed information for.
    loadParentGroups - Load direct parent groups that the groups belong to.
    loadChildGroups - Load direct child groups that the groups contain.
    loadUsers - Load Users assigned directly to the groups.
    loadITPolicies - Load IT policies assigned to the groups.
    loadRoles - Load Role information for the groups.
    loadSWConfigs - Load software configurations assigned to the groups.
    loadVPNConfigs - Load VPN profiles assigned to the groups.
    loadWLANConfigs - Load Wi-Fi profiles assigned to the groups.
    loadEmailProfiles - Load Email Profiles assigned directly to the groups.
    
    Response:
    
    Contains the retrieved results for detailed information about groups, and lists the response for each group.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - The group cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getGroups
```
public GetGroupsResponse getGroups(GetGroupsRequest request)
```
    Look up groups.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    name - Name of the group to look up. Use empty string to get all groups.
    
    Response:
    
    Contains the look up results for groups.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - The group cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getITPolicies
```
public GetITPoliciesResponse getITPolicies(GetITPoliciesRequest request)
```
    Look up IT policies that are available.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    name - Name of the IT policy to lookup. Use empty string to get all IT policies.
    
    Response:
    
    Contains a collection of IT policies matching the lookup.
    
    Error codes specific to this API:
    
    IT_POLICY_NOT_FOUND - IT policy cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getMailStoreUsers
```
public GetMailStoreUsersResponse getMailStoreUsers(GetMailStoreUsersRequest request)
```
    Search for users in your organization's external user directory.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    searchCriteria - Search criteria.
    sortBy - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    sortAscending - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    lastMailStoreUserEmailAddress - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    pageSize - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    
    Response:
    
    Contains the overall return status and results of a request to search for users in your organization’s external user directory.
    
    Error codes specific to this API:
    
    INVALID_SORTBY_PARAMETER - The SortBy parameter is invalid.
    MAXIMUM_MAIL_STORE_USER_RESULTS - Cannot return results because the maximum number of results has been reached or exceeded. Refine the search criteria to return fewer results.
    DIRECTORY_NOT_CONFIGURED - External directory is not configured.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getPolicyRuleDefinitions
```
public GetPolicyRuleDefinitionsResponse getPolicyRuleDefinitions(GetPolicyRuleDefinitionsRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - getReportData
```
public GetReportDataResponse getReportData(GetReportDataRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - getRolesDetail
```
public GetRolesDetailResponse getRolesDetail(GetRolesDetailRequest request)
```
    Retrieve detailed information about the administrative roles that are available in the administration service, including permissions data. Administrative roles are assigned to administrator accounts to control what the user can do in the administration service.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    roles - List of roles to get detailed information for.
    
    Response:
    
    Contains the overall return status of a request to retrieve detailed information about administrative roles, and lists the response for each role.
    
    Error codes specific to this API:
    
    ROLE_NOT_FOUND - Role cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getRoles
```
public GetRolesResponse getRoles(GetRolesRequest request)
```
    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.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    name - Name of a specific role to look up. Use empty string to get all roles.
    
    Response:
    
    Contains the overall return status of a request to look up administrative roles, and lists the response for each role.
    
    Error codes specific to this API:
    
    ROLE_NOT_FOUND - Role with the given name cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getServers
```
public GetServersResponse getServers(GetServersRequest request)
```
    Look up server instances.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    hostName - Host name of the server to look up. Use an empty string to return all servers.
    
    Response:
    
    Contains the look up results for server instances.
    
    Error codes specific to this API:
    
    SERVER_NOT_FOUND - Server cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getServersDetail
```
public GetServersDetailResponse getServersDetail(GetServersDetailRequest request)
```
    Retrieve detailed information about the server instances, including the host name, status, and services.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    servers - List of servers to get detailed information for.
    
    Response:
    
    Contains the overall return status of a request to retrieve detailed information about server instances, and lists the response for each server.
    
    Error codes specific to this API:
    
    SERVER_NOT_FOUND - Server cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getSWConfigApplications
```
public GetSWConfigApplicationsResponse getSWConfigApplications(GetSWConfigApplicationsRequest request)
```
    Search for applications that administrators have made available to distribute to devices. Administrators distribute these applications to devices by adding the applications to software configurations.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    searchCriteria - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    sortBy - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    sortAscending - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    lastApplicationUid - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    pageSize - Number of applications to return on the current page. A page size less than or equal to zero will return the maximum allowed number of applications on a single page.
    loadApplicationPackageIdentifier - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    
    Response:
    
    Contains the search results for applications that are available in the administration console. Administrators distribute these applications to devices by adding the applications to software configurations.
    
    Error codes specific to this API:
    
    There are no error codes specific to this API.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getSWConfigs
```
public GetSWConfigsResponse getSWConfigs(GetSWConfigsRequest request)
```
    Look up the software configurations that are available. Software configurations are used to install, remove, and manage applications on devices.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    name - Name of the software configuration to search for. Use empty string to get all software configurations.
    loadApplicationSettings - Load the Application Settings information into the software configuration.
    loadDeviceSettings - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    
    Response:
    
    Contains the look up results for software configurations. Software configurations are used to install, remove, and manage applications on devices.
    
    Error codes specific to this API:
    
    SWCONFIG_NOT_FOUND - Specific SWConfig cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getSystemInfo
```
public GetSystemInfoResponse getSystemInfo(GetSystemInfoRequest request)
```
    Retrieve property information, for example, the version of the BlackBerry Web Services, the version of the server software, or the UID of the currently authenticated user.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    loadAuthenticatedUserProperties - When true, load the authenticated user properties in the getSystemInfoResponse object.
    
    Response:
    
    Contains the results for property information, for example, the version of the BlackBerry Web Services, the version of the server software, or the UID of the currently authenticated user.
    
    Error codes specific to this API:
    
    There are no error codes specific to this API.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getUserActivations
```
public GetUserActivationsResponse getUserActivations(GetUserActivationsRequest request)
```
    Search for information about device activations.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    searchCriteria - Search criteria. Use an empty/null search criteria to return all user activations.
    sortBy - Response sort order.
    sortAscending - If true, sort results from lowest to highest.
    pageSize - Number of user activations to return on the current page. A page size less than or equal to zero will return the maximum allowed number of user activations on a single page.
    lastUserUid - UID of the last user on the previous page. Leave this null for the first page request.
    
    Response:
    
    Contains the search results for device activations.
    
    Error codes specific to this API:
    
    INVALID_SORTBY_PARAMETER - The SortBy parameter is invalid.
    LAST_USER_UID_NOT_FOUND - Last user cannot be found. The next page of results cannot be determined.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getUsersDetail
```
public GetUsersDetailResponse getUsersDetail(GetUsersDetailRequest request)
```
    Retrieve detailed information about users including email accounts, groups, administrative roles, device information, and configuration settings.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    users - List of Users, obtained by first calling getUsers.
    loadAccounts - Load mail accounts for the users.
    loadGroups - Load Groups of the users.
    loadRoles - Load Roles of the users.
    loadSWTokens - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    loadDevices - Load Devices assigned to the users.
    loadITPolicies - Load IT policies assigned to the users.
    loadSWConfigs - Load Software Configurations assigned to the users.
    loadVPNConfigs - Load VPN profiles assigned to the users.
    loadWLANConfigs - Load Wi-Fi profiles assigned to the users.
    loadUserEmailProfiles - Load user-specific email profiles for the users.
    
    Response:
    
    Contains the overall return status of a request to retrieve detailed information about users, and lists the response for each user.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - The user cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getUsers
```
public GetUsersResponse getUsers(GetUsersRequest request)
```
    Search for users.
    Request:
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    searchCriteria - Search criteria. Use an empty/null search criteria to return all users.
    
    deviceAndUserItPoliciesMatch - Not supported in a BlackBerry Enterprise Service 12 domain.
    
    deviceWirelessServicePlanTier - Not supported in a BlackBerry Enterprise Service 12 domain.
    
    deviceSupportedServicePlan - Not supported in a BlackBerry Enterprise Service 12 domain.
    
    mailServerName - if specified, SUCCESS will be returned with 0 results.
    
    restrictToBlackBerryEnabledUsers - if false, SUCCESS will be returned with 0 results; otherwise, the field will be ignored. 'BlackBerry enabled' means 'device enabled'. All users are device enabled in a BlackBerry Enterprise Service 12 domain.
    
    userPendingDeletion - if true, SUCCESS will be returned with 0 results; otherwise, the field will be ignored.
    
    sortBy - Response sort order.
    sortAscending - If true, sort results from lowest to highest.
    pageSize - Number of users to return on the current page. A page size less than or equal to zero will return the maximum allowed number of users on a single page.
    lastUserUid - UID of the last user on the previous page. Leave this null for the first page request.
    Response:
    
    Contains the search results for users.
    
    Error codes specific to this API:
    
    INVALID_SORTBY_PARAMETER - The SortBy parameter is invalid.
    LAST_USER_UID_NOT_FOUND - Last user cannot be found. The next page of results cannot be determined.
    PAGE_SIZE_TOO_LARGE - Cannot return results because the page size is too large. Specify a smaller page size.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getUsersReconciledApplications
```
public GetUsersReconciledApplicationsResponse getUsersReconciledApplications(GetUsersReconciledApplicationsRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - getVPNConfigs
```
public GetVPNConfigsResponse getVPNConfigs(GetVPNConfigsRequest request)
```
    Look up VPN profiles that are available.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    name - Name of the VPN profile to look up. Use empty string to return all VPN profiles.
    includePolicyRules - Flag to include policies rules.
    
    Response:
    
    Contains a collection of VPN profiles matching the lookup.
    
    Error codes specific to this API:
    
    VPN_CONFIG_NOT_FOUND - VPN profile cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - getWLANConfigs
```
public GetWLANConfigsResponse getWLANConfigs(GetWLANConfigsRequest request)
```
    Look up Wi-Fi profiles that are available.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    name - Name of the Wi-Fi profile to look up. Use empty string to return all Wi-Fi profiles.
    includePolicyRules - Flag to include policies rules.
    
    Response:
    
    Contains a collection of Wi-Fi profiles matching the lookup.
    
    Error codes specific to this API:
    
    WLAN_CONFIG_NOT_FOUND - Wi-Fi profilecannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Immediate.
  - setDevicesEmailRedirection
```
public SetDevicesEmailRedirectionResponse setDevicesEmailRedirection(SetDevicesEmailRedirectionRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - setDevicesLock
```
public SetDevicesLockResponse setDevicesLock(SetDevicesLockRequest request)
```
    Lock one or more devices.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    devices - List of devices to lock.
    lockWorkSpaceOnly - Flag to lock work space only.
    
    Response:
    
    Contains the overall return status and a list of IndividualResponse objects, listing successes and failures.
    
    Error codes specific to this API:
    
    DEVICE_NOT_FOUND - The device cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The lock settings get queued to the devices.
  - setDevicesOwnerInfo
```
public SetDevicesOwnerInfoResponse setDevicesOwnerInfo(SetDevicesOwnerInfoRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - setDevicesPassword
```
public SetDevicesPasswordResponse setDevicesPassword(SetDevicesPasswordRequest request)
```
    Lock and set a new password for one or more devices.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    devices - List of devices to set password for and lock.
    devicePassword - Password to be set on device or work space.
    clearDevicesPassword - Flag to clear the device password. Upon having the password cleared, the device will be unlocked.
    displayMessage - Optional message to be displayed on the screen upon setting the device password. Cannot be set when "setWorkSpacePasswordOnly" is set.
    setWorkSpacePasswordOnly - Flag to set work space password only for devices.
    
    Response:
    
    Contains the overall return status of a request to lock and set a new password for one or more devices, and lists the response for each device.
    
    Error codes specific to this API:
    
    DEVICE_NOT_FOUND - The device cannot be found.
    INVALID_PASSWORD - The password is invalid.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The password and lock settings get queued to the devices.
  - setDevicesSyncCalendar
```
public SetDevicesSyncCalendarResponse setDevicesSyncCalendar(SetDevicesSyncCalendarRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - setDevicesWipe
```
public SetDevicesWipeResponse setDevicesWipe(SetDevicesWipeRequest request)
```
    Delete all device data, or work data only, from one or more devices. You also have the option to remove devices without deleting any device data.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    devices - The devices to delete data from.
    organizationWipeOnly - Delete the work data only from a device.
    offboardingType - A legacy argument that's included to support backwards compatibility with earlier versions of BES. The value is currently ignored.
    forceDeleteDevice - Remove the device from the BlackBerry Enterprise Service 12 without deleting any device data. The 'organizationWipeOnly' parameter is ignored and 'offboardingType' must be 'NONE'.
    
    Response:
    
    Contains the overall return status of a request to delete all device data, or work data only, from one or more devices, and lists the response for each device.
    
    Error codes specific to this API:
    
    DEVICE_NOT_FOUND - Cannot find the device to be wiped.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The wipe command gets queued to the device if forceDeleteDevice is false. Otherwise, impact is immediate.
  - setDevicesWorkSpaceState
```
public SetDevicesWorkSpaceStateResponse setDevicesWorkSpaceState(SetDevicesWorkSpaceStateRequest request)
```
    Set the work space state for one or more devices.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    devices - List of devices to set work space state.
    state - The work space state to set on the devices.
    
    Response:
    
    Contains the overall return status of a request to set the work space state for one or more devices, and lists the response for each device.
    
    Error codes specific to this API:
    
    DEVICE_NOT_FOUND - The device cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The work space state setting gets queued to the devices.
  - setGroupsITPolicy
```
public SetGroupsITPolicyResponse setGroupsITPolicy(SetGroupsITPolicyRequest request)
```
    Assign an IT policies to, or remove an IT policy from, one or more groups. IT policies are used to configure user permissions and security settings on devices.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    groups - List of groups to set the IT policy for.
    itPolicy - IT policy to set the groups to.
    clearGroupsITPolicy - Flag to clear Groups IT policy.
    
    Response:
    
    Contains the overall return status of a request to assign an IT policies to one or more groups, or remove an IT policy from one or more groups, and lists the response for each IT policy.
    
    Error codes specific to this API:
    
    IT_POLICY_NOT_FOUND - IT policy cannot be found.
    GROUP_NOT_FOUND - Group cannot be found.
    IT_POLICY_ALREADY_ATTACHED_TO_GROUP - IT policy is already attached to the group.
    CANNOT_ATTACH_IT_POLICY_TO_GROUP - IT policy could not be attached to the group.
    CANNOT_CLEAR_IT_POLICY - IT policy could not be cleared from the group.
    NO_IT_POLICY_TO_CLEAR - There is no IT policy assigned to the group to be cleared.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The IT policy gets queued to be set for or cleared from the devices. The assignment to group is immediate.
  - setGroupsSendMessage
```
public SetGroupsSendMessageResponse setGroupsSendMessage(SetGroupsSendMessageRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - setUsersActivationPassword
```
public SetUsersActivationPasswordResponse setUsersActivationPassword(SetUsersActivationPasswordRequest request)
```
    Set or clear the activation password for one or more users. Optionally, you can send activation messages to users.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    users - List of users to set the activation password for.
    activationPassword - Enterprise activation password to set.
    expiryHours - The number of hours the password is valid for.
    generateAndEmailRandomPassword - To have an activation password generated and expiry time (default 48 hours) set, with an email sent to the user containing their activation password, set this to true (overrides activationPassword and expiryHours). "sendActivationMessageUsingMessageType" is disregarded when this is set.
    clearUsersActivationPassword - To clear users activation password, set to true. When this parameter is true, activation Password must have zero length. Also, expiryHours and generateAndEmailRandomPassword are disregarded.
    useExternalDirectoryAuthentication - Not supported in a BlackBerry Enterprise Service 12 domain.
    sendActivationMessageUsingMessageType - Send message(s) containing activation information to the users, using the given message type. When set, "generateAndEmailRandomPassword" and "clearUsersActivationPassword" must be false. To not have a message sent, do not set this field (leave it null). Message type of PIN is not supported in a BlackBerry Enterprise Service 12 domain.
    
    Response:
    
    Contains the overall return status of a request to set or clear the activation password for one or more users, and lists the response for each user.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - The user cannot be found.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The activation password gets queued to the devices. Email message sent to users.
  - setUsersAutoSignature
```
public SetUsersAutoSignatureResponse setUsersAutoSignature(SetUsersAutoSignatureRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - setUsersEmailFilterRules
```
public SetUsersEmailFilterRulesResponse setUsersEmailFilterRules(SetUsersEmailFilterRulesRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - setUsersFolderRedirection
```
public SetUsersFolderRedirectionResponse setUsersFolderRedirection(SetUsersFolderRedirectionRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - setUsersITPolicy
```
public SetUsersITPolicyResponse setUsersITPolicy(SetUsersITPolicyRequest request)
```
    Assign an IT policies to, 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.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    users - List of users to set the IT policy for.
    itPolicy - Instance of ITPolicy.
    clearUsersITPolicy - Flag to clear Users IT policy.
    
    Response:
    
    Contains the overall return status of a request to assign an IT policies to one or more users, or remove an IT policy from one or more users, and lists the response for each IT policy. IT policies are used to configure user permissions and security settings on devices.
    
    Error codes specific to this API:
    
    IT_POLICY_NOT_FOUND - The IT policy cannot be found.
    USER_NOT_FOUND - The user cannot be found.
    IT_POLICY_ALREADY_ATTACHED_TO_USER - The IT policy is already attached to the user.
    CANNOT_ATTACH_IT_POLICY_TO_USER - The IT policy could not be attached to the user.
    CANNOT_CLEAR_IT_POLICY - IT policy could not be cleared from the user.
    NO_IT_POLICY_TO_CLEAR - There is no IT policy assigned to the user to be cleared.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The IT policy gets queued to be delivered to the devices.
  - setUsersPIMSyncConfigs
```
public SetUsersPIMSyncConfigsResponse setUsersPIMSyncConfigs(SetUsersPIMSyncConfigsRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - setUsersResendITPolicy
```
public SetUsersResendITPolicyResponse setUsersResendITPolicy(SetUsersResendITPolicyRequest request)
```
    Resend an IT policies to one or more users.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    users - List of users to resend IT policy.
    
    Response:
    
    Contains the overall return status of a request to resend an IT policies to one or more users, and lists the response for each user.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - User cannot be found.
    CANNOT_RESEND_IT_POLICY_TO_USER - IT policy cannot be resent to user.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The IT policy gets queued to be delivered to the devices.
  - setUsersResendReconciledApplications
```
public SetUsersResendReconciledApplicationsResponse setUsersResendReconciledApplications(SetUsersResendReconciledApplicationsRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - setUsersResendServiceBooks
```
public SetUsersResendServiceBooksResponse setUsersResendServiceBooks(SetUsersResendServiceBooksRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - setUsersSendMessage
```
public SetUsersSendMessageResponse setUsersSendMessage(SetUsersSendMessageRequest request)
```
    BlackBerry Enterprise Service 12 domain does not support this functionality.
  - setUsersServer
```
public SetUsersServerResponse setUsersServer(SetUsersServerRequest request)
```
    Associate one or more users with a different server.
    
    Deprecated:
    
    In BlackBerry Enterprise Service 12 this method no longer completes the described operation. Instead, it validates the parameters and returns SUCCESS if the parameters are valid.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    users - The users to set the server for.
    server - The server which the users will be set to.
    
    Response:
    
    Contains the overall return status of a request to associate one or more users with a different server, and lists the response for each user.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - Cannot find the user to be moved.
    CANNOT_MOVE_USER - An error occurred, cannot move the user.
    SERVER_NOT_FOUND - Cannot find the server to move the user to.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The email profiles get queued to be removed from the devices.
  - unassignEmailProfilesFromUser
```
public UnassignEmailProfilesFromUserResponse unassignEmailProfilesFromUser(UnassignEmailProfilesFromUserRequest request)
```
    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.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    individualRequests - Each individual request contains a User and list of UserEmailProfiles to delete for the user.
    
    Response:
    
    Contains the overall return status of a request to remove one or more email profiles from a user, and lists the response for each email profile. Email profiles specify how devices connect to your organization's messaging server and synchronize email messages and organizer data.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - User not found.
    EMAIL_PROFILE_NOT_FOUND - Email profile cannot be found.
    CANNOT_UNASSIGN_EMAIL_PROFILE_FROM_USER - The email profile could not be unassigned from the user.
    EMAIL_PROFILE_NOT_ASSIGNED_TO_USER - The email profile is not assigned to the user.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The email profiles get queued to be removed from the devices.
  - unassignGroupsFromGroup
```
public UnassignGroupsFromGroupResponse unassignGroupsFromGroup(UnassignGroupsFromGroupRequest request)
```
    Remove one or more groups from a group.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    groups - List of groups to be unassigned from the group.
    group - Group to unassign the groups from.
    
    Response:
    
    Contains the overall return status of a request to remove one or more groups from a group, and lists the response for each group.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - The group cannot be found.
    GROUP_NOT_ASSIGNED_TO_GROUP - The group is not assigned to the group.
    CANNOT_UNASSIGN_GROUP_FROM_GROUP - The group cannot be unassigned from group.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The group settings get queued to be removed from the devices. The unassignment from the group is immediate.
  - unassignSWConfigsFromGroup
```
public UnassignSWConfigsFromGroupResponse unassignSWConfigsFromGroup(UnassignSWConfigsFromGroupRequest request)
```
    Remove one or more software configurations from a group.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    swConfigs - List of software configurations to unassign from the group.
    group - Group which will be unassigned the software configurations.
    
    Response:
    
    Contains the overall return status of a request to remove one or more software configurations from a group, and lists the response for each software configuration. Software configurations are used to install, remove, and manage applications on devices.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - Group cannot be found.
    SWCONFIG_NOT_FOUND - Software configuration cannot be found.
    SWCONFIG_NOT_ASSIGNED_TO_GROUP - The software configuration is not assigned to the group.
    CANNOT_UNASSIGN_SWCONFIG_FROM_GROUP - An error occurred, the software configuration couldn't be unassigned.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The SW configs get queued to be removed from the devices. The unassignment from the group is immediate.
  - unassignSWConfigsFromUser
```
public UnassignSWConfigsFromUserResponse unassignSWConfigsFromUser(UnassignSWConfigsFromUserRequest request)
```
    Remove one or more software configurations from a user.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    swConfigs - List of software configurations to unassign from the user.
    user - User who will be unassigned the software configurations.
    
    Response:
    
    Contains the overall return status of a request to remove one or more software configurations from a user, and lists the response for each software configuration. Software configurations are used to install, remove, and manage applications on devices.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - User cannot be found.
    SWCONFIG_NOT_FOUND - Software configuration cannot be found.
    SWCONFIG_NOT_ASSIGNED_TO_USER - The software configuration is not assigned to the user.
    CANNOT_UNASSIGN_SWCONFIG_FROM_USER - An error occurred, the software configuration couldn't be unassigned.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The SW configs get queued to be removed from the devices.
  - unassignUsersFromGroup
```
public UnassignUsersFromGroupResponse unassignUsersFromGroup(UnassignUsersFromGroupRequest request)
```
    Remove one or more users from a group.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    users - List of users to be unassigned from the group.
    group - Group to unassign the users from.
    
    Response:
    
    Contains the overall return status of a request to remove one or more users from a group, and lists the response for each user.
    
    Error codes specific to this API:
    
    USER_NOT_FOUND - The user cannot be found.
    GROUP_NOT_FOUND - The group cannot be found.
    USER_NOT_ASSIGNED_TO_GROUP - The user is not assigned to the group.
    CANNOT_UNASSIGN_USER_FROM_GROUP - The user cannot be unassigned from group.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The group settings get queued to be removed from the devices. The unassignment from the group is immediate.
  - unassignVPNConfigsFromGroup
```
public UnassignVPNConfigsFromGroupResponse unassignVPNConfigsFromGroup(UnassignVPNConfigsFromGroupRequest request)
```
    Remove one or more VPN profiles from a group.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    vpnConfigs - List of VPN profiles to be unassigned from the group.
    group - The group to unassign the VPN profiles from.
    
    Response:
    
    Contains the overall return status of a request to remove one or more VPN profiles from a group, and lists the response for each VPN profile. VPN profiles enable VPN connections for applications on devices.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - Group cannot be found.
    VPN_CONFIG_NOT_FOUND - VPN profile cannot be found.
    CANNOT_UNASSIGN_VPN_CONFIG_FROM_GROUP - The VPN profile could not be unassigned from the group.
    VPN_CONFIG_NOT_ASSIGNED_TO_GROUP - The VPN profile is not assigned to the group.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The VPN profiles get queued to be removed from the devices. The unassignment from the group is immediate.
  - unassignWLANConfigsFromGroup
```
public UnassignWLANConfigsFromGroupResponse unassignWLANConfigsFromGroup(UnassignWLANConfigsFromGroupRequest request)
```
    Remove one or more Wi-Fi profiles from a group.
    
    Request:
    
    metadata - Contains data that is used in various web services requests, such as locale information, client version, and organization UID.
    wlanConfigs - List of Wi-Fi profiles to be unassigned from the group.
    group - The group to unassign the Wi-Fi profiles from.
    
    Response:
    
    Contains the overall return status of a request to remove one or more Wi-Fi profiles from a group, and lists the response for each Wi-Fi profile. Wi-Fi profiles enable a connection between devices and an organization’s Wi-Fi networks.
    
    Error codes specific to this API:
    
    GROUP_NOT_FOUND - Group cannot be found.
    WLAN_CONFIG_NOT_FOUND - Wi-Fi profile cannot be found.
    CANNOT_UNASSIGN_WLAN_CONFIG_FROM_GROUP - The Wi-Fi profile could not be unassigned from the group.
    WLAN_CONFIG_NOT_ASSIGNED_TO_GROUP - The Wi-Fi profile is not assigned to the group.
    Error codes common to all APIs.
    
    Impact (immediate or queued):
    
    Queued. The Wi-Fi profiles get queued to be removed from the devices. The unassignment from the group is immediate.

Class BWSService

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

BWSService

BWSService

Method Detail

assignEmailProfilesToUser

assignGroupsToGroup

assignSWConfigsToGroup

assignSWConfigsToUser

assignUsersToGroup

assignVPNConfigsToGroup

assignWLANConfigsToGroup

clearGroupsITPolicy

clearUsersITPolicy

createGroups

createUserEmailProfiles

createUsers

deleteGroups

deleteUserEmailProfiles

deleteUsers

deleteUsersEmailStats

echo

getBESHAPools

getCapabilityDefinitions

getDeviceOSBundles

getDevicesDetail

getEmailProfiles

getGroupsDetail

getGroups

getITPolicies

getMailStoreUsers

getPolicyRuleDefinitions

getReportData

getRolesDetail

getRoles

getServers

getServersDetail

getSWConfigApplications

getSWConfigs

getSystemInfo

getUserActivations

getUsersDetail

getUsers

getUsersReconciledApplications

getVPNConfigs

getWLANConfigs

setDevicesEmailRedirection

setDevicesLock

setDevicesOwnerInfo

setDevicesPassword

setDevicesSyncCalendar

setDevicesWipe

setDevicesWorkSpaceState

setGroupsITPolicy

setGroupsSendMessage

setUsersActivationPassword

setUsersAutoSignature

setUsersEmailFilterRules

setUsersFolderRedirection

setUsersITPolicy

setUsersPIMSyncConfigs

setUsersResendITPolicy

setUsersResendReconciledApplications

setUsersResendServiceBooks

setUsersSendMessage

setUsersServer

unassignEmailProfilesFromUser

unassignGroupsFromGroup

unassignSWConfigsFromGroup

unassignSWConfigsFromUser

unassignUsersFromGroup

unassignVPNConfigsFromGroup

unassignWLANConfigsFromGroup