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 Path Methods Description
Application Groups
  • /{tenantGuid}/api/v1/applicationGroups
  • /{tenantGuid}/api/v1/applicationGroups/{appGroupGu...
  • /{tenantGuid}/api/v1/applicationGroups/{appGroupGu...
  • GET POST
  • GET PUT
  • POST PUT
Provides access and management of application groups.
Application Servers
  • /{tenantGuid}/api/v1/applicationServers
  • GET
Provides application server related functionality.
Applications
  • /{tenantGuid}/api/v1/applications
  • /{tenantGuid}/api/v1/applications/{appGuid}
  • /{tenantGuid}/api/v1/applications/{appGuid}/profil...
  • /{tenantGuid}/api/v1/applications/{appGuid}/{osFam...
  • /{tenantGuid}/api/v1/applications/{appGuid}/{osFam...
  • GET POST
  • DELETE PATCH
  • DELETE PUT
  • PATCH POST
  • DELETE
Provides access and management of applications.
Company directories
  • /{tenantGuid}/api/v1/directories/users
  • GET
Provides management functions for company directories.
Devices
  • /{tenantGuid}/api/v1/devices
  • GET
Provides device management functions.
Email templates
  • /{tenantGuid}/api/v1/emailTemplates
  • GET
Email templates are used for sending activation information or compliance violation notification emails.
Groups
  • /{tenantGuid}/api/v1/groups
  • /{tenantGuid}/api/v1/groups/{groupGuid}
  • /{tenantGuid}/api/v1/groups/{groupGuid}/applicatio...
  • /{tenantGuid}/api/v1/groups/{groupGuid}/applicatio...
  • /{tenantGuid}/api/v1/groups/{groupGuid}/profiles
  • /{tenantGuid}/api/v1/groups/{groupGuid}/users
  • GET POST
  • DELETE GET
  • POST
  • DELETE
  • GET POST PUT
  • DELETE POST
Provides access and management of groups.
Info
  • /{tenantGuid}/api/v1/info/systeminfo
  • GET
Provides information
Licensing
  • /{tenantGuid}/api/v1/licensing
  • /{tenantGuid}/api/v1/licensing/groups
  • GET
  • GET
Provides access to licensing information
Ping
  • /{tenantGuid}/api/v1/ping
  • GET
Used to determine if the server is up and available.
Profiles
  • /{tenantGuid}/api/v1/profiles
  • /{tenantGuid}/api/v1/profiles/{profileGuid}
  • /{tenantGuid}/api/v1/profiles/{profileGuid}/groups
  • /{tenantGuid}/api/v1/profiles/{profileGuid}/users
  • GET
  • DELETE
  • POST PUT
  • POST PUT
Profiles provide the ability to assign functionality to a user or group.
Servers
  • /{tenantGuid}/api/v1/servers
  • GET
Provides server related functionality.
Users
  • /{tenantGuid}/api/v1/users
  • /{tenantGuid}/api/v1/users/{userGuid}
  • /{tenantGuid}/api/v1/users/{userGuid}/accessPasswo...
  • /{tenantGuid}/api/v1/users/{userGuid}/activationPa...
  • /{tenantGuid}/api/v1/users/{userGuid}/activationPa...
  • /{tenantGuid}/api/v1/users/{userGuid}/applications
  • /{tenantGuid}/api/v1/users/{userGuid}/groups
  • /{tenantGuid}/api/v1/users/{userGuid}/profiles
  • /{tenantGuid}/api/v1/users/{userGuid}/profiles/{pr...
  • /{tenantGuid}/api/v1/users/{userGuid}/services
  • /{tenantGuid}/api/v1/users/{userGuid}/userDevices
  • /{tenantGuid}/api/v1/users/{userGuid}/userDevices/...
  • /{tenantGuid}/api/v1/users/{userGuid}/userDevices/...
  • /{tenantGuid}/api/v1/users/{userGuid}/userDevices/...
  • /{tenantGuid}/api/v1/users/{userGuid}/userDevices/...
  • /{tenantGuid}/api/v1/users/{userGuid}/userDevices/...
  • GET POST
  • DELETE GET PATCH
  • DELETE GET POST
  • DELETE GET POST PUT
  • DELETE
  • GET POST
  • GET
  • DELETE GET POST PUT
  • DELETE PUT
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • GET
Provides user management functions.
Utilities
  • /{tenantGuid}/api/v1/util/authorization
  • /{tenantGuid}/api/v1/util/ping
  • POST
  • GET
Provides unauthenticated utility methods.

Data types

JSON

Type Description
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.
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 application that is or that can be assigned, for example to a user or group.
Application assignments A collection of application assignments.
Application groups A collection of application groups.
ApplicationGroup An application group defined in the system.
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.
Certificate A certificate defined in the system.
Command A command to send. For example, to lock a device.
Device A device defined in the system.
Devices A collection of devices
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.
Enrollment types Supported device enrollment types.
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>.
Feature A license feature
Feature Usage Feature consumption information
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.
License Info Additional license details per license type
Licensed Service A licensed service
Licensed Usage License consumption information and a breakup of consumption per feature
Licensing Information Licensing information details for an organization
Link A link related to a resource.
Message of the Day Contains a message related to licensing services
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.
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.
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.
Suggested License Suggested license information for unlicensed features
System info System information.
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 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 devices A collection of user devices.
Users A collection of users