What's new in the BlackBerry Web Services for BlackBerry UEM version 12.13 REST APIs

For details about the new features and updates discussed here, see the BlackBerry UEM 12.13 REST API Reference.

Getting started

The Getting started page now contains information about the following:

New entity definition ID information for compliance profiles, the BlackBerry Dynamics library, email templates, device hardware vendors, device hardware brands, device hardware models, restricted applications, application store, antivirus vendors, device OS versions, BlackBerry Dynamics server cluster, BlackBerry Dynamics connectivity profile, allowed domain route, default domain route, server route, IP address range route, and app server route

Enclosed entities

Allowed or restricted device models in the compliance profile

Certificate management

New resources

Resource: Custom variables

Path	Changes
GET /{tenantGuid}/api/v1/customVariables	Retrieves custom variables
POST /{tenantGuid}/api/v1/users	Allows specifying custom variables when creating a local user or a directory user.
PATCH /{tenantGuid}/api/v1/users/{userGuid}	Allows specifying custom variables when updating a local user or a directory user.

Resource: Device groups

Path	Changes
GET /{tenantGuid}/api/v1/deviceGroups	Searches for device groups
POST /{tenantGuid}/api/v1/deviceGroups	Creates a device group
DELETE /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}	Deletes a device group
GET /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}	Retrieves a device group by a specific GUID
PUT /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}	Updates a device group
DELETE /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}/applicationGroups/{appGroupGuid}	Unassigns an application group, by GUID, from a device group
GET /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}/applications	Retrieves all applications and application groups assigned to device group
POST /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}/applications	Assigns one or more applications or application groups, by GUID, to a device group
DELETE /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}/applications/{appGuid}	Unassigns an application, by GUID, from a device group
GET /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}/groups	Retrieves scoped user groups by a specific device group GUID
POST /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}/groups	Assigns one or more scoped user groups to a device group
DELETE /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}/groups/{groupGuid}	Removes a scoped user group from a device group
GET /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}/profiles	Retrieves all profiles assigned to a device group
POST /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}/profiles	Assigns one or more profiles, by GUID, to a device group
PUT /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}/profiles	Replaces all profiles assigned to a device group
GET /{tenantGuid}/api/v1/deviceGroups/{deviceGroupGuid}/userDevices	Retrieves the user devices assigned to a device group that are listed as Enrolled

Resource: Roles

Path	Changes
GET /{tenantGuid}/api/v1/roles/admin	Retrieves a list of all administrator roles in the system
GET /{tenantGuid}/api/v1/roles/admin/{adminRoleGuid}	Retrieves an administrator role by GUID
GET /{tenantGuid}/api/v1/roles/admin/{adminRoleGuid}/users	Retrieves a list of users assigned to the given administrator role
DELETE /{tenantGuid}/api/v1/roles/admin/{adminRoleGuid}/users/{userGuid}	Removes the specific administrator role from the specific user
PUT /{tenantGuid}/api/v1/roles/admin/{adminRoleGuid}/users/{userGuid}	Assigns (adds or replaces) the given user's administrator role with the specific administrator role

New paths and methods

Resource: Application configs

Path	Changes
POST /{tenantGuid}/api/v1/applicationConfigs	Creates a BlackBerry Dynamics app config
DELETE /{tenantGuid}/api/v1/applicationConfigs/{appConfigGuid}	Deletes a BlackBerry Dynamics app config
PATCH /{tenantGuid}/api/v1/applicationConfigs/{appConfigGuid}	Updates any of the following fields for a BlackBerry Dynamics application config: name, settings

Resource: Applications

Path	Changes
POST /{tenantGuid}/api/v1/applications/{appGuid}/configRanking	Updates ranking of app config

Resource: Certificates

Path	Changes
GET /{tenantGuid}/api/v1/embeddedCertificates/{embeddedCertificateGuid}/certificateEnrollments	Retrieves a list of certificate enrollments for a specified embedded certificate

Resource: Groups

Path	Changes
GET /{tenantGuid}/api/v1/groups/{groupGuid}/applications	Retrieves the apps or app groups that were directly or indirectly assigned to a group

Changes to existing paths and methods

Resource: Certificates

Path	Changes
GET /{tenantGuid}/api/v1/pki/certificates/{certificateGuid}	The supported profile for this method now includes non-BlackBerry Dynamics user certificate profiles

Resource: Entities

Path	Changes
GET /{tenantGuid}/api/v1/entities/{entityDefId}/{entityInstanceId}	A request parameter for dynamicsContainerId was added. This is an Optional query parameter that specifies the GUID of a Dynamics container. If this parameter is specified, the returned response is filtered for the specified container. Currently, this filtering consists of returning elements that have a "device-mapping" definition using the device-mapping name as the property key.

Resource: Groups

Path	Changes
GET /{tenantGuid}/api/v1/groups	New fields were added that can be used in the query: appConfigGuid: Used to retrieve groups that have applications with this configuration assigned to them userEcoid: Used to retrieve groups that have this user assigned to them

Resource: Users

Path	Changes
GET /{tenantGuid}/api/v1/users	New fields were added that can be used in the query: appConfigGuid: GUID of an application configuration of directly-assigned application firstName: First name of the user. lastName Last name of the user effectiveAppConfigGuid: GUID of an effective application configuration of directly or indirectly assigned application
POST /{tenantGuid}/api/v1/users	A new user property is allowed when creating a local user: customVariables.
PATCH /{tenantGuid}/api/v1/users/{userGuid}	A new user property is allowed when creating a local user: customVariables.
GET /{tenantGuid}/api/v1/users/{userGuid}/applications	A new field was added that can be used in the query: query: A query for filtering the application assignment results

Data types

New data types

Type	Description
Admin role	An administrator role in the system
Admin roles	A collection of administrator roles
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
Device groups	A collection of device groups
User custom variables	Represents a list of user custom variables

Changes to data types

Type	Description
Application assignment	The following properties were added: assignment: How the application or application group was assigned (USER, GROUP, DIRECT, INDIRECT) links: Links to user group details using groups route
Application	The following properties were added: appScanStateMessage: Application scan state message compliancePolicyGuid: GUID of the overridden compliance profile connectivityPolicyGuid: GUID of the overridden BlackBerry Dynamics connectivity profile securityPolicyGuid:GUID of the overridden BlackBerry Dynamics profile
Certificate	This data type has been deprecated. Use PUT /{tenantGuid}/api/v1/users/{userGuid}/profiles/{profileGuid}/embeddedCertificates going forward.
Directory user	The following property was added: customVariables: Custom variables that have been set for the user
Enrollment types	The following values were added: EXTERNAL_SERVICE: Generic BEP USER_PRIVACY_DYNAMICS: BlackBerry Dynamics User Privacy USER_PRIVACY_USER_ENROLLMENT: Apple User Enrollment USER_PRIVACY_WITH_PROFILES: Is not managed but certain profiles can be applied
Groups	The following property was added: total: This property applies only in the response to searching for groups, and setting the includeTotal parameter to true in the request. Represents the total number of groups that matched the search, which may be different from the number of groups actually returned.
User detail	The following property was added: customVariables: Custom variables that have been set for the user
User device application	The following property was added: dynamicsDeviceId: Device ID for BlackBerry Dynamics apps, it does not appear for other app types
User devices	The following property was added: total: This property applies only in the response to searching for user devices and setting the includeTotal parameter to true in the request. It represents the total number of user devices that matched the search, which may be different from the number of user devices actually returned.
User	The following property was added: customVariables: Custom variables that have been set for the user