Class GroupService

WARNING The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point.

See

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

Hierarchy

CommonHttpService
- GroupService

Index

Constructors

constructor

Methods

addUserToGroupByGroupId createGroup getGroupByGroupId getGroupMembersByGroupId getGroups removeGroupById removeMemberFromGroupByGroupId searchGroups initialize

Constructors

constructor

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

Methods

addUserToGroupByGroupId

addUserToGroupByGroupId(params): Promise<void>
Adds a user as a member in a group represented by its groupId

Permissions required: User must be a site admin.
Parameters
- params: {
  accountId: AccountId;
  groupId: string;
  }
  - accountId: AccountId
    AccountId of the user who needs to be added as member.
  - groupId: string
    GroupId of the group whose membership is updated
Returns Promise<void>
Path
POST /wiki/rest/api/group/userByGroupId @scopes-current write:confluence-groups @scopes-beta write:group:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-userbygroupid-post

createGroup

createGroup(params): Promise<Group>
Creates a new user group.

Permissions required: User must be a site admin.
Parameters
- params: {
  groupName: GroupName;
  }
  - groupName: GroupName
    Name of the group that is to be created.
Returns Promise<Group>
Returned if the group was created successfully.

Path
POST /wiki/rest/api/group @scopes-current write:confluence-groups @scopes-beta read:group:confluence, write:group:confluence

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

getGroupByGroupId

getGroupByGroupId(params): Promise<Group>
Returns a user group for a given group id.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
  id: string;
  }
  - id: string
    The id of the group.
Returns Promise<Group>
Returned if the requested group is returned.

Path
GET /wiki/rest/api/group/by-id @scopes-current read:confluence-groups @scopes-beta read:group:confluence

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

getGroupMembersByGroupId

getGroupMembersByGroupId(params): Promise<UserArray>
Returns the users that are members of a group.

Use updated Get group API

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
      expand?: ("operations" | "isExternalCollaborator" | "personalSpace")[];
      groupId: string;
      limit?: number;
      shouldReturnTotalSize?: boolean;
      start?: number;
  }
  - 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.
  - groupId: string
    The id of the group to be queried for its members.
  - Optionallimit?: number
    The maximum number of users to return per page. Note, this may be restricted by fixed system limits.
  - OptionalshouldReturnTotalSize?: boolean
    Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.
  - Optionalstart?: number
    The starting index of the returned users.
Returns Promise<UserArray>
Returned if the requested users are returned.

Path
GET /wiki/rest/api/group/{groupId}/membersByGroupId @scopes-current read:confluence-groups @scopes-beta read:group:confluence, read:user:confluence

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

getGroups

getGroups(params?): Promise<GroupArrayWithLinks>
Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Parameters
- params: {
      accessType?: "user" | "admin" | "site-admin";
      limit?: number;
      start?: number;
  } = {}
  - OptionalaccessType?: "user" | "admin" | "site-admin"
    The group permission level for which to filter results.
  - 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/group @scopes-current read:confluence-groups @scopes-beta read:group:confluence

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

removeGroupById

removeGroupById(params): Promise<void>
Delete user group.

Permissions required: User must be a site admin.
Parameters
- params: {
  id: string;
  }
  - id: string
    Id of the group to delete.
Returns Promise<void>
Path
DELETE /wiki/rest/api/group/by-id @scopes-current write:confluence-groups @scopes-beta write:group:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-by-id-delete

removeMemberFromGroupByGroupId

removeMemberFromGroupByGroupId(params): Promise<void>
Remove user as a member from a group.

Permissions required: User must be a site admin.
Parameters
- params: {
      accountId: string;
      groupId: string;
      key?: string;
      username?: string;
  }
  - 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.
  - groupId: string
    Id of the group whose membership is updated.
  - Optionalkey?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
  - Optionalusername?: string
    This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.
    
    Deprecated
Returns Promise<void>
Path
DELETE /wiki/rest/api/group/userByGroupId @scopes-current write:confluence-groups @scopes-beta write:group:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-userbygroupid-delete

searchGroups

searchGroups(params): Promise<GroupArrayWithLinks>
Get search results of groups by partial query provided.
Parameters
- params: {
      limit?: number;
      query: string;
      shouldReturnTotalSize?: boolean;
      start?: number;
  }
  - Optionallimit?: number
    The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups.
  - query: string
    the search term used to query results.
  - OptionalshouldReturnTotalSize?: boolean
    Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.
  - Optionalstart?: number
    The starting index of the returned groups.
Returns Promise<GroupArrayWithLinks>
Returns a full JSON representation of group collection.

Path
GET /wiki/rest/api/group/picker @scopes-current read:confluence-groups @scopes-beta read:group:confluence

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

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class GroupService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns GroupService

Methods

addUserToGroupByGroupId

Parameters

accountId: AccountId

groupId: string

Returns Promise<void>

Path

See

createGroup

Parameters

groupName: GroupName

Returns Promise<Group>

Path

See

getGroupByGroupId

Parameters

id: string

Returns Promise<Group>

Path

See

getGroupMembersByGroupId

Parameters

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

groupId: string

Optionallimit?: number

OptionalshouldReturnTotalSize?: boolean

Optionalstart?: number

Returns Promise<UserArray>

Path

See

getGroups

Parameters

OptionalaccessType?: "user" | "admin" | "site-admin"

Optionallimit?: number

Optionalstart?: number

Returns Promise<GroupArrayWithLinks>

Path

See

removeGroupById

Parameters

id: string

Returns Promise<void>

Path

See

removeMemberFromGroupByGroupId

Parameters

accountId: string

groupId: string

Optionalkey?: string

Deprecated

Optionalusername?: string

Deprecated

Returns Promise<void>

Path

See

searchGroups

Parameters

Optionallimit?: number

query: string

OptionalshouldReturnTotalSize?: boolean

Optionalstart?: number

Returns Promise<GroupArrayWithLinks>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

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

`Optional`limit?: number

`Optional`shouldReturnTotalSize?: boolean

`Optional`start?: number

`Optional`accessType?: "user" | "admin" | "site-admin"

`Optional`limit?: number

`Optional`start?: number

`Optional`key?: string

`Optional`username?: string

`Optional`limit?: number

`Optional`shouldReturnTotalSize?: boolean

`Optional`start?: number

`Protected` `Static`initialize