Function: updateUser()

function updateUser(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationKeys?: string[];
  displayName?: string;
  emailAddress?: string;
  key?: string;
  name?: string;
  notification?: string;
  password?: string;
  self?: string;
}>;

Defined in: src/server/api/users.ts:98

Modify user. The 'value' fields present will override the existing value. Fields skipped in request will not be changed.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ body: { active?: boolean; applicationKeys?: string[]; displayName?: string; emailAddress?: string; key?: string; name?: string; notification?: string; password?: string; self?: string; }; key?: string; username?: string; }	-
parameters.body	{ active?: boolean; applicationKeys?: string[]; displayName?: string; emailAddress?: string; key?: string; name?: string; notification?: string; password?: string; self?: string; }	-
parameters.body.active?	boolean	-
parameters.body.applicationKeys?	string[]	-
parameters.body.displayName?	string	-
parameters.body.emailAddress?	string	-
parameters.body.key?	string	-
parameters.body.name?	string	-
parameters.body.notification?	string	-
parameters.body.password?	string	-
parameters.body.self?	string	-
parameters.key?	string	User key
parameters.username?	string	The username
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; active?: boolean; applicationKeys?: string[]; displayName?: string; emailAddress?: string; key?: string; name?: string; notification?: string; password?: string; self?: string; }>