Class: BrickFTP::Types::User

Inherits:
Struct
  • Object
show all
Includes:
IgnoreUndefinedAttributes
Defined in:
lib/brick_ftp/types/user.rb

Overview

The user object

ATTRIBUTE TYPE DESCRIPTION
id integer Globally unique identifier of each user. Each user is given an ID automatically upon creation.
username string Username for the user. This is how the user will be displayed on the site. Maximum of 50 characters.
authentication_method enum Authentication method for this user. Can be one of the following: password, ldap, or oauth_google. Default is password.
last_login_at datetime The date and time of the most recent login for this user. This property is read-only.
password string Password for the user. This property is write-only. It cannot be retrieved via the API.
password_confirmation string Confirms the new password provided in the password field. This field is optional but will be validated if provided.
authenticate_until datetime If set, the user will be blocked from logging in after this date.
name string Real name of the user. For your reference. Maximum of 50 characters.
email string E-Mail address of the user. Maximum of 50 characters.
notes text You may use this property to store any additional information you require. There are no restrictions on its formatting.
group_ids comma-separated integers IDs of the Groups that this user is in.
ftp_permission boolean Allow user access via FTP/FTPS (port 21 or 990) interface. Default is true.
sftp_permission boolean Allow user access via SFTP (port 22) interface. Default is true.
dav_permission boolean Allow user access via WebDAV (port 443) interface. Default is true.
restapi_permission boolean Allow user access the REST API, via HTTP/HTTPS (port 80 or 443), and the desktop application. Default is true.
attachments_permission boolean Allow user to use Sharing tab in web interface to share files with anonymous users via a unique URL. Default is false.
self_managed boolean Allow user to change their password and user information via the web interface. Default is true.
require_password_change boolean Require user to change their password at their next login. Note: requires restapi_permission to be true, as password changes can only occur via the web interface. Default is false.
allowed_ips text List allowed IPs, one per line. You may specify a range in CIDR format, such as 192.168.1.0/27. Leave blank to allow all IPs. If you are also restricting IP addresses on the Site tab, users matching in either place will be allowed to log in.
user_root string Folder to show as the root when this user logs in via the FTP interface. Make sure this folder exists, as it will not be automatically created. Does not apply to the web interface! This should not contain a leading slash, but must contain a trailing slash. Example: Users/jenny/. Limit of 250 characters.
time_zone string File modification times will be displayed in this time zone. Default is Eastern Time (US & Canada).
language string The language that BrickFTP will be displayed in, if the translation is available. Leave as default (null) to auto-detect or use the site setting.
grant_permission enum Value must be set to full, read, write, preview, read+write, or preview+write. The user will be granted that permission on their FTP root folder as defined by the user_root. This property is write-only. It cannot be retrieved via the User resource of the REST API, though may be obtained with the Permissions resource of the REST API.
ssl_required enum Whether or not SSL encryption is required on all connections for this user. Can be one of the following: use_system_setting, always_require, or never_require. Default is use_system_setting.
site_admin boolean If set to true, this user will be treated as a site-wide administrator. Default is false.
receive_admin_alerts boolean Enable this user to receive alerts sent to site administrators. This property will only be accepted/returned if site_admin is true. Default is false.
subscribe_to_newsletter boolean Add this user to the BrickFTP newsletter and our mailing list for notices about product updates. This property will only be accepted/returned if site_admin is true. Default is false.
can_create_new_users boolean If true, this user will be able to create other users within groups where they have administrator privileges. Default is false.
last_protocol_cipher string The encryption protocol (for HTTPS or FTPS) or ciphers (for SFTP) that this user last connected with. This property is read-only.
lockout_expires datetime If the user has been locked out by Brute Force Login Protection, this will indicate when the lock expires. Otherwise this will be null. This property is read-only.
admin_group_ids comma-separated integers IDs of the Groups that this user is an administrator of.

See Also:

Instance Attribute Summary collapse

Method Summary

Methods included from IgnoreUndefinedAttributes

#initialize

Instance Attribute Details

#admin_group_ids ⇒ Object

Returns the value of attribute admin_group_ids

Returns:

  • (Object) —

    the current value of admin_group_ids



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def admin_group_ids
  @admin_group_ids
end

#allowed_ips ⇒ Object

Returns the value of attribute allowed_ips

Returns:

  • (Object) —

    the current value of allowed_ips



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def allowed_ips
  @allowed_ips
end

#attachments_permission ⇒ Object

Returns the value of attribute attachments_permission

Returns:

  • (Object) —

    the current value of attachments_permission



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def attachments_permission
  @attachments_permission
