Class UserService

See

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user

Hierarchy

CommonHttpService
- UserService

Index

Constructors

Methods

checkAccessByEmail createBulkUserLookup inviteByEmail initialize

Constructors

constructor

new UserService(getClientInstance): UserService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns UserService
Inherited from CommonHttpService.constructor

Methods

checkAccessByEmail

checkAccessByEmail(params): Promise<{
    emailsWithoutAccess?: string[];
    invalidEmails?: string[];
} & {
    [key: string]: unknown;
}>
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
- params: {
      requestBody: {
          emails: string[];
      } & {
          [key: string]: unknown;
      };
  }
  - requestBody: {
    emails: string[];
    } & {
    [key: string]: unknown;
    }
Returns Promise<{
    emailsWithoutAccess?: string[];
    invalidEmails?: string[];
} & {
    [key: string]: unknown;
}>
Returns object with list of emails without access to site.

Path
POST /user/access/check-access-by-email @scopes-current read:configuration:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user#api-user-access-check-access-by-email-post

createBulkUserLookup

createBulkUserLookup(params): Promise<{
    _links?: MultiEntityLinks;
    results?: User[];
} & {
    [key: string]: unknown;
}>
Returns user details for the ids provided in the request body.

Permissions required: Permission to access the Confluence site ('Can use' global permission). The user must be able to view user profiles in the Confluence site.
Parameters
- params: {
      requestBody: {
          accountIds: string[];
      } & {
          [key: string]: unknown;
      };
  }
  - requestBody: {
    accountIds: string[];
    } & {
    [key: string]: unknown;
    }
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: User[];
} & {
    [key: string]: unknown;
}>
Returned if the user info is returned for the account IDs. results may be empty if no account IDs were found.

Path
POST /users-bulk @scopes-current read:user:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user#api-users-bulk-post

inviteByEmail

inviteByEmail(params): Promise<void>
Invite a list of emails to the site.

Ignores all invalid emails and no action is taken for the emails that already have access to the site.

NOTE: This API is asynchronous and may take some time to complete.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
      requestBody: {
          emails: string[];
      } & {
          [key: string]: unknown;
      };
  }
  - requestBody: {
    emails: string[];
    } & {
    [key: string]: unknown;
    }
Returns Promise<void>
Path
POST /user/access/invite-by-email @scopes-current read:configuration:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user#api-user-access-invite-by-email-post

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize