BlackBerry UEM compatibility with the BlackBerry Dynamics SOAP APIs Skip Navigation

BlackBerry UEM
 compatibility with the 
BlackBerry Dynamics
 SOAP APIs

The 
BlackBerry Web Services
 SOAP APIs are still supported and released with every version of 
BlackBerry UEM
, but are officially in maintenance mode. See the BlackBerry Web Services 12.9 SOAP API reference for complete information about the supported legacy SOAP APIs.
If your organization uses the 
BlackBerry Web Services
 SOAP APIs, going forward 
BlackBerry
 recommends transitioning to the BlackBerry Web Services REST APIs. The REST APIs are updated with new functionality in every 
BlackBerry UEM
 release.
The following changes apply to the 
BlackBerry Dynamics
 SOAP APIs (GC SOAP and CAP SOAP) when you integrate 
BlackBerry UEM
 version 12.6 MR1 or later with a 
Good Control
 server:
  • All 
    BlackBerry Dynamics
     SOAP APIs that are not listed below have been removed, as equivalent functionality is provided by the 
    BlackBerry Web Services
     SOAP and REST APIs
  • All 
    BlackBerry Dynamics
     MDM REST APIs have been removed
  • BlackBerry Dynamics
     APIs are available on 
    BlackBerry UEM
     API port 18084 by default
  • Access the required wsdl's at the following URLs:
    • Good Control
       SOAP APIs: 
      https://
      <UEM_server_FQDN>
      :18084/gc/services/GCService.wsdl
    • CAP SOAP APIs:
      https://
      <UEM_server_FQDN>
      :18084/gc/soapproxy/cap.wsdl
  • For more information about making web services calls, see the Getting Started Guide for making Web Services calls.
  • Port 18084 uses a different SSL certificate than the one that the 
    Good Control
     server uses. API clients must trust the SSL certificate from 
    BlackBerry UEM
     API port 18084
  • Integrated mode does not support the 
    Good Control
     ‘policyset’. The 
    BlackBerry UEM
     policies replace that functionality. All 
    BlackBerry Dynamics
     APIs that managed the ‘policyset’ are impacted. Some are no longer supported and others cannot honor ‘policyset’ related input/output information.
  • Integrated mode maps the 
    Good Control
     ‘application group’ to the 
    BlackBerry UEM
     ‘user group’. All 
    BlackBerry Dynamics
     APIs that managed the ‘application group’ are impacted. Most APIs are supported but are implemented using the 
    BlackBerry UEM
     ‘user group’ and there are a few that are no longer supported.
  • APIs supported in integrated mode will not work with previously persisted entity Ids from a standalone 
    Good Control
     server, such as userId, groupId, and containerId.
For more information about the legacy 
BlackBerry Dynamics
 SOAP APIs, see the Good Control Documentation.

Supported 
Good Control
 SOAP APIs

API Name
Minium UEM version required
Behavior change
AddClientCertificate
12.9
Requires a fileName parameter (the extension of the file must be .pfx or .p12):
<urn:fileName>'x.pfx'</urn:fileName>
addUser
12.7
None
deleteContainer
12.6 MR1
None
generateAccessKeys
12.6 MR1
Integrated mode uses a new default email template for sending email messages for access keys. Unless the administrator has updated the email template after upgrading to integrated mode, email messages might look different than the ones that 
Good Control
 sends in standalone mode. Any user Ids that the API client system previously persisted do not work as the “userId” parameter value.
generateRestrictedAccessKey
12.7
None
generateUnlockAccessKey
12.6 MR1
Any user Ids that the API client system previously persisted do not work as the “userId” parameter value. Use the "getUser" API to retrieve the “userId” for users.
getAccessKeys
12.6 MR1
Any user Ids that the API client system previously persisted do not work as the “userId” parameter value. Use the "getUser" API to retrieve the “userId” for users.
getActivatedContainers
12.6 MR1
Any user Ids that the API client system previously persisted do not work as the “userId” parameter value. Use the "getUser" API to retrieve the “userId” for users.
getAppInfo
12.6 MR1
The response does not include the “serverList” and “policySetId” elements. This information is not available or applicable in integrated mode.
getApps
12.6 MR1
The response does not include the “serverList” and “policySetId” elements. This information is not available or applicable in integrated mode.
getDevices
12.6 MR1
Any user Ids that the API client system previously persisted do not work as the “userId” parameter value. Use the "getUser" API to retrieve the “userId” for users.
BlackBerry UEM
 12.7 updated the support for this API to include:
  • the container lock status and reason
  • the manufacturerName property in the DeviceType element in responses
  • the lockStatus, lockReason, and authDelegate properties in the ContainerType element in responses
