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
Activation passwords
  • /{tenantGuid}/api/v1/users/{userGuid}/activationPa...
  • /{tenantGuid}/api/v1/users/{userGuid}/activationPa...
  • DELETE GET POST PUT
  • DELETE
User activation password management.
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.
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}/profiles
  • GET
  • GET
  • GET POST PUT
Provides access and management of groups.
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}/profiles
  • GET POST
  • GET POST PUT
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.
Applications A collection of applications.
Authorization request Basic information required to generate an authorization header for authenticated API calls.
Directory user User in a company directory.
Directory users A collection of directory users.
Email template An email template used for sending activation information or compliance violation notification emails.
Email templates A collection of email templates.
Error A more detailed description of an error.
Group A group defined in the system.
Groups A collection of groups.
Profile A profile instance defined in the system.
Profiles A collection of profiles.
User A user in the system.
Users A collection of users