Get User Devices

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

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/users/{userName}/devices

HTTP request URL for SHIFT

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

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 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 Name	Type	Description
appName	String	name of app used on device
appVersion	String	version of app used on device
deviceid	String	Represents DeviceId
certificateSerialNumber	String	Certificate serial number
clientDevice	String	Hardware informations of device
clientOsVersion	String	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	IssuedDN of certificate.
lastLoginTime	String	Last login. epoch timestamp.
lockReasonKey	String	Lock reasons (Example: Defect, Stolen, PIN was wrong, Lost, Too many tries, Locked Manually, and unknown)
locked	Boolean	true - device is locked, false - device is unlocked and ready to use. Defaults to false.
nodeID	String	which node is deviced binded with active session
userLocked	Boolean	when user is locked, the user should not be allowed to login to device. Defaults to false.

Response Status Information

Status Code	Status	Message
200	OK	Devices list for user fetched successfully
401	Unauthorized	HTTP 401 Unauthorized
404	USER_NOT_FOUND	User does not exist