Skip to main content

Get Device Info

This API returns all the registered online and offline devices.

Resource Informations

NameValue
Requires authentication?Yes
Rate limited?No

Request

Request headers

KeyValue
AuthorizationBearer token
Content-Typeapplication/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 NameTypeDescription
messageStringMessage explains result of the API call. Refer Response status Information for details.
statusStringThe status of the API call. Refer Response status Information for details.
subSystemIntegersubSystem categorizes the type of API that has been called. Refer Subsystem details for details.
dataArrayList 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 NameTypeDescription
appNameStringname of app used on device
appVersionStringversion of app used on device
certHandleStringrepresents DeviceId
certificateSerialNumberIntegerCertificate serial number
clientDeviceStringHardware informations of device
clientOsVersionIntegerSoftware Version of device
clientRisksStringRisk gather during last request from device
clientTypeNameStringclient 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)
deviceStateStringONLINE - device has active session to the server. OFFLINE - device has no active session to the server
deviceTypeStringType of devices (Example: MIDENTITY_MINI, MIDENTITY_AIR, and MIDENTITY_AIR_PLUS)
deviceTypeNameStringVIRTUAL_DEVICE - this mean it is software device
deviceVersionStringHardware version. Software version has 0.0.0
issuerDNStringThe CA that issues the certificate.
lastLoginTimeDateLast login. epoch timestamp.
lockReasonKeyStringLock reasons (Example: Defect, Stolen, PIN was wrong, Lost, Too many tries, Locked Manually, and unknown)
lockedStringtrue - device is locked, false - device is unlocked and ready to use.
lockedUntilDateDateDateuntil temporary lock is created. This is mostly due to timebase or temporary locking.
nodeIDStringwhich node is deviced binded with active session
userLockedBooleantrue - when user device is locked, false - when user device is already locked, null - when user device does not exist.

Response Status Information

Status CodeStatusMessage
200OKDevices info fetched successfully
400BAD_REQUESTDeviceID should not be null or empty
401UnauthorizedHTTP 401 Unauthorized
404DEVICE_NOT_FOUNDDevice does not exist