Skip to main content
Version: 4.18.1

Get User Devices

Returns all the registered online and offline devices for the given user.

Resource Informations

Requires authentication?Yes
Rate limited?No


Request headers

AuthorizationBearer token

HTTP request URL for SSMS

GET https://{tenantId}.{hostname}/digitanium/v4/users/{userName}/devices

HTTP request URL for SHIFT

GET https://{hostname}/auth/realms/{tenantId}/v3_user/devices/{userName}

At this moment, this API is applicable only for SSMS based installations.


API requests must be made over https. Calls made over plain http will fail.


No parameter fields are required.

Request body

No request body fields are required.


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 User device details for the given userId. Refer Data Representation for details.

Sample Response

"data": [
"locked": false,
"issuerDN": "CN=asm internal ca 96D7695E-641B-6386-E053-0100007F9C7E,UID=t4A2Avoh73,O=KOBIL SYSTEMS,C=DE",
"deviceState": "OFFLINE",
"userLocked": false,
"nodeID": "node",
"certificateSerialNumber": "1234567890",
"clientDevice": "CLIENT_DEVICE",
"clientOsVersion": "9",
"clientTypeName": "Android_ARMv8a",
"deviceTypeName": "VIRTUAL_DEVICE",
"deviceVersion": "0.0.0",
"lastLoginTime": "1588760474",
"appName": "Android-SIGN-Dev",
"deviceId": "DEVICE_ID",
"appVersion": "2.0.7",
"deviceType": "SOFTWARE"
"message": "Devices list for user fetched successfully",
"status": "OK",
"subSystem": 5

Data Representation

Field NameTypeDescription
appNameStringname of app used on device
appVersionStringversion of app used on device
deviceidStringRepresents DeviceId
certificateSerialNumberStringCertificate serial number
clientDeviceStringHardware informations of device
clientOsVersionStringSoftware Version of device
clientRisksStringRisk gather during last request from device
clientTypeNameStringclient type name (Example: AndroidARM, 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
issuerDNStringIssuedDN of certificate.
lastLoginTimeStringLast login. epoch timestamp.
lockReasonKeyStringLock reasons (Example: Defect, Stolen, PIN was wrong, Lost, Too many tries, Locked Manually, and unknown)
lockedBooleantrue - device is locked, false - device is unlocked and ready to use. Defaults to false.
nodeIDStringwhich node is deviced binded with active session
userLockedBooleanwhen user is locked, the user should not be allowed to login to device. Defaults to false.

Response Status Information

Status CodeStatusMessage
200OKDevices list for user fetched successfully
401UnauthorizedHTTP 401 Unauthorized
404USER_NOT_FOUNDUser does not exist