Shared Device Groups Resource

Provides access to shared device groups.

GET /{tenantGuid}/api/v1/sharedDeviceGroups

Available Since:
12.11.0

Get all shared device groups If no shared device groups are found, an empty shared device group list is included in the response body.

Sample request

 GET /SRP00000/api/v1/sharedDeviceGroups
 

Sample response body

 
 {
  "sharedDeviceGroups": [
     "guid": "3d55abd2-c00e-4f5f-abcf-01c92ac777b1",
     "name": "Class Room 17",
     "description": "Shared device group for Class room 17",
     "userOwner": "Class Room 17 owner",
     "disclaimer": "You agree to abide by the rules",
     "disclaimerEnabled": true
  },
  {
     "guid": "6106fce8-83f5-44b3-8288-e8e4e0966561",
     "name": "Edwards",
     "description": "Shared device group for Edwards",
     "userOwner": "Edwards",
     "disclaimer": "You agree to return the device at the end of class",
     "disclaimerEnabled": false
  }]
 }
 

Response Codes
Code Condition Data type
200 OK (even if no shared device groups are found).
400 Invalid request. For example, invalid field semantics or missing required field.
Response Body
Media type Data type Description
application/vnd.blackberry.shareddevicegroups-v1+json Shared device groups (JSON)

GET /{tenantGuid}/api/v1/sharedDeviceGroups/{sharedDeviceGroupGuid}

Available Since:
12.11.0

Get one shared device group by GUID.

Sample request

 GET /SRP00000/api/v1/sharedDeviceGroups/3d55abd2-c00e-4f5f-abcf-01c92ac777b1
 

Sample response body

 
 {
     "guid": "3d55abd2-c00e-4f5f-abcf-01c92ac777b1",
     "name": "Class Room 17",
     "description": "Shared device group for Class room 17",
     "userOwner": "Class Room 17 owner",
     "disclaimer": "You agree to abide by the rules",
     "disclaimerEnabled": true
 }
 

Request Parameters
Name Location Description
sharedDeviceGroupGuid path GUID of the shared device group to get
Response Codes
Code Condition Data type
200 OK.
400 Invalid request. For example, invalid field semantics or missing required field.
404 Shared device group not found.
Response Body
Media type Data type Description
application/vnd.blackberry.shareddevicegroup-v1+json Shared device group (JSON)

GET /{tenantGuid}/api/v1/sharedDeviceGroups/{sharedDeviceGroupGuid}/userDevices

Available Since:
12.11.0

Get all user devices from a shared device group by GUID.

Sample request

 GET /SRP00000/api/v1/sharedDeviceGroups/3d55abd2-c00e-4f5f-abcf-01c92ac777b1/userDevices
 

