User (Files.com Java SDK 1.4.56 API)

java.lang.Object
- com.files.models.User

All Implemented Interfaces:: ModelInterface

public class User
extends Object
implements ModelInterface

Field Summary

Fields
Modifier and Type	Field and Description
`Boolean`	`active2fa` Is 2fa active for the user?
`Long[]`	`adminGroupIds` List of group IDs of which this user is an administrator
`String`	`allowedIps` A list of allowed IPs if applicable.
`Boolean`	`announcementsRead` Signifies that the user has read all the announcements in the UI.
`Long`	`apiKeysCount` Number of API keys associated with this user
`Boolean`	`attachmentsPermission` If `true`, the user can user create Bundles (aka Share Links).
`Date`	`authenticateUntil` Scheduled Date/Time at which user will be deactivated
`String`	`authenticationMethod` How is this user authenticated?
`Boolean`	`avatarDelete` If true, the avatar will be deleted.
`byte[]`	`avatarFile` An image file for your user avatar.
`String`	`avatarUrl` URL holding the user's avatar
`Boolean`	`billingPermission` Allow this user to perform operations on the account, payments, and invoices?
`Boolean`	`bypassInactiveDisable` Exempt this user from being disabled based on inactivity?
`Boolean`	`bypassSiteAllowedIps` Allow this user to skip site-wide IP blacklists?
`String`	`changePassword` Used for changing a password on an existing user.
`String`	`changePasswordConfirmation` Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
`String`	`company` User's company
`Date`	`createdAt` When this user was created
`Boolean`	`davPermission` Can the user connect with WebDAV?
`Long`	`daysRemainingUntilPasswordExpire` Number of days remaining until password expires
`Boolean`	`disabled` Is user disabled?
`Boolean`	`disabledExpiredOrInactive` Computed property that returns true if user disabled or expired or inactive.
`String`	`email` User email address
`Boolean`	`externallyManaged` Is this user managed by a SsoStrategy?
`Date`	`firstLoginAt` User's first login time
`Boolean`	`ftpPermission` Can the user access with FTP/FTPS?
`String`	`grantPermission` Permission to grant on the user root.
`Long`	`groupId` Group ID to associate this user with.
`String`	`groupIds` Comma-separated list of group IDs of which this user is a member
`String`	`headerText` Text to display to the user in the header of the UI
`Long`	`id` User ID
`String`	`importedPasswordHash` Pre-calculated hash of the user's password.
`String`	`language` Preferred language
`Date`	`lastActiveAt` User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
`Date`	`lastApiUseAt` User's most recent API use time
`Date`	`lastDavLoginAt` User's most recent login time via WebDAV
`Date`	`lastDesktopLoginAt` User's most recent login time via Desktop app
`Date`	`lastFtpLoginAt` User's most recent login time via FTP
`Date`	`lastLoginAt` User's most recent login time via any protocol
`String`	`lastProtocolCipher` The most recent protocol and cipher used
`Date`	`lastRestapiLoginAt` User's most recent login time via Rest API
`Date`	`lastSftpLoginAt` User's most recent login time via SFTP
`Date`	`lastWebLoginAt` User's most recent login time via web
`Date`	`lockoutExpires` Time in the future that the user will no longer be locked out if applicable
`String`	`name` User's full name
`String`	`notes` Any internal notes on the user
`Long`	`notificationDailySendTime` Hour of the day at which daily notifications should be sent.
`Boolean`	`officeIntegrationEnabled` Enable integration with Office for the web?
`String`	`password` User password.
`String`	`passwordConfirmation` Optional, but if provided, we will ensure that it matches the value sent in `password`.
`Date`	`passwordExpireAt` Password expiration datetime
`Boolean`	`passwordExpired` Is user's password expired?
`Date`	`passwordSetAt` Last time the user's password was set
`Long`	`passwordValidityDays` Number of days to allow user to use the same password
`Long`	`publicKeysCount` Number of public keys associated with this user
`Boolean`	`readonlySiteAdmin` Is the user an allowed to view all (non-billing) site configuration for this site?
`Boolean`	`receiveAdminAlerts` Should the user receive admin alerts such a certificate expiration notifications and overages?
`String`	`require2fa` 2FA required setting
`Date`	`requireLoginBy` Require user to login by specified date otherwise it will be disabled.
`Boolean`	`requirePasswordChange` Is a password change required upon next user login?
`Boolean`	`restapiPermission` Can this user access the Web app, Desktop app, SDKs, or REST API?
`Boolean`	`selfManaged` Does this user manage it's own credentials or is it a shared/bot user?
`Boolean`	`sftpPermission` Can the user access with SFTP?
`Boolean`	`siteAdmin` Is the user an administrator for this site?
`Boolean`	`skipWelcomeScreen` Skip Welcome page in the UI?
`String`	`sslRequired` SSL required setting
`Long`	`ssoStrategyId` SSO (Single Sign On) strategy ID for the user, if applicable.
`Boolean`	`subscribeToNewsletter` Is the user subscribed to the newsletter?
`String`	`timeZone` User time zone
`String`	`typeOf2fa` Type(s) of 2FA methods in use, for programmatic use.
`String`	`typeOf2faForDisplay` Type(s) of 2FA methods in use, formatted for displaying in the UI.
`String`	`userHome` Home folder for FTP/SFTP.
`String`	`username` User's username
`String`	`userRoot` Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).

