What's new in the BlackBerry UEM version 12.10 REST APIs
BlackBerry UEM
version 12.10 REST APIsFor details about the new additions and changes discussed here, see the
BlackBerry UEM
12.10 REST API Reference.New resources
New resources
Resource: Application Groups
Path | Description |
---|---|
GET /{tenantGuid}/api/v1/applicationGroups | Retrieve information about all app groups or retrieve information about specific apps groups using a query. |
POST /{tenantGuid}/api/v1/applicationGroups | Create an app group. The name field is required, the description field is optional. |
GET /{tenantGuid}/api/v1/applicationGroups/{appGroupGuid} | Retrieve an app group by GUID. |
PUT /{tenantGuid}/api/v1/applicationGroups/{appGroupGuid} | Update an app group name and/or description. |
POST /{tenantGuid}/api/v1/applicationGroups/{appGroupGuid}/applications | Add apps, specified by GUID, to an app group. |
PUT /{tenantGuid}/api/v1/applicationGroups/{appGroupGuid}/applications | Replace all apps in an app group with new apps specified by GUID. |
New paths and methods
New paths and methods
Resource: Applications
Path | Description |
---|---|
POST /{tenantGuid}/api/v1/applications | Create an internal BlackBerry
Dynamics app entitlement. |
POST /{tenantGuid}/api/v1/applications | Add an internal non- BlackBerry
Dynamics app with a binary. |
DELETE /{tenantGuid}/api/v1/applications/{appGuid} | Delete an internal non- BlackBerry
Dynamics app with a binary or an internal BlackBerry
Dynamics app entitlement. |
PATCH /{tenantGuid}/api/v1/applications/{appGuid} | Update any of the following fields for an internal non- BlackBerry
Dynamics app: name, description, vendorName, categories, reviewMode.This path is not supported for non-internal apps or BlackBerry
Dynamics apps. |
PATCH /{tenantGuid}/api/v1/applications/{appGuid}/{osFamilyName} | Override the app package ID for an internal BlackBerry
Dynamics app. |
POST /{tenantGuid}/api/v1/applications/{appGuid}/{osFamilyName} | Add a new app binary for a specific OS to an internal BlackBerry
Dynamics app entitlement.This path is not supported for Android devices with a work profile. |
DELETE /{tenantGuid}/api/v1/applications/{appGuid}/{osFamily} | Delete an app binary version from an internal BlackBerry
Dynamics app entitlement for a specified OS. |
Resource: Profiles
Path | Description |
---|---|
DELETE /{tenantGuid}/api/v1/profiles/{profileGuid} | Delete a profile. |
Resource: Users
Path | Description |
---|---|
POST /{tenantGuid}/api/v1/users/{userGuid}/applications | Assign one or more apps or app groups by GUID to a user account. |
Changes to existing paths and methods
Changes to existing paths and methods
Resource: Devices
Path | Changes |
---|---|
GET /{tenantGuid}/api/v1/devices | You can now query for a device by the dynamicsContainerID. If you query for devices by the dynamicsContainerID, the response includes the route for the specific BlackBerry Dynamics app. You can use this route to perform other actions (for example, to send device commands). |
Resource: Groups
Path | Changes |
---|---|
POST /{tenantGuid}/api/v1/groups/{groupGuid}/applications | You can now assign application groups to user groups. |
Resource: Users
Path | Improvement |
---|---|
GET /{tenantGuid}/api/v1/users | The query parameter includes a new isAdmin field, to filter results based on whether the user is an administrator. |
GET /{tenantGuid}/api/v1/users/{userGuid}/groups | This method has been deprecated and replaced by a new implementation (same path) that uses new request parameters (Accept, userGuid, query). |
POST /{tenantGuid}/api/v1/users/{userGuid}/userDevices/ {userDeviceGuid}/applications/{appGuid}/commands | The ATTEST_APPLICATION command type is new in this release. |
POST /{tenantGuid}/api/v1/users/{userGuid}/userDevices/ {userDeviceGuid}/commands | The ATTEST_DEVICE command type is new in this release. |
New data types
New data types
Type | Description |
---|---|
Application groups | A collection of app groups |
ApplicationGroup | An app group defined in BlackBerry UEM |
Attestation info | The latest information about the attestation performed by an app |
BlackBerry Dynamics app entitlement | A BlackBerry
Dynamics app entitlement |
Error codes | A full list of error IDs and subStatusCodes |
Group assignment | A group that a user is assigned to |
Group assignments | A collection of group assignments |
User device attestation | Information about the current configuration for device attestation |
Changes to data types
Changes to data types
Data type | Changes |
---|---|
Application | The following properties are new in this release: description, entitlementId, packageId, packageIdWindows10, categories, reviewMode. |
Application Server | The following properties are new in this release: applicationId, profileName. |
Application assignment | The applicationGroup property is new in this release. |
Error | The id property is new in this release. |
Profile | The disabledPlatforms property is new in this release. |
Profile categories | The GOOD_DYNAMICS_CONNECTIVITY category name is now officially deprecated and replaced with BLACKBERRY_DYNAMICS_CONNECTIVITY. The GOOD_DYNAMICS_SECURITY category name is now officially deprecated and replaced with BLACKBERRY_DYNAMICS_SECURITY. The old category names are no longer supported and will throw unsupported errors. |
User | The admin property is new in this release (indicates whether the user had an administrator role). |
User detail | The admin property is new in this release (indicates whether the user had an administrator role). |
User device | The attestationInfo property is new in this release. |
User device application | The attestationInfo property is new in this release. |