Skip to content

Function: createUser() ​

ts
function createUser(
   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:72

Create user. By default created user will not be notified with email. If password field is not set then password will be randomly generated.

Parameters ​

ParameterType
clientClient
parameters{ active?: boolean; applicationKeys?: string[]; displayName?: string; emailAddress?: string; key?: string; name?: string; notification?: string; password?: string; self?: string; }
parameters.active?boolean
parameters.applicationKeys?string[]
parameters.displayName?string
parameters.emailAddress?string
parameters.key?string
parameters.name?string
parameters.notification?string
parameters.password?string
parameters.self?string
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; }>