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.

Resources

Name Path Methods Description
Applications
  • /{tenantGuid}/api/v1/applications
  • /{tenantGuid}/api/v1/applications/{appGuid}/profil...
  • GET
  • DELETE PUT
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}/profiles
  • /{tenantGuid}/api/v1/groups/{groupGuid}/users
  • /{tenantGuid}/api/v1/groups/{groupGuid}/applicatio...
  • GET POST
  • DELETE GET
  • POST
  • GET POST PUT
  • DELETE POST
  • DELETE
Provides access and management of groups.
Info
  • /{tenantGuid}/api/v1/info/systeminfo
  • GET
Provides 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}/groups
  • /{tenantGuid}/api/v1/profiles/{profileGuid}/users
  • GET
  • POST
  • POST
Profiles provide the ability to assign functionality to a user or group.
Users
  • /{tenantGuid}/api/v1/users
  • /{tenantGuid}/api/v1/users/{userGuid}
  • /{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}/services
  • /{tenantGuid}/api/v1/users/{userGuid}/userDevices
  • /{tenantGuid}/api/v1/users/{userGuid}/activationPa...
  • /{tenantGuid}/api/v1/users/{userGuid}/userDevices/...
  • /{tenantGuid}/api/v1/users/{userGuid}/profiles/{pr...
  • /{tenantGuid}/api/v1/users/{userGuid}/userDevices/...
  • GET POST
  • DELETE GET PATCH
  • DELETE GET POST PUT
  • GET
  • GET
  • GET POST PUT
  • GET
  • GET
  • DELETE
  • GET
  • DELETE PUT
  • GET
Provides user management functions.
Utilities
  • /{tenantGuid}/api/v1/util/authorization
  • /{tenantGuid}/api/v1/util/ping
  • POST
  • GET
Provides un-authenticated utility methods.

Data types

JSON

Type Description
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 assignment An application that is or that can be assigned, for example to a user or group.
Application assignments A collection of application assignments.
Applications A collection of applications.
Authorization request Basic information required to generate an authorization header for authenticated API calls.
Certificate A certificate defined in the system.
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.
Group A group defined in the system.
Groups A collection of groups.
Installation status Supported installation statuses.
Link A link related to a resource.
Profile A profile instance defined in the system.
Profile categories Supported profile categories
Profiles A collection of profiles.
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.
System info System information.
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 devices A collection of user devices.
Users A collection of users