GroupApi class
This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addUserToGroup(
{required String name, required AccountId body}) → Future< void> - Adds a user as a member in a group.
-
addUserToGroupByGroupId(
{required String groupId, required AccountId body}) → Future< void> - Adds a user as a member in a group represented by its groupId
-
createGroup(
{required GroupName body}) → Future< Group> - Creates a new user group.
-
getGroupByGroupId(
String id) → Future< Group> - Returns a user group for a given group id.
-
getGroupByName(
String groupName) → Future< Group> - Returns a user group for a given group name.
-
getGroupByQueryParam(
String name) → Future< Group> - Returns a user group for a given group name.
-
getGroupMembers(
{required String groupName, int? start, int? limit}) → Future< UserArray> - Returns the users that are members of a group.
-
getGroupMembersByGroupId(
{required String groupId, int? start, int? limit, bool? shouldReturnTotalSize, List< String> ? expand}) → Future<UserArray> - Returns the users that are members of a group.
-
getGroups(
{int? start, int? limit, String? accessType}) → Future< GroupArrayWithLinks> - Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.
-
getMembersByQueryParam(
{required String name, int? start, int? limit, bool? shouldReturnTotalSize, List< String> ? expand}) → Future<UserArray> - Returns the users that are members of a group.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeGroup(
String name) → Future< void> - Delete user group.
-
removeGroupById(
String id) → Future< void> - Delete user group.
-
removeMemberFromGroup(
{required String name, String? key, String? username, String? accountId}) → Future< void> - Remove user as a member from a group.
-
removeMemberFromGroupByGroupId(
{required String groupId, String? key, String? username, String? accountId}) → Future< void> - Remove user as a member from a group.
-
searchGroups(
{required String query, int? start, int? limit, bool? shouldReturnTotalSize}) → Future< GroupArrayWithLinks> - Get search results of groups by partial query provided.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited