<filename>PHP/updateUser.json
{
	"name": "Homegear::updateUser",
	"category": "Users and Groups",
	"shortDescription": "Updates the password of an existing user",
	"description": "This method updates the password of an existing user in Homegear.",
	"signatures": [
		"bool updateUser($username, $password)",
		"bool updateUser($username, $groups)",
		"bool updateUser($username, $password, $groups)"
	],
	"parameters": [{
		"name": "username",
		"type": "string",
		"description": "The name of the user",
		"exampleValue": "will"
	}, {
		"name": "password",
		"type": "string",
		"description": "The new password of the user",
		"exampleValue": "<PASSWORD>"
	}, {
		"name": "groups",
		"type": "array",
		"description": "An array of group IDs the user should belong to",
		"exampleValue": "array(1, 7)"
	}],
	"returnValue": "Returns \"true\" on success",
	"errors": [{
		"code": "false",
		"description": "Something has gone wrong (e. g. the user does not exist)"
	}],
	"throws": [{
		"exception": "HomegearException",
		"description": "It is returned if parameters are invalid."
	}],
	"example": "<KEY>"
}
