com.box.sdkgen.managers.groups

Class GroupsManager

Object

GroupsManager

public class GroupsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	GroupsManager()
protected	GroupsManager(GroupsManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
GroupFull	createGroup(CreateGroupRequestBody requestBody) Creates a new group of users in an enterprise.
GroupFull	createGroup(CreateGroupRequestBody requestBody, CreateGroupHeaders headers) Creates a new group of users in an enterprise.
GroupFull	createGroup(CreateGroupRequestBody requestBody, CreateGroupQueryParams queryParams) Creates a new group of users in an enterprise.
GroupFull	createGroup(CreateGroupRequestBody requestBody, CreateGroupQueryParams queryParams, CreateGroupHeaders headers) Creates a new group of users in an enterprise.
void	deleteGroupById(String groupId) Permanently deletes a group.
void	deleteGroupById(String groupId, DeleteGroupByIdHeaders headers) Permanently deletes a group.
Authentication	getAuth()
GroupFull	getGroupById(String groupId) Retrieves information about a group.
GroupFull	getGroupById(String groupId, GetGroupByIdHeaders headers) Retrieves information about a group.
GroupFull	getGroupById(String groupId, GetGroupByIdQueryParams queryParams) Retrieves information about a group.
GroupFull	getGroupById(String groupId, GetGroupByIdQueryParams queryParams, GetGroupByIdHeaders headers) Retrieves information about a group.
Groups	getGroups() Retrieves all of the groups for a given enterprise.
Groups	getGroups(GetGroupsHeaders headers) Retrieves all of the groups for a given enterprise.
Groups	getGroups(GetGroupsQueryParams queryParams) Retrieves all of the groups for a given enterprise.
Groups	getGroups(GetGroupsQueryParams queryParams, GetGroupsHeaders headers) Retrieves all of the groups for a given enterprise.
NetworkSession	getNetworkSession()
GroupFull	updateGroupById(String groupId) Updates a specific group.
GroupFull	updateGroupById(String groupId, UpdateGroupByIdHeaders headers) Updates a specific group.
GroupFull	updateGroupById(String groupId, UpdateGroupByIdQueryParams queryParams) Updates a specific group.
GroupFull	updateGroupById(String groupId, UpdateGroupByIdQueryParams queryParams, UpdateGroupByIdHeaders headers) Updates a specific group.
GroupFull	updateGroupById(String groupId, UpdateGroupByIdRequestBody requestBody) Updates a specific group.
GroupFull	updateGroupById(String groupId, UpdateGroupByIdRequestBody requestBody, UpdateGroupByIdHeaders headers) Updates a specific group.
GroupFull	updateGroupById(String groupId, UpdateGroupByIdRequestBody requestBody, UpdateGroupByIdQueryParams queryParams) Updates a specific group.
GroupFull	updateGroupById(String groupId, UpdateGroupByIdRequestBody requestBody, UpdateGroupByIdQueryParams queryParams, UpdateGroupByIdHeaders headers) Updates a specific group.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

GroupsManager

public GroupsManager()

GroupsManager

protected GroupsManager(GroupsManager.Builder builder)

Method Detail

getGroups

public Groups getGroups()

Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.

getGroups

public Groups getGroups(GetGroupsQueryParams queryParams)

Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.

Parameters:

queryParams - Query parameters of getGroups method

getGroups

public Groups getGroups(GetGroupsHeaders headers)

Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.

Parameters:

headers - Headers of getGroups method

getGroups

public Groups getGroups(GetGroupsQueryParams queryParams,
                        GetGroupsHeaders headers)

Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.

Parameters:

queryParams - Query parameters of getGroups method

headers - Headers of getGroups method

createGroup

public GroupFull createGroup(CreateGroupRequestBody requestBody)

Creates a new group of users in an enterprise. Only users with admin permissions can create new groups.

Parameters:

requestBody - Request body of createGroup method

createGroup

public GroupFull createGroup(CreateGroupRequestBody requestBody,
                             CreateGroupQueryParams queryParams)

Creates a new group of users in an enterprise. Only users with admin permissions can create new groups.

Parameters:

requestBody - Request body of createGroup method

queryParams - Query parameters of createGroup method

createGroup

public GroupFull createGroup(CreateGroupRequestBody requestBody,
                             CreateGroupHeaders headers)

Creates a new group of users in an enterprise. Only users with admin permissions can create new groups.

Parameters:

requestBody - Request body of createGroup method

headers - Headers of createGroup method

createGroup

public GroupFull createGroup(CreateGroupRequestBody requestBody,
                             CreateGroupQueryParams queryParams,
                             CreateGroupHeaders headers)

Creates a new group of users in an enterprise. Only users with admin permissions can create new groups.

Parameters:

requestBody - Request body of createGroup method

queryParams - Query parameters of createGroup method

headers - Headers of createGroup method

getGroupById

public GroupFull getGroupById(String groupId)

Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

getGroupById

public GroupFull getGroupById(String groupId,
                              GetGroupByIdQueryParams queryParams)

Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

queryParams - Query parameters of getGroupById method

getGroupById

public GroupFull getGroupById(String groupId,
                              GetGroupByIdHeaders headers)

Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

headers - Headers of getGroupById method

getGroupById

public GroupFull getGroupById(String groupId,
                              GetGroupByIdQueryParams queryParams,
                              GetGroupByIdHeaders headers)

Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

queryParams - Query parameters of getGroupById method

headers - Headers of getGroupById method

updateGroupById

public GroupFull updateGroupById(String groupId)

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

updateGroupById

public GroupFull updateGroupById(String groupId,
                                 UpdateGroupByIdRequestBody requestBody)

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

requestBody - Request body of updateGroupById method

updateGroupById

public GroupFull updateGroupById(String groupId,
                                 UpdateGroupByIdQueryParams queryParams)

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

queryParams - Query parameters of updateGroupById method

updateGroupById

public GroupFull updateGroupById(String groupId,
                                 UpdateGroupByIdRequestBody requestBody,
                                 UpdateGroupByIdQueryParams queryParams)

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

requestBody - Request body of updateGroupById method

queryParams - Query parameters of updateGroupById method

updateGroupById

public GroupFull updateGroupById(String groupId,
                                 UpdateGroupByIdHeaders headers)

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

headers - Headers of updateGroupById method

updateGroupById

public GroupFull updateGroupById(String groupId,
                                 UpdateGroupByIdRequestBody requestBody,
                                 UpdateGroupByIdHeaders headers)

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

requestBody - Request body of updateGroupById method

headers - Headers of updateGroupById method

updateGroupById

public GroupFull updateGroupById(String groupId,
                                 UpdateGroupByIdQueryParams queryParams,
                                 UpdateGroupByIdHeaders headers)

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

queryParams - Query parameters of updateGroupById method

headers - Headers of updateGroupById method

updateGroupById

public GroupFull updateGroupById(String groupId,
                                 UpdateGroupByIdRequestBody requestBody,
                                 UpdateGroupByIdQueryParams queryParams,
                                 UpdateGroupByIdHeaders headers)

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

requestBody - Request body of updateGroupById method

queryParams - Query parameters of updateGroupById method

headers - Headers of updateGroupById method

deleteGroupById

public void deleteGroupById(String groupId)

Permanently deletes a group. Only users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

deleteGroupById

public void deleteGroupById(String groupId,
                            DeleteGroupByIdHeaders headers)

Permanently deletes a group. Only users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

headers - Headers of deleteGroupById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()