Overview

The BlackBerry UEM Web Services are a collection of REST APIs that you can use to create applications to manage your organization's environment. You can use the BlackBerry UEM Web Services to automate many of the tasks that administrators typically perform using the management console. For example, you can create an application that automates the process of adding user accounts to the domain.

For more information, see Getting started and code samples.

Resources

Name Method Description
APNs Provides APNs management functions.
Apple DEP Provides Apple DEP device management functions.
Apple VPP Account Provides Apple VPP account management functions.
Application Groups Provides access and management of application groups.
Application Servers Provides application server related functionality.
Application configs Provides access and management of application configs.
Applications Provides access and management of applications.
Certificates Provides certificate management routes.
Clusters Provides cluster related functionality.
Company directories Provides management functions for company directories.
Custom variables Provides access and management of custom variables.
Device groups Provides access and management of device groups.
Devices Provides device management functions.
Email templates Variables are used to reference values instead of specifying the actual values.
Entities Provides access to entity instances.
Exchange Active Sync Provide information about Microsoft Exchange Active Sync connections
Groups Provides access and management of groups.
Info Provides information
Licensing Provides access to licensing information
Ping Ping server and get the current uptime of the server. This is an authenticated call and can be used to test if the server is up and the authentication header is valid before attempting to access other authenticated routes.
Profiles Profiles provide the ability to assign functionality to a user or group.
Roles Provides role management functions.
Servers Provides server related functionality.
Shared Device Groups Provides access to shared device groups.
Trusted Certificates Provide information about trusted certificates
Users Provides user management functions.
Utilities Provides unauthenticated utility methods.

Data types

JSON

Type Description
APNs status An APNs certificate status defined in the system.
Access password An access password. For example, an access key for a BlackBerry Dynamics app.
Access passwords A collection of access passwords.
Activation password A user activation password to activate devices against the system.
Activation passwords A collection of user activation passwords.
Admin role An admin role in the system.
Admin roles A collection of admin roles.
App Integrity attestation code Supported App Integrity attestation codes.
Apple VPP account An Apple VPP account defined in the system.
Apple VPP accounts A collection of Apple VPP accounts.
Application An application instance defined in the system.
Application Server An application server instance defined in the system.
Application Servers A collection of application servers.
Application assignment An app that is assigned or that can be assigned to a user or group.
Application assignments A collection of application assignments.
Application config An application config instance defined in the system.
Application config definition An application config definition defined in UEM.
Application configs A collection of application configs.
Application groups A collection of application groups.
ApplicationGroup An app group defined in UEM.
Applications A collection of applications.
Attestation info The latest information about the attestation performed by an application.
Authorization request Basic information required to generate an authorization header for authenticated API calls.
BlackBerry Dynamics app entitlement A BlackBerry Dynamics application entitlement.
Boolean data type The Boolean data type indicates the setting can only have values of true or false.
Certificate A certificate defined in the system.
Certificate Information by type
Certificate bundle Represents an entity that groups several certificates in a bundle that can be enrolled, renewed or deleted only as a single entity. Typical scenario of creating certificate bundle is enrolling dual-key pair certificate container that results on installing two private keys on a managed device or BlackBerry Dynamics app. Server tracks both of such keys as an individual certificates that are grouped into a bundle. Deletion and renewing can be done only for a whole bundle. Examples of related profile configurations:
  • User credential profile with manually uploaded dual-key pair certificate.
  • User credential profile with Entrust/OpenTrust PKI connector configured with dual-key pair PKI profile.
Certificate enrollment Enrollment of certificate either on the user device or on the application.
Certificate enrollment status Possible certificate enrollment statuses.
As of API version 12.12.0, statuses are used for BlackBerry Dynamics certificate enrollments only.
Certificate enrollments A collection of certificate enrollments.
CertificateInfo
CertificateInfo
Cluster A cluster in the system.
Clusters A collection of clusters.
Command A command to send. For example, to lock a device.
Condition attribute The condition attribute indicates that the setting is conditional on the value of another setting. When the condition is met then the action defined by the 'outcome' attribute is enforced.
DEP Account Device Summary A DEP account defined in the system.
DEP Accounts A collection of DEP accounts
DEP Devices A collection of DEP enrollment configurations
DEP Devices A collection of DEP devices
DEP account A DEP account defined in the system.
DEP device A DEP device defined in the system.
DEP enrollment configuration A DEP enrollment configuration defined in the system.
Date data type The Date data type indicates the setting is the string representation of a Date. The value must be in the ISO 8601 format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. Times are expressed in UTC (Coordinated Universal Time) using the special UTC designator ("Z"). Note that the "T" appears literally in the string, to indicate the beginning of the time element, as specified in ISO 8601
Default Variable Default variable with supported email template types
Default Variables A collection of default variables
Device A device defined in the system.
Device group A device group defined in the system.
Device group details Details of a device group in the system.
Device group query A device group query view.

