Skip to content

Function: checkAccessByEmail()

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

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

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

ParameterType
clientClient
parameters{ body?: Record&lt;string, any>; }
parameters.body?Record&lt;string, any>

Returns

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