Sample response body

 
 {
  "userDevices": [{
     "links": [
     {
         "rel": "sharedDeviceGroup",
         "href": "https://server01:18084/SRP00000/api/v1/sharedDeviceGroups/3d55abd2-c00e-4f5f-abcf-01c92ac777b1"
     },
     {
         "rel": "user",
         "href": "https://server01:18084/SRP00000/api/v1/users/0a475c1e-0a43-4dd6-a4af-f9844934faee"
     }],
     "guid": "6dd3a8e2-3f24-48c6-961a-949794f4b554",
     "checkedOut": true,
     "clientVersion": "12.1.31",
     "dynamicsDeviceId": "kzsaj8JeVGtyWU6RY7Zh0jidClQ7BwKg",
     "enrollmentType": ["MDM_CONTROLS",
     "..."],
     "language": "en_US",
     "lastContactTime": "2017-01-01T11:04:30.45Z",
     "loggingExpiryDate": "...",
     "loggingStatus": "...",
     "device": {
             "guid": "ab28e066-d96d-4dc6-b6f7-69b1c1546bb8",
             "activationDate": "2017-01-01T11:04:30.45Z",
             "activeSyncId": "K6CKULJTID3SDEAIV0ELHBBTTO",
             "batteryLevel": 57.0,
             "compromised": false,
             "externalStorageFree": 11517.0,
             "externalStorageSize": 32768.0,
             "hardwareModel": "iPhone 5c (GSM)",
             "hardwareName": "iPhone5,3",
             "hardwareVendorCompanyName": "Apple Inc",
             "homeCarrier": "Rogers",
             "currentCarrier": "Vodafone",
             "networkRoaming": true,
             "iccid": "8938 0012 1050 8728 331",
             "internalStorageFree": 3556.0,
             "internalStorageSize": 4950.0,
             "imei": "01 400000 155119 5",
             "meid": "01234567890123456",
             "os": "iOS 10.2",
             "osFamilyName": "ios",
             "osVersion": "10.2",
             "ownership": "CORPORATE",
             "phoneNumber": "4045551234",
             "pin": "...",
             "securityPatchLevel": "...",
             "serialNumber": "FCFPL5T3G07J",
             "udid": "d88496fdf7115ac9f3ab69966cbaf91d960b95036fa68f66489c8ad78f136b5c",
             "wifiMacAddress": "b4:52:7e:62:a5:9a"
     },
     "outOfComplianceInfo": [{
             "date": "2017-01-01T11:04:30.45Z",
             "reason": "jailbroken",
             "displayName": "Integrity alert"
     },
     {
             "date": "2017-01-01T11:04:30.45Z",
             "reason": "blacklistedappsinstalled",
             "displayName": "Restricted app is installed"
     }],
     "service": {
             "guid": "f1c4a4e2-a1b6-4b6d-9276-086858eede0e",
             "name": "mdm",
             "displayName": "..."
     },
     "deviceLocation": {
             "latitude": 35.4342193603516,
             "longitude": -91.21865759666542,
             "altitude": 172.4342193603516,
             "speed": 0.5,
             "direction": 85.83,
             "accuracy": 2.0,
             "type": "GPS",
             "timestamp": "2017-01-01T11:04:30.45Z"
     },
     "attestationInfo": [{
             "type": "SAFETYNET",
             "lastAttestationResponseReceived": "2017-01-01T11:04:30.45Z",
             "status": "SUCCESS",
             "attestationNote": "RESTORE_TO_FACTORY_ROM"
     },
     {
             "type": "KNOX",
             "lastAttestationResponseReceived": "2017-01-14T16:40:03.54Z",
             "status": "INVALID_NONCE",
             "attestationNote": "NONE"
     }],
     "osUpdateStatus": {
             "latestVersion": "12.4",
             "otherVersions": [
                 "12.3.2",
                 "12.3.1",
                 "12.3"
             ],
             "attempts": "3",
             "attemptsRemaining": "27",
             "latestResponse": "The update is already downloaded.",
             "timestamp": "2019-09-03T11:02:12.340Z",
             "updateIsAvailable": true,
             "isLatest": false
     }
  },
  {
     "links": [
     {
         "rel": "sharedDeviceGroup",
         "href": "https://server01:18084/SRP00000/api/v1/sharedDeviceGroups/3d55abd2-c00e-4f5f-abcf-01c92ac777b1"
     }],
     "guid": "2d2d3a7f-076d-46f9-8c25-56cb8eba2800",
     "checkedOut": false,
     "clientVersion": "...",
     "dynamicsDeviceId": "...",
     "enrollmentType": ["...",
     "MDM_CONTROLS"],
     "language": "ja_JP",
     "lastContactTime": "2017-01-14T16:40:03.54Z",
     "loggingExpiryDate": "...",
     "loggingStatus": "...",
     "device": {
             "guid": "0df98f33-ece9-49c7-abf5-c81750e59adc",
             "activationDate": "2017-01-01T11:04:30.45Z",
             "activeSyncId": "Q633AGG6QP3FJF6QBNAA81UHB0",
             "batteryLevel": 100.0,
             "compromised": false,
             "externalStorageFree": 16322.0,
             "externalStorageSize": 131072.0,
             "hardwareModel": "Q10",
             "hardwareName": "2214602506",
             "hardwareVendorCompanyName": "BlackBerry",
             "homeCarrier": "...",
             "currentCarrier": "...",
             "networkRoaming": true,
             "iccid": "8938 0012 1050 8728 331",
             "internalStorageFree": 10258.0,
             "internalStorageSize": 16384.0,
             "imei": "004402242062465",
             "meid": "...",
             "os": "BB 10.3.3",
             "osFamilyName": "BB",
             "osVersion": "10.3.3",
             "ownership": "UNKNOWN",
             "phoneNumber": "2125557890",
             "pin": "2668C366",
             "securityPatchLevel": "...",
             "serialNumber": "064439997440",
             "udid": "82f2aaa813c5a4bc2748b078ca844bdbd6a8fb8eaaa173a389467646cf04d00c",
             "wifiMacAddress": "34:bb:1f:f3:34:a2"
     },
     "outOfComplianceInfo": [{
             "date": "2017-01-01T11:04:30.45Z",
             "reason": "blacklistedappsinstalled",
             "displayName": "Restricted app is installed"
     },
     {
             "date": "2017-01-01T11:04:30.45Z",
             "reason": "blacklistedappsinstalled",
             "displayName": "Restricted app is installed"
     }],
     "service": {
             "guid": "...",
             "name": "...",
             "displayName": "..."
     },
     "deviceLocation": {
             "latitude": 50.03719587055436,
             "longitude": 36.21865759666543,
             "altitude": 1.5,
             "speed": 66.2,
             "direction": 11.0,
             "accuracy": 170.235,
             "type": "USER",
             "timestamp": "2017-01-14T16:40:03.54Z"
     },
     "attestationInfo": [{
             "type": "KNOX",
             "lastAttestationResponseReceived": "2017-01-14T16:40:03.54Z",
             "status": "INVALID_NONCE",
             "attestationNote": "NONE"
     },
     {
             "type": "KNOX",
             "lastAttestationResponseReceived": "2017-01-14T16:40:03.54Z",
             "status": "INVALID_NONCE",
             "attestationNote": "NONE"
     }],
     "osUpdateStatus": {
         "latestVersion": "12.4",
         "otherVersions": [
             "12.3.2",
             "12.3.1",
             "12.3"
         ],
         "attempts": "3",
         "attemptsRemaining": "27",
         "latestResponse": "The update is already downloaded.",
         "timestamp": "2019-09-03T11:02:12.340Z",
         "updateIsAvailable": true,
         "isLatest": false
     },
     "maliciousApplications": [{
             "package": "com.dodgy.app.xyz",
             "name": "Sample App One",
             "version": "2.0.0.34",
             "hash": "kdfjdkasdkjsakljdslkfjdskfjdsk212asdsakj"
     },
     {
             "package": "com.phishing.app.abc",
             "name": "Sample App Two",
             "version": "5.0.0.34",
             "hash": "rtykdtrtkjsakljdgdgdkfjgddgd235sfndkfndk"
     }],
     "maliciousSystemApplications": [{
             "package": "com.dodgy.sys.app.xyz",
             "name": "Sample System App One",
             "version": "3.0.0.34",
             "hash": "syskdfjdkasdkjsakljdslkfjdskfjdsk212asds"
     },
     {
             "package": "com.phishing.sys.app.abc",
             "name": "Sample System App Two",
             "version": "4.0.0.34",
             "hash": "sysrtykdtrtkjsakljdgdgdkfjgddgd235sfndkf"
     }]
  }]
 }
 