end

#authenticate_until ⇒ Object

Returns the value of attribute authenticate_until

Returns:

  • (Object) —

    the current value of authenticate_until



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def authenticate_until
  @authenticate_until
end

#authentication_method ⇒ Object

Returns the value of attribute authentication_method

Returns:

  • (Object) —

    the current value of authentication_method



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def authentication_method
  @authentication_method
end

#dav_permission ⇒ Object

Returns the value of attribute dav_permission

Returns:

  • (Object) —

    the current value of dav_permission



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def dav_permission
  @dav_permission
end

#email ⇒ Object

Returns the value of attribute email

Returns:

  • (Object) —

    the current value of email



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def email
  @email
end

#ftp_permission ⇒ Object

Returns the value of attribute ftp_permission

Returns:

  • (Object) —

    the current value of ftp_permission



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def ftp_permission
  @ftp_permission
end

#group_ids ⇒ Object

Returns the value of attribute group_ids

Returns:

  • (Object) —

    the current value of group_ids



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def group_ids
  @group_ids
end

#id ⇒ Object

Returns the value of attribute id

Returns:

  • (Object) —

    the current value of id



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def id
  @id
end

#language ⇒ Object

Returns the value of attribute language

Returns:

  • (Object) —

    the current value of language



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def language
  @language
end

#last_login_at ⇒ Object

Returns the value of attribute last_login_at

Returns:

  • (Object) —

    the current value of last_login_at



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def 
  @last_login_at
end

#last_protocol_cipher ⇒ Object

Returns the value of attribute last_protocol_cipher

Returns:

  • (Object) —

    the current value of last_protocol_cipher



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def last_protocol_cipher
  @last_protocol_cipher
end

#lockout_expires ⇒ Object

Returns the value of attribute lockout_expires

Returns:

  • (Object) —

    the current value of lockout_expires



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def lockout_expires
  @lockout_expires
end

#name ⇒ Object

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def name
  @name
end

#notes ⇒ Object

Returns the value of attribute notes

Returns:

  • (Object) —

    the current value of notes



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def notes
  @notes
end

#password_set_at ⇒ Object

Returns the value of attribute password_set_at

Returns:

  • (Object) —

    the current value of password_set_at



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def password_set_at
  @password_set_at
end

#receive_admin_alerts ⇒ Object

Returns the value of attribute receive_admin_alerts

Returns:

  • (Object) —

    the current value of receive_admin_alerts



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def receive_admin_alerts
  @receive_admin_alerts
end

#require_2fa ⇒ Object

Returns the value of attribute require_2fa

Returns:

  • (Object) —

    the current value of require_2fa



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def require_2fa
  @require_2fa
end

#require_password_change ⇒ Object

Returns the value of attribute require_password_change

Returns:

  • (Object) —

    the current value of require_password_change



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def require_password_change
  @require_password_change
end

#restapi_permission ⇒ Object

Returns the value of attribute restapi_permission

Returns:

  • (Object) —

    the current value of restapi_permission



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def restapi_permission
  @restapi_permission
end

#self_managed ⇒ Object

Returns the value of attribute self_managed

Returns:

  • (Object) —

    the current value of self_managed



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def self_managed
  @self_managed
end

#sftp_permission ⇒ Object

Returns the value of attribute sftp_permission

Returns:

  • (Object) —

    the current value of sftp_permission



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def sftp_permission
  @sftp_permission
end

#site_admin ⇒ Object

Returns the value of attribute site_admin

Returns:

  • (Object) —

    the current value of site_admin



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def site_admin
  @site_admin
end

#ssl_required ⇒ Object

Returns the value of attribute ssl_required

Returns:

  • (Object) —

    the current value of ssl_required



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def ssl_required
  @ssl_required
end

#subscribe_to_newsletter ⇒ Object

Returns the value of attribute subscribe_to_newsletter

Returns:

  • (Object) —

    the current value of subscribe_to_newsletter



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def subscribe_to_newsletter
  @subscribe_to_newsletter
end

#time_zone ⇒ Object

Returns the value of attribute time_zone

Returns:

  • (Object) —

    the current value of time_zone



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def time_zone
  @time_zone
end

#user_root ⇒ Object

Returns the value of attribute user_root

Returns:

  • (Object) —

    the current value of user_root



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def user_root
  @user_root
end

#username ⇒ Object

Returns the value of attribute username

Returns:

  • (Object) —

    the current value of username



45
46
47
 
# File 'lib/brick_ftp/types/user.rb', line 45

def username
  @username
end