CreateUserParams (Box Java SDK)

Object
- CreateUserParams

```
public class CreateUserParams
extends Object
```
Contains optional parameters for creating a new enterprise user on Box.

Constructor Summary

Constructors
Constructor and Description

CreateUserParams()

Constructors
Constructor and Description
`CreateUserParams()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateUserParams`	`addTrackingCode(String key, String value)` Add an element the map of tracking codes.
`String`	`getAddress()` Gets what the address of the new user will be.
`Boolean`	`getCanSeeManagedUsers()` Gets whether or not the new user will be able to see other enterprise users in their contact list.
`String`	`getExternalAppUserId()` Gets the external app user id that has been set for the app user.
`Boolean`	`getIsExemptFromDeviceLimits()` Gets whether or not the new user will be exempt from Enterprise device limits.
`Boolean`	`getIsExemptFromLoginVerification()` Gets whether or not the new user will be required to use two-factor authentication.
`Boolean`	`getIsExternalCollabRestricted()` Gets whether this user is allowed or not to collaborate with users outside their enterprise.
`Boolean`	`getIsPlatformAccessOnly()` Gets whether or not the user we are creating is an app user with Box Developer Edition.
`Boolean`	`getIsSyncEnabled()` Gets whether or not the new user will be able to use Box Sync.
`String`	`getJobTitle()` Gets what the job title of the new user will be.
`String`	`getLanguage()` Gets what the language of the new user will be.
`String`	`getPhone()` Gets what the phone number of the new user will be.
`BoxUser.Role`	`getRole()` Gets what the new user's enterprise role will be.
`Long`	`getSpaceAmount()` Gets what the new user's total available space will be in bytes.
`BoxUser.Status`	`getStatus()` Gets what the new user's account status will be.
`String`	`getTimezone()` Gets what the timezone of the new user will be.
`Map<String,String>`	`getTrackingCodes()` Gets the map of tracking codes.
`CreateUserParams`	`setAddress(String address)` Sets what the address of the new user will be.
`CreateUserParams`	`setCanSeeManagedUsers(boolean canSeeManagedUsers)` Sets whether or not the new user will be able to see other enterprise users in their contact list.
`CreateUserParams`	`setExternalAppUserId(String externalAppUserId)` Sets the external app user id.
`CreateUserParams`	`setIsExemptFromDeviceLimits(boolean isExemptFromDeviceLimits)` Sets whether or not the new user will be exempt from Enterprise device limits.
`CreateUserParams`	`setIsExemptFromLoginVerification(boolean isExemptFromLoginVerification)` Sets whether or not the new user will be required to use two-factor authentication.
`CreateUserParams`	`setIsExternalCollabRestricted(boolean isExternalCollabRestricted)` Sets whether this user is allowed or not to collaborate with users outside their enterprise.
`CreateUserParams`	`setIsPlatformAccessOnly(boolean isPlatformAccessOnly)` Sets whether or not the user we are creating is an app user with Box Developer Edition.
`CreateUserParams`	`setIsSyncEnabled(boolean isSyncEnabled)` Sets whether or not the new user will be able to use Box Sync.
`CreateUserParams`	`setJobTitle(String jobTitle)` Sets what the job title of the new user will be.
`CreateUserParams`	`setLanguage(String language)` Sets what the language of the new user will be.
`CreateUserParams`	`setPhone(String phone)` Sets what the phone number of the new user will be.
`CreateUserParams`	`setRole(BoxUser.Role role)` Sets what the new user's enterprise role will be.
`CreateUserParams`	`setSpaceAmount(long spaceAmount)` Sets what the new user's total available space will be in bytes.
`CreateUserParams`	`setStatus(BoxUser.Status status)` Sets what the new user's account status will be.
`CreateUserParams`	`setTimezone(String timezone)` Sets what the timezone of the new user will be.
`CreateUserParams`	`setTrackingCodes(Map<String,String> trackingCodes)` Sets the map of tracking codes.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CreateUserParams
```
public CreateUserParams()
```
- Method Detail
  - getCanSeeManagedUsers
