Get Device Info
This API returns all the registered online and offline devices.
Resource Informations
Name | Value |
---|---|
Requires authentication? | Yes |
Rate limited? | No |
Request
Request headers
Key | Value |
---|---|
Authorization | Bearer token |
Content-Type | application/json |
HTTP request URL for SSMS
GET https://{tenantId}.{hostname}/digitanium/v4/devices/{deviceid}
HTTP request URL for SHIFT
GET https://{hostname}/auth/realms/{tenantId}/v3_device/{deviceid}
note
At this moment, this API is applicable only for SSMS based installations.
note
API requests must be made over https. Calls made over plain http will fail.
Parameters
No parameter fields are required.
Request body
No request body fields are required.
Response
Field Name | Type | Description |
---|---|---|
message | String | Message explains result of the API call. Refer Response status Information for details. |
status | String | The status of the API call. Refer Response status Information for details. |
subSystem | Integer | subSystem categorizes the type of API that has been called. Refer Subsystem details for details. |
data | Array | List of all device details. Refer Data Representation for details. |
Sample Response
{
"data": {
"appName": "Android-QR-Dev2-FbTest",
"appVersion": "2.0.7",
"certificateSerialNumber": "2033460708",
"clientDevice": "OnePlus: AC2001",
"clientOsVersion": "10",
"clientTypeName": "Android_ARMv8a",
"deviceId": "4501",
"deviceState": "OFFLINE",
"deviceType": "SOFTWARE",
"deviceTypeName": "VIRTUAL_DEVICE",
"deviceVersion": "0.0.0",
"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
"lastLoginTime": "1601221468",
"locked": false,
"nodeID": "node",
"userLocked": false
},
"message": "Devices info fetched successfully",
"status": "OK",
"subSystem": 6
}
Data Representation
Field Name | Type | Description |
---|---|---|
appName | String | name of app used on device |
appVersion | String | version of app used on device |
certHandle | String | represents DeviceId |
certificateSerialNumber | Integer | Certificate serial number |
clientDevice | String | Hardware informations of device |
clientOsVersion | Integer | Software Version of device |
clientRisks | String | Risk gather during last request from device |
clientTypeName | String | client type name (Example: Android_ARM, Android_ARMv7a, Android_ARMv8a, ANDROID_*86, iOS_ARM64, iOS_ARMV7, iOS_ARMV7s, Windowsphone_ARMV7, Windowsphone_Emu, MAC_OS, SignDot, SignPod, and WINDOWS) |
deviceState | String | ONLINE - device has active session to the server. OFFLINE - device has no active session to the server |
deviceType | String | Type of devices (Example: MIDENTITY_MINI, MIDENTITY_AIR, and MIDENTITY_AIR_PLUS) |
deviceTypeName | String | VIRTUAL_DEVICE - this mean it is software device |
deviceVersion | String | Hardware version. Software version has 0.0.0 |
issuerDN | String | The CA that issues the certificate. |
lastLoginTime | Date | Last login. epoch timestamp. |
lockReasonKey | String | Lock reasons (Example: Defect, Stolen, PIN was wrong, Lost, Too many tries, Locked Manually, and unknown) |
locked | String | true - device is locked, false - device is unlocked and ready to use. |
lockedUntilDate | Date | Dateuntil temporary lock is created. This is mostly due to timebase or temporary locking. |
nodeID | String | which node is deviced binded with active session |
userLocked | Boolean | true - when user device is locked, false - when user device is already locked, null - when user device does not exist. |
Response Status Information
Status Code | Status | Message |
---|---|---|
200 | OK | Devices info fetched successfully |
400 | BAD_REQUEST | DeviceID should not be null or empty |
401 | Unauthorized | HTTP 401 Unauthorized |
404 | DEVICE_NOT_FOUND | Device does not exist |