Request Parameters
Name Location Description
sharedDeviceGroupGuid path Guid of the shared device group to get the UserDevices from
Response Codes
Code Condition Data type
200 OK.
400 Invalid request. For example, invalid field semantics or missing required field.
404 Shared device group not found.
Response Body
Media type Data type Description
application/vnd.blackberry.userdevices-v1+json User devices (JSON)

GET /{tenantGuid}/api/v1/sharedDeviceGroups/{sharedDeviceGroupGuid}/userDevices/{userDeviceGuid}

Available Since:
12.11.0

Get the details of a user device from a shared device group by GUID.

Sample request

 GET /SRP00000/api/v1/sharedDeviceGroups/3d55abd2-c00e-4f5f-abcf-01c92ac777b1/devices/6dd3a8e2-3f24-48c6-961a-949794f4b554
 

Sample response body

 
 {
     "links": [
     {
         "rel": "sharedDeviceGroup",
         "href": "https://server01:18084/SRP00000/api/v1/sharedDeviceGroups/3d55abd2-c00e-4f5f-abcf-01c92ac777b1"
     },
     {
         "rel": "user",
         "href": "https://server01:18084/SRP00000/api/v1/users/0a475c1e-0a43-4dd6-a4af-f9844934faee"
     }],
     "guid" : "6dd3a8e2-3f24-48c6-961a-949794f4b554",
     "checkedOut" : true,
     "clientVersion" : "12.1.31",
     "dynamicsDeviceId" : "kzsaj8JeVGtyWU6RY7Zh0jidClQ7BwKg",
     "enrollmentType" : [ "MDM_CONTROLS", "..." ],
     "language" : "en_US",
     "lastContactTime" : "2017-01-01T11:04:30.45Z",
     "loggingExpiryDate" : "...",
     "loggingStatus" : "...",
     "device" : {
       "guid" : "ab28e066-d96d-4dc6-b6f7-69b1c1546bb8",
       "activationDate" : "2017-01-01T11:04:30.45Z",
       "activeSyncId" : "K6CKULJTID3SDEAIV0ELHBBTTO",
       "batteryLevel" : 57.0,
       "compromised" : false,
       "externalStorageFree" : 11517.0,
       "externalStorageSize" : 32768.0,
       "hardwareModel" : "iPhone 5c (GSM)",
       "hardwareName" : "iPhone5,3",
       "hardwareVendorCompanyName" : "Apple Inc",
       "homeCarrier" : "Rogers",
       "currentCarrier" : "Vodafone",
       "networkRoaming" : true,
       "iccid": "8938 0012 1050 8728 331",
       "internalStorageFree" : 3556.0,
       "internalStorageSize" : 4950.0,
       "imei" : "01 400000 155119 5",
       "meid" : "01234567890123456",
       "os" : "iOS 10.2",
       "osFamilyName" : "ios",
       "osVersion" : "10.2",
       "ownership" : "CORPORATE",
       "phoneNumber" : "4045551234",
       "pin" : "...",
       "securityPatchLevel" : "...",
       "serialNumber" : "FCFPL5T3G07J",
       "udid" : "d88496fdf7115ac9f3ab69966cbaf91d960b95036fa68f66489c8ad78f136b5c",
       "wifiMacAddress" : "b4:52:7e:62:a5:9a"
     },
     "outOfComplianceInfo" : [ {
       "date" : "2017-01-01T11:04:30.45Z",
       "reason" : "jailbroken",
       "displayName" : "Integrity alert"
     }, {
       "date" : "2017-01-01T11:04:30.45Z",
       "reason" : "blacklistedappsinstalled",
       "displayName" : "Restricted app is installed"
     } ],
     "service" : {
       "guid" : "f1c4a4e2-a1b6-4b6d-9276-086858eede0e",
       "name" : "mdm",
       "displayName" : "..."
     },
     "deviceLocation" : {
       "latitude" : 35.4342193603516,
       "longitude" : -91.21865759666542,
       "altitude" : 172.4342193603516,
       "speed" : 0.5,
       "direction" : 85.83,
       "accuracy" : 2.0,
       "type" : "GPS",
       "timestamp" : "2017-01-01T11:04:30.45Z"
     },
     "attestationInfo" : [ {
       "type" : "SAFETYNET",
       "lastAttestationResponseReceived" : "2017-01-01T11:04:30.45Z",
       "status" : "SUCCESS",
       "attestationNote" : "RESTORE_TO_FACTORY_ROM"
     },
     {
       "type" : "KNOX",
       "lastAttestationResponseReceived" : "2017-01-14T16:40:03.54Z",
       "status" : "INVALID_NONCE",
       "attestationNote" : "NONE"
     } ],
     "osUpdateStatus": {
       "latestVersion": "12.4",
       "otherVersions": [
         "12.3.2",
         "12.3.1",
         "12.3"
       ],
       "attempts": "3",
       "attemptsRemaining": "27",
       "latestResponse": "The update is already downloaded.",
       "timestamp": "2019-09-03T11:02:12.340Z",
       "updateIsAvailable": true,
       "isLatest": false
     },
     "maliciousApplications": [{
       "package": "com.dodgy.app.xyz",
       "name": "Sample App One",
       "version": "2.0.0.34",
       "hash": "kdfjdkasdkjsakljdslkfjdskfjdsk212asdsakj"
     },
     {
       "package": "com.phishing.app.abc",
       "name": "Sample App Two",
       "version": "5.0.0.34",
       "hash": "rtykdtrtkjsakljdgdgdkfjgddgd235sfndkfndk"
     }],
     "maliciousSystemApplications": [{
       "package": "com.dodgy.sys.app.xyz",
       "name": "Sample System App One",
       "version": "3.0.0.34",
       "hash": "syskdfjdkasdkjsakljdslkfjdskfjdsk212asds"
     },
     {
       "package": "com.phishing.sys.app.abc",
       "name": "Sample System App Two",
       "version": "4.0.0.34",
       "hash": "sysrtykdtrtkjsakljdgdgdkfjgddgd235sfndkf"
     }]
 }
 

Request Parameters
Name Location Description
sharedDeviceGroupGuid path GUID of the shared device group to get device from
userDeviceGuid path GUID of the user device to get
Response Codes
Code Condition Data type
200 OK.
400 Invalid request. For example, invalid field semantics or missing required field.
404 Shared device group not found.

Device not found.

Response Body
Media type Data type Description
application/vnd.blackberry.userdevice-v1+json User device (JSON)