```
public Boolean getCanSeeManagedUsers()
```
    Gets whether or not the new user will be able to see other enterprise users in their contact list.
    
    Returns:
    
    true if the new user will be able to see other enterprise users in their contact list; otherwise false.
  - setCanSeeManagedUsers
```
public CreateUserParams setCanSeeManagedUsers(boolean canSeeManagedUsers)
```
    Sets whether or not the new user will be able to see other enterprise users in their contact list.
    
    Parameters:
    
    canSeeManagedUsers - whether or not the new user will be able to see other enterprise users in their contact list.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getIsExemptFromDeviceLimits
```
public Boolean getIsExemptFromDeviceLimits()
```
    Gets whether or not the new user will be exempt from Enterprise device limits.
    
    Returns:
    
    true if the new user will be exempt from Enterprise device limits; otherwise false.
  - setIsExemptFromDeviceLimits
```
public CreateUserParams setIsExemptFromDeviceLimits(boolean isExemptFromDeviceLimits)
```
    Sets whether or not the new user will be exempt from Enterprise device limits.
    
    Parameters:
    
    isExemptFromDeviceLimits - whether or not the new user will be exempt from Enterprise device limits.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getIsExemptFromLoginVerification
```
public Boolean getIsExemptFromLoginVerification()
```
    Gets whether or not the new user will be required to use two-factor authentication.
    
    Returns:
    
    true if the new user will be required to use two-factor authentication; otherwise false.
  - setIsExemptFromLoginVerification
```
public CreateUserParams setIsExemptFromLoginVerification(boolean isExemptFromLoginVerification)
```
    Sets whether or not the new user will be required to use two-factor authentication.
    
    Parameters:
    
    isExemptFromLoginVerification - whether or not the new user will be required to use two-factor authentication.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getIsPlatformAccessOnly
```
public Boolean getIsPlatformAccessOnly()
```
    Gets whether or not the user we are creating is an app user with Box Developer Edition.
    
    Returns:
    
    true if the new user is an app user for Box Developer Addition; otherwise false.
  - setIsPlatformAccessOnly
```
public CreateUserParams setIsPlatformAccessOnly(boolean isPlatformAccessOnly)
```
    Sets whether or not the user we are creating is an app user with Box Developer Edition.
    
    Parameters:
    
    isPlatformAccessOnly - whether or not the user we are creating is an app user with Box Developer Edition.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getIsSyncEnabled
```
public Boolean getIsSyncEnabled()
```
    Gets whether or not the new user will be able to use Box Sync.
    
    Returns:
    
    true if the new user will be able to use Box Sync; otherwise false.
  - setIsSyncEnabled
```
public CreateUserParams setIsSyncEnabled(boolean isSyncEnabled)
```
    Sets whether or not the new user will be able to use Box Sync.
    
    Parameters:
    
    isSyncEnabled - whether or not the new user will be able to use Box Sync.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getRole
```
public BoxUser.Role getRole()
```
    Gets what the new user's enterprise role will be.
    
    Returns:
    
    what the new user's enterprise role will be.
  - setRole
```
public CreateUserParams setRole(BoxUser.Role role)
```
    Sets what the new user's enterprise role will be.
    
    Parameters:
    
    role - what the new user's enterprise role will be.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getStatus
```
public BoxUser.Status getStatus()
```
    Gets what the new user's account status will be.
    
    Returns:
    
    what the new user's account status will be.
  - setStatus
```
public CreateUserParams setStatus(BoxUser.Status status)
```
    Sets what the new user's account status will be.
    
    Parameters:
    
    status - what the new user's account status will be.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getSpaceAmount
```
public Long getSpaceAmount()
```
    Gets what the new user's total available space will be in bytes.
    
    Returns:
    
    what the new user's total available space will be in bytes.
  - setSpaceAmount
```
public CreateUserParams setSpaceAmount(long spaceAmount)
```
    Sets what the new user's total available space will be in bytes.
    
    Parameters:
    
    spaceAmount - what the new user's total available space will be in bytes.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getAddress
```
public String getAddress()
```
    Gets what the address of the new user will be.
    
    Returns:
    
    what the address of the new user will be.
  - setAddress
