userupdate.md

title	slug	excerpt	hidden	metadata	createdAt	updatedAt
user/update	userupdate		false	image robots index	Mon Jul 31 2017 07:28:19 GMT+0000 (Coordinated Universal Time)	Tue Feb 18 2025 13:02:59 GMT+0000 (Coordinated Universal Time)

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.

Request Message

Authorization

Access JSON Web Token (UpdateCurrentUser)

Message Representation

In the message, supply a User resource.

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

Message Parameters

[block:parameters] { "data": { "h-0": "Property Name", "h-1": "Required", "h-2": "Type", "h-3": "Description", "0-0": "action", "0-1": "Yes", "0-2": "string", "0-3": "Action name: user/update", "1-0": "requestId", "1-1": "No", "1-2": "object", "1-3": "Request unique identifier, will be passed back in the response message.", "2-0": "userId", "2-1": "Yes", "2-2": "integer", "2-3": "User identifier. Use the 'current' keyword to update information of the current user.", "3-0": "user", "3-1": "Yes", "3-2": "object", "3-3": "User object", "4-0": "user.login", "4-1": "No", "4-2": "string", "4-3": "User login using during authentication.", "5-0": "user.role", "5-1": "No", "5-2": "integer", "5-3": "User role. Available values: \n0: Administrator role \n1: Client role", "6-0": "user.status", "6-1": "No", "6-2": "integer", "6-3": "User status. Available values: \n0: The user is active \n1: The user has been locked out due to invalid login attempts \n2: The user has been disabled", "7-0": "user.data", "7-1": "No", "7-2": "object", "7-3": "User data, a JSON object with an arbitrary structure.", "8-0": "user.password", "8-1": "No", "8-2": "string", "8-3": "User new password", "9-0": "user.data", "9-1": "Yes", "9-2": "object", "9-3": "User data, a JSON object with an arbitrary structure.", "10-0": "user.introReviewed", "10-1": "No", "10-2": "boolean", "10-3": "Indicates if user reviewed an intro." }, "cols": 4, "rows": 11, "align": [ "left", "left", "left", "left" ] } [/block]

Response Message

Message Representation

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

Message Parameters

Property Name	Type	Description
action	string	Action name: user/update
requestId	object	Request unique identifier, will be passed back in the response message.
status	string	Operation execution status (success or error).