getGCProperties
12.7
None
getGPClusterList
12.6 MR1
None
getGPClusterServerList
12.6 MR1
None
getServerList
12.6 MR1
None
getUnlockAccessKeys
12.6 MR1
None
getUser
12.6 MR1
The response does not include “policySetId” and “policyName”. The “appsGroupCount” element represents the number of 
BlackBerry UEM
 user groups that the user belongs to.
Note that manual return parsing based on order and case is not supported; it is a best practice to use an XML parser.
lockContainer
12.6 MR1
None
noop
12.7
None
removeAccessKey
12.6 MR1
None
sendPinEmail
12.6 MR1
Integrated mode uses a new default email template for sending email messages for access keys. Unless the administrator has updated the email template after upgrading to integrated mode, email messages might look different than the ones that 
Good Control
 sends in standalone mode.

Supported CAP SOAP APIs

API Name
Minium UEM version required
Behavior change
AddApp
12.6 MR1
The API adds a 
BlackBerry Dynamics
 application entitlement with app_type as 'O' (organization), app_realm as 'E' (enterprise), app_visibility as 'PRV' (private), and client_type as 'NativeContainer'. The API displays an error if the request parameters do not match. The API ignores the “purchase_url” request parameter.
AddGroup
12.6 MR1
The API creates the 
BlackBerry UEM
 user group. The request parameter “group_type” only supports the value of ‘e’ (Enterprise) and displays an error if you use any other values. The owner identifiers (“enterpriseId”/”organizationId”/”resellerId”) do not support accepting any value from the API client and display an error if you provide a value.
AddGroupUser
12.6 MR1
The API adds users to the 
BlackBerry UEM
 user group. Any group Ids and user Ids that the API client system previously persisted do not work as request parameter values.
AddGroupsUsers
12.6 MR1
The API adds users to the 
BlackBerry UEM
 user groups. Any group Ids and user Ids that the API client system previously persisted do not work as request parameter values. If you set the “replace” parameter to ‘true’, users are removed from any other 
BlackBerry UEM
 user groups and are added to the newly specified 
BlackBerry UEM
 user group.
getApps
12.6 MR1
None
getGroups
12.6 MR1
The API returns the 
BlackBerry UEM
 user groups filtered by group name. The “member_count” in the response indicates the number of 
BlackBerry UEM
 users in the user group. The values supported for the “group_Type” parameter are:
  • E="Everyone"
  • e="All enterprise groups, except 'Everyone'"
  • null= "All Groups"
The API displays an error if you provide an unsupported value for “group_Type”. The owner identifiers “enterpriseId”/”organizationId”/”resellerId” are not supported.
getGroupsForUser
12.6 MR1
The API returns a list of 
BlackBerry UEM
 user groups that a given 
BlackBerry UEM
 user is part of. Any user Ids that the API client system previously persisted do not work as request parameter values.
getGroupPermissions
12.6 MR1
The API returns a list of 
BlackBerry Dynamics
 applications assigned to a 
BlackBerry UEM
 user group with appropriate permission dispositions (ALLOW and DENY). Any group Ids that the API client system previously persisted do not work as request parameter values. There are a few caveats:
  • app_version is not returned in the response
  • only applications with client_type = NATIVE_CONTAINER are supported
  • organization info is excluded from the response
  • app_realm value can only be 'E' for enterprise
  • app_type is 'G' for any apps that start with "com.good" or "com.blackberry" and 'O' for all others
getUsersInGroup
12.6 MR1
The API returns a list of 
BlackBerry UEM
 users that are part of a given 
BlackBerry UEM
 user group. Any group Ids that the API client system previously persisted do not work as request parameter values.
RemoveApp
12.6 MR1
The API removes the 
BlackBerry Dynamics
 application entitlement from the system. The API displays errors if the removal fails because of 
BlackBerry UEM
 rules; for example, the application is already assigned to a user/group.
RemoveGroup
12.6 MR1
The API deletes the 
BlackBerry UEM
 user group. Any group Ids that the API client system previously persisted do not work as the “group_id” parameter value. The API performs checks to be consistent with integrated mode.
removeGroupUser
12.6 MR1
The API removes users from the 
BlackBerry UEM
 user group. Any group Ids and user Ids that the API client system previously persisted do not work as request parameter values.
setGroupPermission
12.6 MR1
The API assigns 
BlackBerry Dynamics
 applications with appropriate permission dispositions to a 
BlackBerry UEM
 user group. Any group Ids that the API client system previously persisted do not work as request parameter values. There are a few caveats:
  • app_version_id is not supported in the request
  • app_id must be provided in the request because the default permissions are not supported in integrated mode
  • only the following permission dispositions are supported: UNDEFINED, ALLOW, and DENY. UNDEFINED removes the application from the 
    BlackBerry UEM
     user group