Function updateUser

updateUser(
    client: Client,
    parameters: {
        body: {
            active?: boolean;
            applicationKeys?: string[];
            displayName?: string;
            emailAddress?: string;
            key?: string;
            name?: string;
            notification?: string;
            password?: string;
            self?: string;
            [key: string]: unknown;
        };
        key?: string;
        username?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        active?: boolean;
        applicationKeys?: string[];
        displayName?: string;
        emailAddress?: string;
        key?: string;
        name?: string;
        notification?: string;
        password?: string;
        self?: string;
        [key: string]: unknown;
    },
>
Modify user. The 'value' fields present will override the existing value. Fields skipped in request will not be changed.
Parameters
- client: Client
- parameters: {
      body: {
          active?: boolean;
          applicationKeys?: string[];
          displayName?: string;
          emailAddress?: string;
          key?: string;
          name?: string;
          notification?: string;
          password?: string;
          self?: string;
          [key: string]: unknown;
      };
      key?: string;
      username?: string;
  }
  - body: {
        active?: boolean;
        applicationKeys?: string[];
        displayName?: string;
        emailAddress?: string;
        key?: string;
        name?: string;
        notification?: string;
        password?: string;
        self?: string;
        [key: string]: unknown;
    }
  - Optionalkey?: string
    
    User key
  - Optionalusername?: string
    
    The username
- Optionaloptions: RequestOptions
Returns Promise<
    {
        active?: boolean;
        applicationKeys?: string[];
        displayName?: string;
        emailAddress?: string;
        key?: string;
        name?: string;
        notification?: string;
        password?: string;
        self?: string;
        [key: string]: unknown;
    },
>
- Defined in src/server/api/users.ts:98

Function updateUser

Parameters

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

`Optional`key?: string

`Optional`username?: string

Settings

Function updateUser

Parameters

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

Optionalkey?: string

Optionalusername?: string

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

Settings

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

`Optional`key?: string

`Optional`username?: string

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