user/update

Updates an existing user.

Only administrators are allowed to update any property of any user. User-level accounts can only change their own password and data fields.

Authorization

Access JSON Web Token (UpdateCurrentUser)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "userId": {integer},
    "user": {
        "login": {string},
        "role": {integer},
        "status": {integer},
        "password": {string},
        "data": {object},
        "introReviewed": {boolean}
        
    }
}

Payload Parameters

Property NameRequiredTypeDescription
actionYesstringAction name: user/update
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
userIdYesintegerUser identifier. Use the 'current' keyword to update information of the current user.
userYesobjectUser object
user.loginNostringUser login using during authentication.
user.roleNointegerUser role. Available values:
0: Administrator role
1: Client role
user.statusNointegerUser 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
user.dataNoobjectUser data, a JSON object with an arbitrary structure.
user.passwordNostringUser new password
user.dataYesobjectUser data, a JSON object with an arbitrary structure.
user.introReviewedNobooleanIndicates if user reviewed an intro.

Response Topic and Payload

Topic

dh/response/user/update@{clientId}

Payload Representation

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

Payload Parameters

Property NameTypeDescription
actionstringAction name: user/update
requestIdobjectRequest unique identifier, will be passed back in the response message.
statusstringOperation execution status (success or error).