com.box.boxjavalibv2.requests

Class GetAllUsersInEnterpriseRequest

java.lang.Object

com.box.restclientv2.requestsbase.DefaultBoxRequest

com.box.boxjavalibv2.requests.GetAllUsersInEnterpriseRequest

All Implemented Interfaces:

IBoxRequest

public class GetAllUsersInEnterpriseRequest
extends DefaultBoxRequest

Request to return Returns the list of all users for the Enterprise with their user_id, public_name, and login if the user is an enterprise admin. If the user is not an admin, this request returns the current user's user_id, public_name, and login.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ITEMS_MAX Default(max) value of maximum number of items returned.
static int	DEFAULT_ITEMS_OFFSET Default value of offset.

Constructor Summary

Constructors

Constructor and Description
GetAllUsersInEnterpriseRequest(IBoxConfig config, IBoxJSONParser parser, BoxDefaultRequestObject requestObject, java.lang.String filterTerm) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getUri() Get uri.

Methods inherited from class com.box.restclientv2.requestsbase.DefaultBoxRequest

addHeader, addHttpParam, addQueryParam, getApiUrlPath, getAuth, getAuthority, getConfig, getCookie, getExpectedResponseCode, getHeaders, getHttpParams, getQueryParams, getRawRequest, getRequestEntity, getRestMethod, getScheme, prepareRequest, setAuth, setCookie, setEntity, setExpectedResponseCode, setIfMatch, setRequestFields

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ITEMS_MAX

public static final int DEFAULT_ITEMS_MAX

Default(max) value of maximum number of items returned.

See Also:

Constant Field Values

DEFAULT_ITEMS_OFFSET

public static final int DEFAULT_ITEMS_OFFSET

Default value of offset.

See Also:

Constant Field Values

Constructor Detail

GetAllUsersInEnterpriseRequest

public GetAllUsersInEnterpriseRequest(IBoxConfig config,
                              IBoxJSONParser parser,
                              BoxDefaultRequestObject requestObject,
                              java.lang.String filterTerm)
                               throws BoxRestException

Constructor.

Parameters:

config - config

parser - json parser

requestObject - request object

filterTerm - A string used to filter the results to only users starting with the filter_term in either the name or the login. Use null if don't want filter.

Throws:

BoxRestException

Method Detail

getUri

public static java.lang.String getUri()

Get uri.

Returns:

uri