Function: checkAccessByEmail()

function checkAccessByEmail(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  emailsWithoutAccess?: string[];
  invalidEmails?: string[];
  noAccessEmails?: unknown[];
}>;

Defined in: src/v2/api/user.ts:36

Returns the list of emails from the input list that do not have access to site.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Parameters

Parameter	Type
client	Client
parameters	{ body?: Record<string, any>; }
parameters.body?	Record<string, any>
options?	RequestOptions

Returns

Promise<{ [key: string]: unknown; emailsWithoutAccess?: string[]; invalidEmails?: string[]; noAccessEmails?: unknown[]; }>