Skip to content

What's new in the BlackBerry UEM 12.7 REST APIs

For details about the new additions and changes discussed here, see the BlackBerry UEM 12.7 REST API Reference posted here. You can view the API reference online or download it (unzip the contents and open the index file).

New paths and methods

Resource: Devices

Path

Description

GET /{tenantGuid}/api/v1/devices

Search for devices.

Resource: Groups

Path

Description

POST /{tenantGuid}/api/v1/groups/{groupGuid}/users

Add user accounts to a user group by GUID.

POST /{tenantGuid}/api/v1/groups/{groupGuid}/applications

Assign apps to a user group by GUID.

POST /{tenantGuid}/api/v1/groups

Create a user group.

DELETE /{tenantGuid}/api/v1/groups/{groupGuid}

Delete a user group.

DELETE /{tenantGuid}/api/v1/groups/{groupGuid}/users

Remove user accounts from a user group by GUID.

DELETE /{tenantGuid}/api/v1/groups/{groupGuid}/applications/{appGuid}

Remove an app from a user group by GUID.

Resource: Info

Path

Description

GET /{tenantGuid}/api/v1/info/systeminfo

Get system info.

Resource: Users

Path

Description

GET /{tenantGuid}/api/v1/users/{userGuid}

Get the details of a user account by GUID.

PATCH /{tenantGuid}/api/v1/users/{userGuid}

Update the password for a local (non-directory) user.

GET /{tenantGuid}/api/v1/users/{userGuid}/applications

Get all apps that are directly assigned to a user account.

GET /{tenantGuid}/api/v1/users/{userGuid}/groups

Get all user groups that a user account is assigned to.

GET /{tenantGuid}/api/v1/users/{userGuid}/services

Get the services that are assigned to a user account.

DELETE /{tenantGuid}/api/v1/users/{userGuid}

Remove the specified user account.

GET /{tenantGuid}/api/v1/users/{userGuid}/userDevices

Get the devices that are assigned to a user account.

GET /{tenantGuid}/api/v1/users/{userGuid}/userDevices/{userDeviceGuid}

Get a specific device that is assigned to a user account.

PUT /{tenantGuid}/api/v1/users/{userGuid}/profiles/{profileGuid}/certificate

Add or update a certificate for a user credential profile that supports manually uploaded certificates.

DELETE /{tenantGuid}/api/v1/users/{userGuid}/profiles/{profileGuid}/certificate

Remove a manually uploaded certificate from a user credential profile.

New data types

Type

Description

Application assignment

An app that is (or can be) assigned to a user account or user group

Application assignments

A collection of app assignments

Certificate

A certificate that is defined in BlackBerry UEM

Device

A device that is defined in BlackBerry UEM

Devices

A collection of devices

Email template types

The types of email templates that are supported

Enrollment types

The device enrollment types that are supported

Link

A link related to a resource; for example, a link between a user and the groups and profiles the user is associated with

Profile categories

Profile categories that are supported

Service

Represents a service; for example, MDM (Mobile Device Management) is a service that can be associated with a user so that an administrator can manage the user’s devices

Service assignment

Represents a service that can be assigned

Service assignment statuses

The service assignment statuses that are supported

Service assignments

A collection of service assignments

SystemInfo

System information; for example, activation URL, management console URL, product version, and so on

User custom variable

A custom variable that is set for a user account

User detail

The details of a user account

User device

A user’s device that is defined in BlackBerry UEM

User devices

A collection of user devices

Changes to resources

Resource: Users

In the previous release, the following were organized under the Activation passwords resource. In this release, they have been moved into the Users resource:

Path

Description

GET /{tenantGuid}/api/v1/users/{userGuid}/activationPasswords

Get all of the non-expired activation passwords for a user account.

POST /{tenantGuid}/api/v1/users/{userGuid}/activationPasswords

Set one or more activation passwords for a user account.

PUT /{tenantGuid}/api/v1/users/{userGuid}/activationPasswords

Replace all of the activation passwords for a user account.

DELETE /{tenantGuid}/api/v1/users/{userGuid}/activationPasswords

Expire all of the activation passwords for a user account.

DELETE /{tenantGuid}/api/v1/users/{userGuid}/activationPasswords/{activationPasswordGuid}

Expire a specific activation password for a user account.

The following request parameters have been added to GET /{tenantGuid}/api/v1/users:

Parameter

Description

includeTotal

Used to retrieve the total number of user accounts that match the search criteria, which may be different from the number of user accounts returned.

max

The maximum number of user accounts to return, between 1 and 1000. The default value is 100.

offset

The number of user accounts to exclude from the beginning of the search results, greater than or equal to 0. Used to get pages of results, for example, with max=50 and offset=0 for the first 50 users, max=50 and offset=50 for the next 50 users, and so on. The default value is 0.

sortBy

The field to sort the results by.

For GET /{tenantGuid}/api/v1/users, the following fields have been added to the query request parameter:
  • displayName
  • guid
  • directoryId
  • groupGuid
  • profileGuid

For POST /{tenantGuid}/api/v1/users, additional information has been added to the API reference to indicate the fields that are allowed when creating a directory-linked user or a local user, and information has been added about the Location response header.

For POST /{tenantGuid}/api/v1/users/{userGuid}/activationPasswords and PUT /{tenantGuid}/api/v1/users/{userGuid}/activationPasswords, the following response code has been added:
  • 503: SMTP server temporarily unavailable to send emails. Retry the request again later.

Changes to data types

Data type

Changes

Email template

A default property has been added to indicate whether it is the default email template.

Profile

A default property has been added indicate whether it is the default profile for that category.

User

A links property has been added to indicate links from a user to related resources, for example, groups and profiles.

Users

A total property has been added to indicate the total number of users that match the search criteria, which may be different from the number of user accounts returned.