Skip to content

Function: createCustomer() ​

ts
function createCustomer(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     avatarUrls?: Record<string, any>;
     jiraRest?: string;
     self?: string;
  };
  active?: boolean;
  displayName?: string;
  emailAddress?: string;
  key?: string;
  name?: string;
  timeZone?: string;
}>;

Defined in: src/serviceDeskServer/api/customers.ts:21

Creates a customer that is not associated with a service project.

The customer's username is their email address. They can set a password by clicking "Forgotten your password" onthe portal login screen, or a Jira administrator can set one in User Management. By default, the customer canemail requests to public service projects. If they have a password, they can also raise requests in customer portals that allowpublic signup. To raise requests in closed service projects, the customer must be added to a service projectusing Add customers.

This operation does not cause invitation email to be sent to the newly created customer.

Jira administrator global permission is required to create a customer.

Parameters ​

ParameterType
clientClient
parameters{ email?: string; fullName?: string; }
parameters.email?string
parameters.fullName?string
options?RequestOptions

Returns ​

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; avatarUrls?: Record<string, any>; jiraRest?: string; self?: string; }; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }>