user/count

Gets count 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}
}

Payload Parameters

Parameter Name	Required	Type	Description
action	Yes	string	Action name: user/count
requestId	No	object	Request unique identifier, will be passed back in the response message.
login	No	string	Filter by user login
loginPattern	No	string	Filter by user login pattern
role	No	integer	Filter by user role. 0 is Administrator, 1 is Client.
status	No	integer	Filter by user status. 0 is Active, 1 is Locked Out, 2 is Disabled.

Response Topic and Payload

Topic

dh/response/user/count@{clientId}

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "status": {string},
    "count": {integer}
}

Payload Parameters

Property Name	Type	Description
action	string	Action name: user/count
requestId	object	Request unique identifier as specified in the request message.
status	string	Operation execution status (success or error).
count	integer	Number of users that match the filters.