Gets list of users.

Authorization

Access JSON Web Token (ManageUser)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "login": {string},
    "loginPattern": {string},
    "role": {integer},
    "status": {integer},
    "sortField": {string},
    "sortOrder": {string},
    "take": {integer},
    "skip": {integer}
}

Payload Parameters

Parameter NameRequiredTypeDescription
actionYesstringAction name: user/list
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
loginNostringFilter by user login
loginPatternNostringFilter by user login pattern
roleNointegerFilter by user role. 0 is Administrator, 1 is Client.
statusNointegerFilter by user status. 0 is Active, 1 is Locked Out, 2 is Disabled.
sortFieldNostringResult list sort field. Available values are ID and Login.
sortOrderNostringResult list sort order. Available values are ASC and DESC.
takeNointegerNumber of records to take from the result list.
skipNointegerNumber of records to skip from the result list.

Response Topic and Payload

Topic

dh/response/user/list@{clientId}

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "status": {string},
    "users": [{
        "id": {long},
        "login": {string},
        "role": {integer},
        "status": {integer},
        "lastLogin": {datetime},
        "data": {object},
        "introReviewed": {boolean}
    }]
}

Payload Parameters

Property NameTypeDescription
idlongUser identifier.
loginstringUser login using during authentication.
roleintegerUser role. Available values:
0: Administrator role
1: Client role
statusintegerUser status. Available values:
0: The user is active
1: The user has been locked out due to invalid login attempts
2: The user has been disabled
lastLogindatetimeUser last login timestamp (UTC).
dataobjectUser data, a JSON object with an arbitrary structure.
introReviewedbooleanIndicates if user reviewed an intro.