Class UsersService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users

Hierarchy

CommonHttpService
- UsersService

Index

Constructors

Methods

getAnonymousUser getBulkUserLookup getCurrentUser getGroupMembershipsForUser getPrivacyUnsafeUserEmail getPrivacyUnsafeUserEmailBulk getUser initialize

Constructors

constructor

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

Methods

getAnonymousUser

getAnonymousUser(params?): Promise<UserAnonymous>
Returns information about how anonymous users are represented, like the profile picture and display name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
  expand?: "operations"[];
  } = {}
  - Optionalexpand?: "operations"[]
    A multi-value parameter indicating which properties of the user to expand.
    
    operations returns the operations that the user is allowed to do.
Returns Promise<UserAnonymous>
Returned if the anonymous user representation is returned.

Path
GET /wiki/rest/api/user/anonymous @scopes-current read:confluence-user @scopes-beta read:user:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users#api-wiki-rest-api-user-anonymous-get

getBulkUserLookup

getBulkUserLookup(params): Promise<BulkUserLookupArray>
Returns user details for the ids provided in the request. Currently this API returns a maximum of 100 results. If more than 100 account ids are passed in, then the first 100 will be returned.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
  accountId: string;
  expand?: ("operations" | "isExternalCollaborator" | "personalSpace")[];
  }
  - accountId: string
    A list of accountId's of users to be returned.
  - Optionalexpand?: ("operations" | "isExternalCollaborator" | "personalSpace")[]
    A multi-value parameter indicating which properties of the user to expand.
    
    operations returns the operations that the user is allowed to do.
    
    personalSpace returns the user's personal space, if it exists.
    
    isExternalCollaborator(@deprecated) use isGuest instead to return whether the user is a guest.
Returns Promise<BulkUserLookupArray>
Returned if, the list of users is returned.

Path
GET /wiki/rest/api/user/bulk @scopes-current read:confluence-user @scopes-beta read:content-details:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users#api-wiki-rest-api-user-bulk-get

getCurrentUser

getCurrentUser(params?): Promise<null | UserV1>
Returns the currently logged-in user. This includes information about the user, like the display name, userKey, account ID, profile picture, and more.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
  expand?: ("operations" | "isExternalCollaborator" | "personalSpace")[];
  } = {}
  - Optionalexpand?: ("operations" | "isExternalCollaborator" | "personalSpace")[]
    A multi-value parameter indicating which properties of the user to expand.
    
    operations returns the operations that the user is allowed to do.
    
    personalSpace returns the user's personal space, if it exists.
    
    isExternalCollaborator(@deprecated) see isGuest in response to find out whether the user is a guest.
Returns Promise<null | UserV1>
Returned if the current user is returned.

Path
GET /wiki/rest/api/user/current @scopes-current read:confluence-user @scopes-beta read:content-details:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users#api-wiki-rest-api-user-current-get

getGroupMembershipsForUser

getGroupMembershipsForUser(params): Promise<GroupArrayWithLinks>
Returns the groups that a user is a member of.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
      accountId: string;
      limit?: number;
      start?: number;
  }
  - accountId: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
  - Optionallimit?: number
    The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.
  - Optionalstart?: number
    The starting index of the returned groups.
Returns Promise<GroupArrayWithLinks>
Returned if the requested groups are returned.

Path
GET /wiki/rest/api/user/memberof @scopes-current read:confluence-user @scopes-beta read:user:confluence, read:group:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users#api-wiki-rest-api-user-memberof-get

getPrivacyUnsafeUserEmail

getPrivacyUnsafeUserEmail(params): Promise<AccountIdEmailRecord>
Returns a user's email address regardless of the user’s profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelines. For Forge apps, this API only supports access via asApp() requests.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
  accountId: string;
  }
  - accountId: string
    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.
Returns Promise<AccountIdEmailRecord>
Returned if the requested user's email is returned.

Path
GET /wiki/rest/api/user/email @scopes-beta read:email-address:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users#api-wiki-rest-api-user-email-get

getPrivacyUnsafeUserEmailBulk

getPrivacyUnsafeUserEmailBulk(params): Promise<AccountIdEmailRecordArray>
Returns a user's email address regardless of the user’s profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelines. For Forge apps, this API only supports access via asApp() requests.

Any accounts which are not available will not be included in the result.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
  accountId: string[];
  }
  - accountId: string[]
    The account IDs of the users.
Returns Promise<AccountIdEmailRecordArray>
Returned if the request is successful.

Path
GET /wiki/rest/api/user/email/bulk @scopes-beta read:email-address:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users#api-wiki-rest-api-user-email-bulk-get

getUser

getUser(params): Promise<null | UserV1>
Returns a user. This includes information about the user, such as the display name, account ID, profile picture, and more. The information returned may be restricted by the user's profile visibility settings.

Note: to add, edit, or delete users in your organization, see the user management REST API.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
  accountId: string;
  expand?: ("operations" | "isExternalCollaborator" | "personalSpace")[];
  }
  - accountId: string
    The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
  - Optionalexpand?: ("operations" | "isExternalCollaborator" | "personalSpace")[]
    A multi-value parameter indicating which properties of the user to expand.
    
    operations returns the operations that the user is allowed to do.
    
    personalSpace returns the user's personal space, if it exists.
    
    isExternalCollaborator(@deprecated) see isGuest in response to find out whether the user is a guest.
Returns Promise<null | UserV1>
Returned if the requested user is returned.

Path
GET /wiki/rest/api/user @scopes-current read:confluence-user @scopes-beta read:content-details:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users#api-wiki-rest-api-user-get

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class UsersService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns UsersService

Methods

getAnonymousUser

Parameters

Optionalexpand?: "operations"[]

Returns Promise<UserAnonymous>

Path

See

getBulkUserLookup

Parameters

accountId: string

Optionalexpand?: ("operations" | "isExternalCollaborator" | "personalSpace")[]

Returns Promise<BulkUserLookupArray>

Path

See

getCurrentUser

Parameters

Optionalexpand?: ("operations" | "isExternalCollaborator" | "personalSpace")[]

Returns Promise<null | UserV1>

Path

See

getGroupMembershipsForUser

Parameters

accountId: string

Optionallimit?: number

Optionalstart?: number

Returns Promise<GroupArrayWithLinks>

Path

See

getPrivacyUnsafeUserEmail

Parameters

accountId: string

Returns Promise<AccountIdEmailRecord>

Path

See

getPrivacyUnsafeUserEmailBulk

Parameters

accountId: string[]

Returns Promise<AccountIdEmailRecordArray>

Path

See

getUser

Parameters

accountId: string

Optionalexpand?: ("operations" | "isExternalCollaborator" | "personalSpace")[]

Returns Promise<null | UserV1>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`expand?: "operations"[]

`Optional`expand?: ("operations" | "isExternalCollaborator" | "personalSpace")[]

`Optional`expand?: ("operations" | "isExternalCollaborator" | "personalSpace")[]

`Optional`limit?: number

`Optional`start?: number

`Optional`expand?: ("operations" | "isExternalCollaborator" | "personalSpace")[]

`Protected` `Static`initialize