Possible field, operator and value combinations

Field Operators Possible Values
ACTIVATION_TYPE =, != EXTERNAL_SERVICE, FULL_CONTROL_AFW, FULL_CONTROL_AFW_PREMIUM, FULL_CONTROL_KNOX, MDM_CONTROLS, STRONG_AUTHENTICATION_BY_BLACKBERRY, USER_PRIVACY, USER_PRIVACY_AFW, USER_PRIVACY_AFW_PREMIUM, USER_PRIVACY_CORPORATE, USER_PRIVACY_DYNAMICS, USER_PRIVACY_KNOX, USER_PRIVACY_USER_ENROLLMENT, USER_PRIVACY_WITH_PROFILES, WORK_AND_PERSONAL_REGULATED, WORK_SPACE_ONLY, WORK_SPACE_ONLY_AFW, WORK_SPACE_ONLY_AFW_PREMIUM, WORK_SPACE_ONLY_KNOX
APPLE_DEP =, != yes, no
BLACKBERRY_DYNAMICS =, != disabled, enabled
CARRIER =, !=, startsWith
KNOX_WORKSPACE =, !=, startsWith
MANUFACTURER =, !=, startsWith
MODEL =, !=, startsWith
OS =, != android, BBOS, BB, BB10, ios, OSX, WP
OS_VERSION =, !=, startsWith, <=, >=
OWNERSHIP =, != CORPORATE, PERSONAL, UNKNOWN
Device groups A collection of device groups.
DeviceCommandStatus The status of a device command in the system.
DeviceOSUpdateStatus Device os update status.
Devices A collection of devices
Direct Connection Direct connection settings view
Directory Connection A basic Directory connection.
Directory Connections A collection of Directory Connections.
Directory user User in a company directory.
Directory users A collection of directory users.
Disposition Supported disposition types.
Email template An email template used for sending activation information or compliance violation notification emails.
Email template types Supported email template types
Email templates A collection of email templates.
Embedded certificate EmbeddedCertificate is an entity that connects a Certificate object (user certificate, SCEP, user credential profile, and so on) to other entities, providing information about how the certificate is used, for example, the associated user, profile, or enrollments.
Embedded certificates A collection of embedded certificates.
Enrollment types Supported device enrollment types.
Entity definition An Entity Definition is the description of the Entity. It describes the properties, types, sizes, constraints, UI representations, etc.
Entity definitions A collection of supported entity definitions.
Entity instance An entity instance.
Entity instances A collection of entity instances.
Enum data type The Enum data type indicates a predefined list of constants that a setting can be set to.
Enum option The Enum option defines the attributes for each option in the Enum data type.
Error A more detailed description of an error. The Content-Type response header will be application/vnd.blackberry.error-v1+json when this is returned.

See Error codes for an overview of possible error IDs and subStatusCodes.

Error codes The table below describes various error IDs and subStatusCodes that may be encountered when parsing an Error. The "Description" column format is: <subStatusCode>: <description>. Note that every API may return 403 Forbidden if the authenticated user is not authorized to perform the action. See also the getting started guide.
Exchange Active Sync connection A basic Exchange Active Sync connection.
Exchange Active Sync connections A collection of Exchange Active Sync connections.
ExchangeActiveSyncConnection
Feature A license feature
Feature Usage Feature consumption information
File data type The File data type indicates the setting takes the contents of a file.

See:File Property. for required attributes when specifying a file setting in an entity instance.

File data type sample: 
 
 {
     "entityDefId": "com.blackberry.mdm.common.entity.ExampleEntityDefId",
     "settings": {
         ...
         "fileSetting": {
             "fileName": "testPsw.txt",
             "fileType": "txt",
             "timestamp": "2019-08-27T13:58:38.546Z",
             "content": "cGFzc3dvcmQxCnBhc3N3b3JkMg=="
         },
         ...
     }
 }
File property The attributes of a File Property for an entity instance.
Geolocation Device geo point.
Group A user group defined in the system.
Group Licensing Object containing unassigned license data and per-group licensing information
Group Licensing Information Contains licensing information for each UEM group in a licensing information response.
Group assignment A group that is assigned to a user.
Group assignments A collection of group assignments.
Groups A collection of user groups.
Groups Licensing Information Contains an organization's group Licensing information response.
Installation status Supported installation statuses.
Integer data type The Integer data type indicates the setting can only be an integer.
License Info Additional license details per license type
Licensed Service A licensed service
Licensed Usage License consumption information and a breakdown of consumption per feature.
Licensing Information Licensing information details for an organization
Link A link related to a resource.
Link data type The Link data type indicates that a setting must be set to an instance of another entity. The 'fetchUrl' can be used to get all entity instances allowed to for the setting.

