UpdateUserByIdRequestBody (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - UpdateUserByIdRequestBody

All Implemented Interfaces:: Serializable

public class UpdateUserByIdRequestBody
extends SerializableObject

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UpdateUserByIdRequestBody.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`UpdateUserByIdRequestBody.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`address` The user’s address.
`protected Boolean`	`canSeeManagedUsers` Whether the user can see other enterprise users in their contact list.
`protected String`	`enterprise` Set this to `null` to roll the user out of the enterprise and make them a free user.
`protected String`	`externalAppUserId` An external identifier for an app user, which can be used to look up the user.
`protected Boolean`	`isExemptFromDeviceLimits` Whether to exempt the user from enterprise device limits.
`protected Boolean`	`isExemptFromLoginVerification` Whether the user must use two-factor authentication.
`protected Boolean`	`isExternalCollabRestricted` Whether the user is allowed to collaborate with users outside their enterprise.
`protected Boolean`	`isPasswordResetRequired` Whether the user is required to reset their password.
`protected Boolean`	`isSyncEnabled` Whether the user can use Box Sync.
`protected String`	`jobTitle` The user’s job title.
`protected String`	`language` The language of the user, formatted in modified version of the [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
`protected String`	`login` The email address the user uses to log in
`protected String`	`name` The name of the user.
`protected UpdateUserByIdRequestBodyNotificationEmailField`	`notificationEmail` An alternate notification email address to which email notifications are sent.
`protected Boolean`	`notify` Whether the user should receive an email when they are rolled out of an enterprise.
`protected String`	`phone` The user’s phone number.
`protected EnumWrapper<UpdateUserByIdRequestBodyRoleField>`	`role` The user’s enterprise role.
`protected Long`	`spaceAmount` The user’s total available space in bytes.
`protected EnumWrapper<UpdateUserByIdRequestBodyStatusField>`	`status` The user's account status.
`protected String`	`timezone` The user's timezone.
`protected List<TrackingCode>`	`trackingCodes` Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

UpdateUserByIdRequestBody()

protected UpdateUserByIdRequestBody(UpdateUserByIdRequestBody.Builder builder)

Constructors
Modifier	Constructor and Description
	`UpdateUserByIdRequestBody()`
`protected`	`UpdateUserByIdRequestBody(UpdateUserByIdRequestBody.Builder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAddress()`
`Boolean`	`getCanSeeManagedUsers()`
`String`	`getEnterprise()`
`String`	`getExternalAppUserId()`
`Boolean`	`getIsExemptFromDeviceLimits()`
`Boolean`	`getIsExemptFromLoginVerification()`
`Boolean`	`getIsExternalCollabRestricted()`
`Boolean`	`getIsPasswordResetRequired()`
`Boolean`	`getIsSyncEnabled()`
`String`	`getJobTitle()`
`String`	`getLanguage()`
`String`	`getLogin()`
`String`	`getName()`
`UpdateUserByIdRequestBodyNotificationEmailField`	`getNotificationEmail()`
`Boolean`	`getNotify()`
`String`	`getPhone()`
`EnumWrapper<UpdateUserByIdRequestBodyRoleField>`	`getRole()`
`Long`	`getSpaceAmount()`
`EnumWrapper<UpdateUserByIdRequestBodyStatusField>`	`getStatus()`
`String`	`getTimezone()`
`List<TrackingCode>`	`getTrackingCodes()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class SerializableObject
getRawData, setRawData

Methods inherited from class NullableFieldTracker
getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

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

- Field Detail
  - enterprise
```
protected String enterprise
```
    Set this to `null` to roll the user out of the enterprise and make them a free user.
  - notify
```
protected Boolean notify
```
    Whether the user should receive an email when they are rolled out of an enterprise.
  - name
```
protected String name
```
    The name of the user.
  - login
```
protected String login
```
    The email address the user uses to log in
    Note: If the target user's email is not confirmed, then the primary login address cannot be changed.
  - role
```
protected EnumWrapper<UpdateUserByIdRequestBodyRoleField> role
```
    The user’s enterprise role.
  - language
```
protected String language
```
    The language of the user, formatted in modified version of the [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
  - isSyncEnabled
```
protected Boolean isSyncEnabled
```
    Whether the user can use Box Sync.
  - jobTitle
```
protected String jobTitle
```
    The user’s job title.
  - phone
```
protected String phone
```
    The user’s phone number.
  - address
```
protected String address
```
    The user’s address.
  - trackingCodes
```
protected List<TrackingCode> trackingCodes
```
    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.
  - canSeeManagedUsers
```
protected Boolean canSeeManagedUsers
```
    Whether the user can see other enterprise users in their contact list.
  - timezone
```
protected String timezone
```
    The user's timezone.
  - isExternalCollabRestricted
```
protected Boolean isExternalCollabRestricted
```
    Whether the user is allowed to collaborate with users outside their enterprise.
  - isExemptFromDeviceLimits
```
protected Boolean isExemptFromDeviceLimits
```
    Whether to exempt the user from enterprise device limits.
  - isExemptFromLoginVerification
```
protected Boolean isExemptFromLoginVerification
```
    Whether the user must use two-factor authentication.
  - isPasswordResetRequired
```
protected Boolean isPasswordResetRequired
```
    Whether the user is required to reset their password.
  - status
```
protected EnumWrapper<UpdateUserByIdRequestBodyStatusField> status
```
    The user's account status.
  - spaceAmount
```
protected Long spaceAmount
```
    The user’s total available space in bytes. Set this to `-1` to indicate unlimited storage.
  - notificationEmail
```
protected UpdateUserByIdRequestBodyNotificationEmailField notificationEmail
```
    An alternate notification email address to which email notifications are sent. When it's confirmed, this will be the email address to which notifications are sent instead of to the primary email address.
    Set this value to `null` to remove the notification email.
  - externalAppUserId
```
protected String externalAppUserId
```
    An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users.
    Note: In order to update this field, you need to request a token using the application that created the app user.
- Constructor Detail
  - UpdateUserByIdRequestBody
```
public UpdateUserByIdRequestBody()
```
  - UpdateUserByIdRequestBody
```
protected UpdateUserByIdRequestBody(UpdateUserByIdRequestBody.Builder builder)
```
- Method Detail
  - getEnterprise
```
public String getEnterprise()
```
  - getNotify
```
public Boolean getNotify()
```
  - getName
```
public String getName()
```
  - getLogin
```
public String getLogin()
```
  - getRole
```
public EnumWrapper<UpdateUserByIdRequestBodyRoleField> getRole()
```
  - getLanguage
```
public String getLanguage()
```
  - getIsSyncEnabled
```
public Boolean getIsSyncEnabled()
```
  - getJobTitle
```
public String getJobTitle()
```
  - getPhone
```
public String getPhone()
```
  - getAddress
```
public String getAddress()
```
  - getTrackingCodes
```
public List<TrackingCode> getTrackingCodes()
```
  - getCanSeeManagedUsers
```
public Boolean getCanSeeManagedUsers()
```
  - getTimezone
```
public String getTimezone()
```
  - getIsExternalCollabRestricted
```
public Boolean getIsExternalCollabRestricted()
```
  - getIsExemptFromDeviceLimits
```
public Boolean getIsExemptFromDeviceLimits()
```
  - getIsExemptFromLoginVerification
```
public Boolean getIsExemptFromLoginVerification()
```
  - getIsPasswordResetRequired
```
public Boolean getIsPasswordResetRequired()
```
  - getStatus
```
public EnumWrapper<UpdateUserByIdRequestBodyStatusField> getStatus()
```
  - getSpaceAmount
```
public Long getSpaceAmount()
```
  - getNotificationEmail
```
public UpdateUserByIdRequestBodyNotificationEmailField getNotificationEmail()
```
  - getExternalAppUserId
```
public String getExternalAppUserId()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class UpdateUserByIdRequestBody

Nested Class Summary

Field Summary

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

enterprise

notify

name

login

role

language

isSyncEnabled

jobTitle

phone

address

trackingCodes

canSeeManagedUsers

timezone

isExternalCollabRestricted

isExemptFromDeviceLimits

isExemptFromLoginVerification

isPasswordResetRequired

status

spaceAmount

notificationEmail

externalAppUserId

Constructor Detail

UpdateUserByIdRequestBody

UpdateUserByIdRequestBody

Method Detail

getEnterprise

getNotify

getName

getLogin

getRole

getLanguage

getIsSyncEnabled

getJobTitle

getPhone

getAddress

getTrackingCodes

getCanSeeManagedUsers

getTimezone

getIsExternalCollabRestricted

getIsExemptFromDeviceLimits

getIsExemptFromLoginVerification

getIsPasswordResetRequired

getStatus

getSpaceAmount

getNotificationEmail

getExternalAppUserId

equals

hashCode

toString