com.box.sdkgen.managers.users

Class GetUsersQueryParams

Object

GetUsersQueryParams

public class GetUsersQueryParams
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetUsersQueryParams.Builder

Field Summary

Fields

Modifier and Type	Field and Description
String	externalAppUserId Limits the results to app users with the given `external_app_user_id` value.
List<String>	fields A comma-separated list of attributes to include in the response.
String	filterTerm Limits the results to only users who's `name` or `login` start with the search term.
Long	limit The maximum number of items to return per page.
String	marker Defines the position marker at which to begin returning results.
Long	offset The offset of the item at which to begin the response.
Boolean	usemarker Specifies whether to use marker-based pagination instead of offset-based pagination.
EnumWrapper<GetUsersQueryParamsUserTypeField>	userType Limits the results to the kind of user specified.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getExternalAppUserId()
List<String>	getFields()
String	getFilterTerm()
Long	getLimit()
String	getMarker()
Long	getOffset()
Boolean	getUsemarker()
EnumWrapper<GetUsersQueryParamsUserTypeField>	getUserType()

Methods inherited from class Object

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

Field Detail

filterTerm

public String filterTerm

Limits the results to only users who's `name` or `login` start with the search term.

For externally managed users, the search term needs to completely match the in order to find the user, and it will only return one user at a time.

userType

public EnumWrapper<GetUsersQueryParamsUserTypeField> userType

Limits the results to the kind of user specified.

* `all` returns every kind of user for whom the `login` or `name` partially matches the `filter_term`. It will only return an external user if the login matches the `filter_term` completely, and in that case it will only return that user. * `managed` returns all managed and app users for whom the `login` or `name` partially matches the `filter_term`. * `external` returns all external users for whom the `login` matches the `filter_term` exactly.

externalAppUserId

public String externalAppUserId

Limits the results to app users with the given `external_app_user_id` value.

When creating an app user, an `external_app_user_id` value can be set. This value can then be used in this endpoint to find any users that match that `external_app_user_id` value.

fields

public List<String> fields

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

offset

public Long offset

The offset of the item at which to begin the response.

Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.

limit

public Long limit

The maximum number of items to return per page.

usemarker

public Boolean usemarker

Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time.

By setting this value to true, the API will return a `marker` field that can be passed as a parameter to this endpoint to get the next page of the response.

marker

public String marker

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires `usemarker` to be set to `true`.

Constructor Detail

GetUsersQueryParams

public GetUsersQueryParams()

GetUsersQueryParams

protected GetUsersQueryParams(GetUsersQueryParams.Builder builder)

Method Detail

getFilterTerm

public String getFilterTerm()

getUserType

public EnumWrapper<GetUsersQueryParamsUserTypeField> getUserType()

getExternalAppUserId

public String getExternalAppUserId()

getFields

public List<String> getFields()

getOffset

public Long getOffset()

getLimit

public Long getLimit()

getUsemarker

public Boolean getUsemarker()

getMarker

public String getMarker()