To create or update an entity which has a Link setting it can either be set to only the entityDefId and entityInstanceId or it can be set to the entire entity instance.

Sample with only entityDefId and entityInstanceId: 
 
 {
     "entityDefId": "com.blackberry.mdm.common.entity.ExampleEntityDefId",
     "settings": {
         ...
         "linkSetting": {
                 "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
                 "entityInstanceId": "5e3a79ab-80f5-4529-9b2a-853df8b739d3"
             },
         ...
     }
 }

Sample with entire entity:

 
 {
     "entityDefId": "com.blackberry.mdm.common.entity.ExampleEntityDefId",
     "settings": {
         ...
         "linkSetting": {
                 "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
                 "entityInstanceId": "5e3a79ab-80f5-4529-9b2a-853df8b739d3"
                 "settings": {
                     "authDelegateName": "BlackBerry Access",
                     "authDelegateSid": "com.good.gdgma"
                 }
             },
         ...
     }
 }
Long data type The Long data type indicates the setting can only be a long.
Malicious application A malicious app that is detected on a user’s device.
Message of the Day Contains a message related to licensing services
Ordered set data type The OrderedSet data type indicates the setting is a collection of elements. The 'collectionType' attribute indicates the data type of elements allowed in the collection. The order of the elements are maintained in the same order they are set.

To create or update an entity which has a OrderedSet setting the JSON Array type should be used.

OrderedSet sample:

 
 {
     "entityDefId": "com.blackberry.mdm.common.entity.ExampleEntityDefId",
     "settings": {
         ...
         "orderedSetSetting": [ "element1", "element2", ... , "elementX" ],
         ...
     }
 }
Organization Status Licensing status summary for an organization
Out of compliance information Represents the view for the out of compliance information for a user device.
Password A certificate password.
Profile A profile instance defined in the system.
Profile assignment A profile that is assigned to a user.
Profile assignments A collection of profile assignments.
Profile categories Supported profile categories
Profiles A collection of profiles.
Property data type Base entity definition data type.
Record data type The Record data type indicates that the setting is a collection of fields, possibly of different data types.

Record sample:

 
 {
     "entityDefId": "com.blackberry.mdm.common.entity.ExampleEntityDefId",
     "settings": {
         ...
         "recordSetting": {
                  "field1": "value1",
                  "field2": "value2",
                  ...
                  "fieldx": "valuex"
              }
         ...
     }
 }
Server A server in the system.
Server service A service installed on a server.
Servers A collection of servers.
Service Represents a service. For example, MDM (Mobile Device Management) is a service that can be associated with a user so that their devices can be managed.
Service assignment Represents a service that can be assigned. For example, MDM (Mobile Device Management) is a service that can be assigned to a user so that their devices can be managed.
Service assignment statuses Supported service assignment statuses
Service assignments A collection of service assignments.
Service connection A service connection on a server.
Shared device group
Shared device groups
Sideloaded application Sideloaded application
Sideloaded applications Sideloaded applications and signing identities
Signing identity Signing identity
Sim Sim data of a device.
Stable set data type The StableSet data type indicates the setting is a collection of elements. The 'collectionType' attribute indicates the data type of elements allowed in the collection. The order of the elements are based on comparing the elements in the collection.

To create or update an entity which has a StableSet setting the JSON Array type should be used.

StableSet sample:

 
 {
     "entityDefId": "com.blackberry.mdm.common.entity.ExampleEntityDefId",
     "settings": {
         ...
         "stableSetSetting": [ "element1", "element2", ... , "elementX" ],
         ...
     }
 }
Suggested License Suggested license information for unlicensed features
System info System information.
Text data type The Text data type indicates that the setting must be a String.
Time interval data type The Time interval data type indicates that the setting represents an interval of time (for example, 60 seconds). Specify the value in seconds. The value must be divisible by the value of the 'minUnit' field; for example, if the minUnit is 'min' (minutes), then 60 is a valid value, but 90 is not valid.
Unassigned License Details Unassigned license purchase details for group-based licensing information. Does not apply to non-group based licensing.
Unassigned Licenses Unassigned Purchase view for group-based licensing information. Does not apply to non-group based licensing.
Unlicensed Usage Unlicensed usage details.
User A user in the system.
User custom variable A custom variable that is set for a user.
User custom variables Represents list of user custom variables.
User detail Details of a user in the system.
User device A user device defined in the system.
User device application An assigned or installed user device application.
User device applications A collection of user device applications.
User device attestation Information about the current configuration for device attestation.
User device base info A user device base info defined in the system.
User device enrollment states Supported user device enrollment states
User devices A collection of user devices.
User devices base info A collection of user devices base info.
Users A collection of users