```
public CreateUserParams setAddress(String address)
```
    Sets what the address of the new user will be.
    
    Parameters:
    
    address - what the address of the new user will be.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getJobTitle
```
public String getJobTitle()
```
    Gets what the job title of the new user will be.
    
    Returns:
    
    what the job title of the new user will be.
  - setJobTitle
```
public CreateUserParams setJobTitle(String jobTitle)
```
    Sets what the job title of the new user will be.
    
    Parameters:
    
    jobTitle - what the job title of the new user will be.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getLanguage
```
public String getLanguage()
```
    Gets what the language of the new user will be.
    
    Returns:
    
    what the language of the new user will be.
  - setLanguage
```
public CreateUserParams setLanguage(String language)
```
    Sets what the language of the new user will be.
    
    Parameters:
    
    language - what the language of the new user will be.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getPhone
```
public String getPhone()
```
    Gets what the phone number of the new user will be.
    
    Returns:
    
    what the phone number of the new user will be.
  - setPhone
```
public CreateUserParams setPhone(String phone)
```
    Sets what the phone number of the new user will be.
    
    Parameters:
    
    phone - what the phone number of the new user will be.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getTimezone
```
public String getTimezone()
```
    Gets what the timezone of the new user will be.
    
    Returns:
    
    what the timezone of the new user will be.
  - setTimezone
```
public CreateUserParams setTimezone(String timezone)
```
    Sets what the timezone of the new user will be.
    
    Parameters:
    
    timezone - what the timezone of the new user will be.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getExternalAppUserId
```
public String getExternalAppUserId()
```
    Gets the external app user id that has been set for the app user.
    
    Returns:
    
    the external app user id.
  - setExternalAppUserId
```
public CreateUserParams setExternalAppUserId(String externalAppUserId)
```
    Sets the external app user id.
    
    Parameters:
    
    externalAppUserId - external app user id.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getIsExternalCollabRestricted
```
public Boolean getIsExternalCollabRestricted()
```
    Gets whether this user is allowed or not to collaborate with users outside their enterprise.
    
    Returns:
    
    true if the user is not able to collaborate with users outside their enterpise; otherwise false.
  - setIsExternalCollabRestricted
```
public CreateUserParams setIsExternalCollabRestricted(boolean isExternalCollabRestricted)
```
    Sets whether this user is allowed or not to collaborate with users outside their enterprise.
    
    Parameters:
    
    isExternalCollabRestricted - whether the user is allowed to collaborate with users outside their enterprise.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - getTrackingCodes
```
public Map<String,String> getTrackingCodes()
```
    Gets the map of tracking codes. Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.
    
    Returns:
    
    map of tracking codes.
  - setTrackingCodes
```
public CreateUserParams setTrackingCodes(Map<String,String> trackingCodes)
```
    Sets the map of tracking codes. Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.
    
    Parameters:
    
    trackingCodes - map of tracking codes.
    
    Returns:
    
    this CreateUserParams object for chaining.
  - addTrackingCode
```
public CreateUserParams addTrackingCode(String key,
                                        String value)
```
    Add an element the map of tracking codes. Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.
    
    Parameters:
    
    key - of a tracking code
    
    value - of a tracking code
    
    Returns:
    
    this CreateUserParams object for chaining.

Class CreateUserParams

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

CreateUserParams

Method Detail

getCanSeeManagedUsers

setCanSeeManagedUsers

getIsExemptFromDeviceLimits

setIsExemptFromDeviceLimits

getIsExemptFromLoginVerification

setIsExemptFromLoginVerification

getIsPlatformAccessOnly

setIsPlatformAccessOnly

getIsSyncEnabled

setIsSyncEnabled

getRole

setRole

getStatus

setStatus

getSpaceAmount

setSpaceAmount

getAddress

setAddress

getJobTitle

setJobTitle

getLanguage

setLanguage

getPhone

setPhone

getTimezone

setTimezone

getExternalAppUserId

setExternalAppUserId

getIsExternalCollabRestricted

setIsExternalCollabRestricted

getTrackingCodes

setTrackingCodes

addTrackingCode