Package io.github.primelib.confluence4j.rest.v1.client

Interface ConfluenceRestClientGroupApi

@Generated("io.github.primelib.primecodegen") public interface ConfluenceRestClientGroupApi
ConfluenceRestClientGroupApi **[WARNING](https://support.atlassian.com/user-management/docs/create-and-update-groups/) 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.

  • Method Details

    • GetGroupV1

      GroupArrayWithLinks GetGroupV1(@Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable String accessType)
      GetGroupV1 Get groups Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      start - The starting index of the returned groups.
      limit - The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.
      accessType - The group permission level for which to filter results.

    • PostGroupV1

      Group PostGroupV1(@NotNull @NotNull GroupName payload)
      PostGroupV1 Create new user group Creates a new user group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
      Parameters:
      payload - Name of the group that is to be created.

    • GetGroupByIDV1

      Group GetGroupByIDV1(@NotNull @NotNull String id)
      GetGroupByIDV1 Get group Returns a user group for a given group id. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      id - The id of the group.

    • DeleteGroupByIDV1

      void DeleteGroupByIDV1(@NotNull @NotNull String id)
      DeleteGroupByIDV1 Delete user group Delete user group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
      Parameters:
      id - Id of the group to delete.

    • GetGroupPickerV1

      GroupArrayWithLinks GetGroupPickerV1(@NotNull @NotNull String query, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean shouldReturnTotalSize)
      GetGroupPickerV1 Search groups by partial query Get search results of groups by partial query provided.
      Parameters:
      query - the search term used to query results.
      start - The starting index of the returned groups.
      limit - The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups.
      shouldReturnTotalSize - 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.

    • GetGroupByGroupIDMembersByGroupIDV1

      UserArray GetGroupByGroupIDMembersByGroupIDV1(@NotNull @NotNull String groupId, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit, @Nullable @Nullable Boolean shouldReturnTotalSize, @Nullable @Nullable List<String> expand)
      GetGroupByGroupIDMembersByGroupIDV1 Get group members Returns the users that are members of a group. Use updated Get group API **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      groupId - The id of the group to be queried for its members.
      start - The starting index of the returned users.
      limit - The maximum number of users to return per page. Note, this may be restricted by fixed system limits.
      shouldReturnTotalSize - 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.
      expand - 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.

    • PostGroupUserByGroupIDV1

      void PostGroupUserByGroupIDV1(@NotNull @NotNull String groupId, @NotNull @NotNull AccountId payload)
      PostGroupUserByGroupIDV1 Add member to group by groupId Adds a user as a member in a group represented by its groupId **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
      Parameters:
      groupId - GroupId of the group whose membership is updated
      payload - AccountId of the user who needs to be added as member.

    • DeleteGroupUserByGroupIDV1

      void DeleteGroupUserByGroupIDV1(@NotNull @NotNull String groupId, @NotNull @NotNull String accountId, @Nullable @Nullable String key, @Nullable @Nullable String username)
      DeleteGroupUserByGroupIDV1 Remove member from group using group id Remove user as a member from a group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
      Parameters:
      groupId - Id of the group whose membership is updated.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.