Gets count of users.

Request Message


Access JSON Web Token (ManageUser)

Message Representation

    "action": {string},
    "requestId": {object},
    "login": {string},
    "loginPattern": {string},
    "role": {integer},
    "status": {integer}


Parameter NameRequiredTypeDescription
actionYesstringAction name: user/count
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.

Server Message

Message Representation

    "action": {string},
    "requestId": {object},
    "status": {string},
    "count": {integer}
Property NameTypeDescription
actionstringAction name: user/count
requestIdobjectRequest unique identifier as specified in the request message.
statusstringOperation execution status (success or error).
countintegerNumber of users that match the filters.