Constructor Summary

Constructors
Constructor and Description

User()

User(HashMap<String,Object> parameters)

User(HashMap<String,Object> parameters, HashMap<String,Object> options)

Constructors
Constructor and Description
`User()`
`User(HashMap<String,Object> parameters)`
`User(HashMap<String,Object> parameters, HashMap<String,Object> options)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListIterator<User>`	`all()`
`static ListIterator<User>`	`all(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static User`	`create(HashMap<String,Object> parameters)` Parameters: avatar_file - file - An image file for your user avatar.
`static User`	`create(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`void`	`delete()`
`static void`	`delete(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static void`	`delete(Long id, HashMap<String,Object> parameters)`
`static void`	`delete(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static void`	`destroy()`
`void`	`destroy(HashMap<String,Object> parameters)`
`static void`	`destroy(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static User`	`find(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static User`	`find(Long id, HashMap<String,Object> parameters)` Parameters: id (required) - int64 - User ID.
`static User`	`find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static User`	`get()`
`static User`	`get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static ListIterator<User>`	`list()` Parameters: cursor - string - Used for pagination.
`static ListIterator<User>`	`list(HashMap<String,Object> parameters)`
`static ListIterator<User>`	`list(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`void`	`resendWelcomeEmail()` Resend user welcome email
`static void`	`resendWelcomeEmail(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static void`	`resendWelcomeEmail(Long id, HashMap<String,Object> parameters)` Resend user welcome email
`static void`	`resendWelcomeEmail(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`void`	`save()`
`void`	`unlock()` Unlock user who has been locked out due to failed logins
`static void`	`unlock(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static void`	`unlock(Long id, HashMap<String,Object> parameters)` Unlock user who has been locked out due to failed logins
`static void`	`unlock(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`User`	`update()` Parameters: avatar_file - file - An image file for your user avatar.
`static User`	`update(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static User`	`update(Long id, HashMap<String,Object> parameters)` Parameters: avatar_file - file - An image file for your user avatar.
`static User`	`update(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`void`	`user2faReset()` Trigger 2FA Reset process for user who has lost access to their existing 2FA methods
`static void`	`user2faReset(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static void`	`user2faReset(Long id, HashMap<String,Object> parameters)` Trigger 2FA Reset process for user who has lost access to their existing 2FA methods
`static void`	`user2faReset(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`

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

Methods inherited from interface com.files.models.ModelInterface
setOptions

- Field Detail
  - id
```
public Long id
```
    User ID
  - username
```
public String username
```
    User's username
  - adminGroupIds
```
public Long[] adminGroupIds
```
    List of group IDs of which this user is an administrator
  - allowedIps
```
public String allowedIps
```
    A list of allowed IPs if applicable. Newline delimited
  - attachmentsPermission
```
public Boolean attachmentsPermission
```
    If `true`, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
  - apiKeysCount
```
public Long apiKeysCount
```
    Number of API keys associated with this user
  - authenticateUntil
```
public Date authenticateUntil
```
    Scheduled Date/Time at which user will be deactivated
  - authenticationMethod
```
public String authenticationMethod
```
    How is this user authenticated?
  - avatarUrl
```
public String avatarUrl
```
    URL holding the user's avatar
  - billingPermission
```
public Boolean billingPermission
```
    Allow this user to perform operations on the account, payments, and invoices?
  - bypassSiteAllowedIps
```
public Boolean bypassSiteAllowedIps
```
    Allow this user to skip site-wide IP blacklists?
  - bypassInactiveDisable
```
public Boolean bypassInactiveDisable
```
    Exempt this user from being disabled based on inactivity?
  - createdAt
```
public Date createdAt
```
    When this user was created
  - davPermission
```
public Boolean davPermission
```
    Can the user connect with WebDAV?
  - disabled
```
public Boolean disabled
```
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
  - disabledExpiredOrInactive
```
public Boolean disabledExpiredOrInactive
```
    Computed property that returns true if user disabled or expired or inactive.
  - email
```
public String email
```
    User email address
  - firstLoginAt
```
public Date firstLoginAt
```
    User's first login time
  - ftpPermission
```
public Boolean ftpPermission
```
    Can the user access with FTP/FTPS?
  - groupIds
```
public String groupIds
```
    Comma-separated list of group IDs of which this user is a member
  - headerText
```
public String headerText
```
    Text to display to the user in the header of the UI
  - language
```
public String language
```
    Preferred language
  - lastLoginAt
```
public Date lastLoginAt
```
    User's most recent login time via any protocol
  - lastWebLoginAt
```
public Date lastWebLoginAt
```
    User's most recent login time via web
  - lastFtpLoginAt
```
public Date lastFtpLoginAt
```
    User's most recent login time via FTP
  - lastSftpLoginAt
```
public Date lastSftpLoginAt
```
    User's most recent login time via SFTP
  - lastDavLoginAt
```
public Date lastDavLoginAt
```
    User's most recent login time via WebDAV
  - lastDesktopLoginAt
```
public Date lastDesktopLoginAt
```
    User's most recent login time via Desktop app
  - lastRestapiLoginAt
```
public Date lastRestapiLoginAt
```
    User's most recent login time via Rest API
  - lastApiUseAt
```
public Date lastApiUseAt
```
    User's most recent API use time
  - lastActiveAt
```
public Date lastActiveAt
```
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
  - lastProtocolCipher
```
public String lastProtocolCipher
```
    The most recent protocol and cipher used
  - lockoutExpires
```
public Date lockoutExpires
```
    Time in the future that the user will no longer be locked out if applicable
  - name
```
public String name
```
    User's full name
  - company
```
public String company
```
    User's company
  - notes
```
public String notes
```
    Any internal notes on the user
  - notificationDailySendTime
```
public Long notificationDailySendTime
```
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
  - officeIntegrationEnabled
```
public Boolean officeIntegrationEnabled
```
    Enable integration with Office for the web?
  - passwordSetAt
```
public Date passwordSetAt
```
    Last time the user's password was set
  - passwordValidityDays
```
public Long passwordValidityDays
```
    Number of days to allow user to use the same password
  - publicKeysCount
```
public Long publicKeysCount
```
    Number of public keys associated with this user
  - receiveAdminAlerts
```
public Boolean receiveAdminAlerts
```
    Should the user receive admin alerts such a certificate expiration notifications and overages?
  - require2fa
```
public String require2fa
```
    2FA required setting
  - requireLoginBy
```
public Date requireLoginBy
```
    Require user to login by specified date otherwise it will be disabled.
  - active2fa
```
public Boolean active2fa
```
    Is 2fa active for the user?
  - requirePasswordChange
```
public Boolean requirePasswordChange
```
    Is a password change required upon next user login?
  - passwordExpired
```
public Boolean passwordExpired
```
    Is user's password expired?
  - readonlySiteAdmin
```
public Boolean readonlySiteAdmin
```
    Is the user an allowed to view all (non-billing) site configuration for this site?
  - restapiPermission
```
public Boolean restapiPermission
```
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
  - selfManaged
```
public Boolean selfManaged
```
    Does this user manage it's own credentials or is it a shared/bot user?
  - sftpPermission
```
public Boolean sftpPermission
```
    Can the user access with SFTP?
  - siteAdmin
```
public Boolean siteAdmin
```
    Is the user an administrator for this site?
  - skipWelcomeScreen
```
public Boolean skipWelcomeScreen
```
    Skip Welcome page in the UI?
  - sslRequired
```
public String sslRequired
```
    SSL required setting
  - ssoStrategyId
```
public Long ssoStrategyId
```
    SSO (Single Sign On) strategy ID for the user, if applicable.
  - subscribeToNewsletter
```
public Boolean subscribeToNewsletter
```
    Is the user subscribed to the newsletter?
  - externallyManaged
```
public Boolean externallyManaged
```
    Is this user managed by a SsoStrategy?
  - timeZone
```
public String timeZone
```
    User time zone
  - typeOf2fa
```
public String typeOf2fa
```
    Type(s) of 2FA methods in use, for programmatic use. Will be either `sms`, `totp`, `webauthn`, `yubi`, `email`, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
  - typeOf2faForDisplay
```
public String typeOf2faForDisplay
```
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike `type_of_2fa`, this value will make clear when a user has more than 1 of the same type of method.
  - userRoot
```
public String userRoot
```
    Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Note that this is not used for API, Desktop, or Web interface.
  - userHome
```
public String userHome
```
    Home folder for FTP/SFTP. Note that this is not used for API, Desktop, or Web interface.
  - daysRemainingUntilPasswordExpire
```
public Long daysRemainingUntilPasswordExpire
```
    Number of days remaining until password expires
  - passwordExpireAt
```
public Date passwordExpireAt
```
    Password expiration datetime
  - avatarFile
```
public byte[] avatarFile
```
    An image file for your user avatar.
  - avatarDelete
```
public Boolean avatarDelete
```
    If true, the avatar will be deleted.
  - changePassword
```
public String changePassword
```
    Used for changing a password on an existing user.
  - changePasswordConfirmation
```
public String changePasswordConfirmation
```
    Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
  - grantPermission
```
public String grantPermission
```
    Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write`
  - groupId
```
public Long groupId
```
    Group ID to associate this user with.
  - importedPasswordHash
```
public String importedPasswordHash
```
    Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
  - password
```
public String password
```
    User password.
  - passwordConfirmation
```
public String passwordConfirmation
```
    Optional, but if provided, we will ensure that it matches the value sent in `password`.
  - announcementsRead
```
public Boolean announcementsRead
```
    Signifies that the user has read all the announcements in the UI.
- Constructor Detail
  - User
```
public User()
```
  - User
```
public User(HashMap<String,Object> parameters)
```
  - User
```
public User(HashMap<String,Object> parameters,
            HashMap<String,Object> options)
```
- Method Detail
  - unlock
```
public void unlock()
            throws IOException
```
    Unlock user who has been locked out due to failed logins
    
    Throws:
    
    IOException
  - resendWelcomeEmail
```
public void resendWelcomeEmail()
                        throws IOException
```
    Resend user welcome email
    
    Throws:
    
    IOException
  - user2faReset
```
public void user2faReset()
                  throws IOException
```
    Trigger 2FA Reset process for user who has lost access to their existing 2FA methods
    
    Throws:
    
    IOException
  - update
```
public User update()
            throws IOException
```
    Parameters: avatar_file - file - An image file for your user avatar. avatar_delete - boolean - If true, the avatar will be deleted. change_password - string - Used for changing a password on an existing user. change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`. email - string - User's email. grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write` group_id - int64 - Group ID to associate this user with. group_ids - string - A list of group ids to associate this user with. Comma delimited. imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256. password - string - User password. password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`. announcements_read - boolean - Signifies that the user has read all the announcements in the UI. allowed_ips - string - A list of allowed IPs if applicable. Newline delimited attachments_permission - boolean - DEPRECATED: If `true`, the user can user create Bundles (aka Share Links). Use the bundle permission instead. authenticate_until - string - Scheduled Date/Time at which user will be deactivated authentication_method - string - How is this user authenticated? billing_permission - boolean - Allow this user to perform operations on the account, payments, and invoices? bypass_inactive_disable - boolean - Exempt this user from being disabled based on inactivity? bypass_site_allowed_ips - boolean - Allow this user to skip site-wide IP blacklists? dav_permission - boolean - Can the user connect with WebDAV? disabled - boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date. ftp_permission - boolean - Can the user access with FTP/FTPS? header_text - string - Text to display to the user in the header of the UI language - string - Preferred language notification_daily_send_time - int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23 name - string - User's full name company - string - User's company notes - string - Any internal notes on the user office_integration_enabled - boolean - Enable integration with Office for the web? password_validity_days - int64 - Number of days to allow user to use the same password readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site? receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages? require_login_by - string - Require user to login by specified date otherwise it will be disabled. require_password_change - boolean - Is a password change required upon next user login? restapi_permission - boolean - Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.) self_managed - boolean - Does this user manage it's own credentials or is it a shared/bot user? sftp_permission - boolean - Can the user access with SFTP? site_admin - boolean - Is the user an administrator for this site? skip_welcome_screen - boolean - Skip Welcome page in the UI? ssl_required - string - SSL required setting sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable. subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter? require_2fa - string - 2FA required setting time_zone - string - User time zone user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Note that this is not used for API, Desktop, or Web interface. user_home - string - Home folder for FTP/SFTP. Note that this is not used for API, Desktop, or Web interface. username - string - User's username
    
    Throws:
    
    IOException
  - delete
```
public void delete()
            throws IOException
```
    Throws:
    
    IOException
  - destroy
```
public void destroy(HashMap<String,Object> parameters)
             throws IOException
```
    Throws:
    
    IOException
  - save
```
public void save()
          throws IOException
```
    Throws:
    
    IOException
  - list
```
public static ListIterator<User> list()
                               throws RuntimeException
```
    Parameters: cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended). sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ username, not_site_admin ]`. filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`. filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `email` or `company`. filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`. filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`. ids - string - comma-separated list of User IDs search - string - Searches for partial matches of name, username, or email.
    
    Throws:
    
    RuntimeException
  - list
```
public static ListIterator<User> list(HashMap<String,Object> parameters)
                               throws RuntimeException
```
    Throws:
    
    RuntimeException
  - list
```
public static ListIterator<User> list(HashMap<String,Object> parameters,
                                      HashMap<String,Object> options)
                               throws RuntimeException
```
    Throws:
    
    RuntimeException
  - all
```
public static ListIterator<User> all()
                              throws RuntimeException
```
    Throws:
    
    RuntimeException
  - all
```
public static ListIterator<User> all(HashMap<String,Object> parameters,
                                     HashMap<String,Object> options)
                              throws RuntimeException
```
    Throws:
    
    RuntimeException
  - find
```
public static User find(Long id,
                        HashMap<String,Object> parameters)
                 throws RuntimeException
```
    Parameters: id (required) - int64 - User ID.
    
    Throws:
    
    RuntimeException
  - find
```
public static User find(HashMap<String,Object> parameters,
                        HashMap<String,Object> options)
                 throws RuntimeException
```
    Throws:
    
    RuntimeException
  - find
```
public static User find(Long id,
                        HashMap<String,Object> parameters,
                        HashMap<String,Object> options)
                 throws RuntimeException
```
    Throws:
    
    RuntimeException
  - get
```
public static User get()
                throws RuntimeException
```
    Throws:
    
    RuntimeException
  - get
```
public static User get(Long id,
                       HashMap<String,Object> parameters,
                       HashMap<String,Object> options)
                throws RuntimeException
```
    Throws:
    
    RuntimeException
  - create
```
public static User create(HashMap<String,Object> parameters)
                   throws RuntimeException
```
    Parameters: avatar_file - file - An image file for your user avatar. avatar_delete - boolean - If true, the avatar will be deleted. change_password - string - Used for changing a password on an existing user. change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`. email - string - User's email. grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write` group_id - int64 - Group ID to associate this user with. group_ids - string - A list of group ids to associate this user with. Comma delimited. imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256. password - string - User password. password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`. announcements_read - boolean - Signifies that the user has read all the announcements in the UI. allowed_ips - string - A list of allowed IPs if applicable. Newline delimited attachments_permission - boolean - DEPRECATED: If `true`, the user can user create Bundles (aka Share Links). Use the bundle permission instead. authenticate_until - string - Scheduled Date/Time at which user will be deactivated authentication_method - string - How is this user authenticated? billing_permission - boolean - Allow this user to perform operations on the account, payments, and invoices? bypass_inactive_disable - boolean - Exempt this user from being disabled based on inactivity? bypass_site_allowed_ips - boolean - Allow this user to skip site-wide IP blacklists? dav_permission - boolean - Can the user connect with WebDAV? disabled - boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date. ftp_permission - boolean - Can the user access with FTP/FTPS? header_text - string - Text to display to the user in the header of the UI language - string - Preferred language notification_daily_send_time - int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23 name - string - User's full name company - string - User's company notes - string - Any internal notes on the user office_integration_enabled - boolean - Enable integration with Office for the web? password_validity_days - int64 - Number of days to allow user to use the same password readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site? receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages? require_login_by - string - Require user to login by specified date otherwise it will be disabled. require_password_change - boolean - Is a password change required upon next user login? restapi_permission - boolean - Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.) self_managed - boolean - Does this user manage it's own credentials or is it a shared/bot user? sftp_permission - boolean - Can the user access with SFTP? site_admin - boolean - Is the user an administrator for this site? skip_welcome_screen - boolean - Skip Welcome page in the UI? ssl_required - string - SSL required setting sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable. subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter? require_2fa - string - 2FA required setting time_zone - string - User time zone user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Note that this is not used for API, Desktop, or Web interface. user_home - string - Home folder for FTP/SFTP. Note that this is not used for API, Desktop, or Web interface. username (required) - string - User's username
    
    Throws:
    
    RuntimeException
  - create
```
public static User create(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - unlock
```
public static void unlock(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException
```
    Unlock user who has been locked out due to failed logins
    
    Throws:
    
    RuntimeException
  - unlock
```
public static void unlock(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - unlock
```
public static void unlock(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - resendWelcomeEmail
```
public static void resendWelcomeEmail(Long id,
                                      HashMap<String,Object> parameters)
                               throws RuntimeException
```
    Resend user welcome email
    
    Throws:
    
    RuntimeException
  - resendWelcomeEmail
```
public static void resendWelcomeEmail(HashMap<String,Object> parameters,
                                      HashMap<String,Object> options)
                               throws RuntimeException
```
    Throws:
    
    RuntimeException
  - resendWelcomeEmail
```
public static void resendWelcomeEmail(Long id,
                                      HashMap<String,Object> parameters,
                                      HashMap<String,Object> options)
                               throws RuntimeException
```
    Throws:
    
    RuntimeException
  - user2faReset
```
public static void user2faReset(Long id,
                                HashMap<String,Object> parameters)
                         throws RuntimeException
```
    Trigger 2FA Reset process for user who has lost access to their existing 2FA methods
    
    Throws:
    
    RuntimeException
  - user2faReset
```
public static void user2faReset(HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException
```
    Throws:
    
    RuntimeException
  - user2faReset
```
public static void user2faReset(Long id,
                                HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException
```
    Throws:
    
    RuntimeException
  - update
```
public static User update(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException
```
    Parameters: avatar_file - file - An image file for your user avatar. avatar_delete - boolean - If true, the avatar will be deleted. change_password - string - Used for changing a password on an existing user. change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`. email - string - User's email. grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write` group_id - int64 - Group ID to associate this user with. group_ids - string - A list of group ids to associate this user with. Comma delimited. imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256. password - string - User password. password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`. announcements_read - boolean - Signifies that the user has read all the announcements in the UI. allowed_ips - string - A list of allowed IPs if applicable. Newline delimited attachments_permission - boolean - DEPRECATED: If `true`, the user can user create Bundles (aka Share Links). Use the bundle permission instead. authenticate_until - string - Scheduled Date/Time at which user will be deactivated authentication_method - string - How is this user authenticated? billing_permission - boolean - Allow this user to perform operations on the account, payments, and invoices? bypass_inactive_disable - boolean - Exempt this user from being disabled based on inactivity? bypass_site_allowed_ips - boolean - Allow this user to skip site-wide IP blacklists? dav_permission - boolean - Can the user connect with WebDAV? disabled - boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date. ftp_permission - boolean - Can the user access with FTP/FTPS? header_text - string - Text to display to the user in the header of the UI language - string - Preferred language notification_daily_send_time - int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23 name - string - User's full name company - string - User's company notes - string - Any internal notes on the user office_integration_enabled - boolean - Enable integration with Office for the web? password_validity_days - int64 - Number of days to allow user to use the same password readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site? receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages? require_login_by - string - Require user to login by specified date otherwise it will be disabled. require_password_change - boolean - Is a password change required upon next user login? restapi_permission - boolean - Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.) self_managed - boolean - Does this user manage it's own credentials or is it a shared/bot user? sftp_permission - boolean - Can the user access with SFTP? site_admin - boolean - Is the user an administrator for this site? skip_welcome_screen - boolean - Skip Welcome page in the UI? ssl_required - string - SSL required setting sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable. subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter? require_2fa - string - 2FA required setting time_zone - string - User time zone user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Note that this is not used for API, Desktop, or Web interface. user_home - string - Home folder for FTP/SFTP. Note that this is not used for API, Desktop, or Web interface. username - string - User's username
    
    Throws:
    
    RuntimeException
  - update
```
public static User update(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - update
```
public static User update(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - delete
```
public static void delete(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - delete
```
public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - delete
```
public static void delete(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - destroy
```
public static void destroy()
                    throws RuntimeException
```
    Throws:
    
    RuntimeException
  - destroy
```
public static void destroy(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException
```
    Throws:
    
    RuntimeException

Class User

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.files.models.ModelInterface

Field Detail

id

username

adminGroupIds

allowedIps

attachmentsPermission

apiKeysCount

authenticateUntil

authenticationMethod

avatarUrl

billingPermission

bypassSiteAllowedIps

bypassInactiveDisable

createdAt

davPermission

disabled

disabledExpiredOrInactive

email

firstLoginAt

ftpPermission

groupIds

headerText

language

lastLoginAt

lastWebLoginAt

lastFtpLoginAt

lastSftpLoginAt

lastDavLoginAt

lastDesktopLoginAt

lastRestapiLoginAt

lastApiUseAt

lastActiveAt

lastProtocolCipher

lockoutExpires

name

company

notes

notificationDailySendTime

officeIntegrationEnabled

passwordSetAt

passwordValidityDays

publicKeysCount

receiveAdminAlerts

require2fa

requireLoginBy

active2fa

requirePasswordChange

passwordExpired

readonlySiteAdmin

restapiPermission

selfManaged

sftpPermission

siteAdmin

skipWelcomeScreen

sslRequired

ssoStrategyId

subscribeToNewsletter

externallyManaged

timeZone

typeOf2fa

typeOf2faForDisplay

userRoot

userHome

daysRemainingUntilPasswordExpire

passwordExpireAt

avatarFile

avatarDelete

changePassword

changePasswordConfirmation

grantPermission

groupId

importedPasswordHash

password

passwordConfirmation