files.com 1.0.53 → 1.0.58
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/bundle.md +54 -5
- data/docs/site.md +2 -5
- data/docs/sso_strategy.md +4 -0
- data/lib/files.com/models/api_key.rb +5 -5
- data/lib/files.com/models/as2_key.rb +5 -5
- data/lib/files.com/models/automation.rb +3 -3
- data/lib/files.com/models/behavior.rb +5 -5
- data/lib/files.com/models/bundle.rb +54 -12
- data/lib/files.com/models/dns_record.rb +2 -2
- data/lib/files.com/models/file.rb +9 -9
- data/lib/files.com/models/file_action.rb +6 -6
- data/lib/files.com/models/file_comment.rb +2 -2
- data/lib/files.com/models/file_comment_reaction.rb +2 -2
- data/lib/files.com/models/folder.rb +2 -2
- data/lib/files.com/models/group.rb +3 -3
- data/lib/files.com/models/group_user.rb +8 -8
- data/lib/files.com/models/history.rb +11 -11
- data/lib/files.com/models/history_export.rb +10 -10
- data/lib/files.com/models/invoice.rb +3 -3
- data/lib/files.com/models/ip_address.rb +2 -2
- data/lib/files.com/models/lock.rb +3 -3
- data/lib/files.com/models/message.rb +9 -9
- data/lib/files.com/models/message_comment.rb +6 -6
- data/lib/files.com/models/message_comment_reaction.rb +6 -6
- data/lib/files.com/models/message_reaction.rb +6 -6
- data/lib/files.com/models/notification.rb +7 -7
- data/lib/files.com/models/payment.rb +3 -3
- data/lib/files.com/models/permission.rb +5 -5
- data/lib/files.com/models/project.rb +3 -3
- data/lib/files.com/models/public_key.rb +5 -5
- data/lib/files.com/models/remote_server.rb +9 -9
- data/lib/files.com/models/request.rb +7 -7
- data/lib/files.com/models/site.rb +13 -20
- data/lib/files.com/models/sso_strategy.rb +13 -3
- data/lib/files.com/models/usage_daily_snapshot.rb +2 -2
- data/lib/files.com/models/usage_snapshot.rb +2 -2
- data/lib/files.com/models/user.rb +15 -15
- data/lib/files.com/models/user_cipher_use.rb +3 -3
- metadata +2 -2
@@ -80,8 +80,8 @@ module Files
|
|
80
80
|
end
|
81
81
|
|
82
82
|
# Parameters:
|
83
|
-
# page -
|
84
|
-
# per_page -
|
83
|
+
# page - int64 - Current page number.
|
84
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
85
85
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
86
86
|
def self.list(params = {}, options = {})
|
87
87
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -96,7 +96,7 @@ module Files
|
|
96
96
|
end
|
97
97
|
|
98
98
|
# Parameters:
|
99
|
-
# id (required) -
|
99
|
+
# id (required) - int64 - Payment ID.
|
100
100
|
def self.find(id, params = {}, options = {})
|
101
101
|
params ||= {}
|
102
102
|
params[:id] = id
|
@@ -91,8 +91,8 @@ module Files
|
|
91
91
|
end
|
92
92
|
|
93
93
|
# Parameters:
|
94
|
-
# page -
|
95
|
-
# per_page -
|
94
|
+
# page - int64 - Current page number.
|
95
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
96
96
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
97
97
|
# path - string - Permission path. If provided, will scope permissions to this path.
|
98
98
|
# group_id - string - Group ID. If provided, will scope permissions to this group.
|
@@ -116,11 +116,11 @@ module Files
|
|
116
116
|
end
|
117
117
|
|
118
118
|
# Parameters:
|
119
|
-
# group_id -
|
119
|
+
# group_id - int64 - Group ID
|
120
120
|
# path - string - Folder path
|
121
121
|
# permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `previewonly`, or `history`
|
122
122
|
# recursive - boolean - Apply to subfolders recursively?
|
123
|
-
# user_id -
|
123
|
+
# user_id - int64 - User ID. Provide `username` or `user_id`
|
124
124
|
# username - string - User username. Provide `username` or `user_id`
|
125
125
|
def self.create(path, params = {}, options = {})
|
126
126
|
params ||= {}
|
@@ -136,7 +136,7 @@ module Files
|
|
136
136
|
end
|
137
137
|
|
138
138
|
# Parameters:
|
139
|
-
# id (required) -
|
139
|
+
# id (required) - int64 - Permission ID.
|
140
140
|
def self.delete(id, params = {}, options = {})
|
141
141
|
params ||= {}
|
142
142
|
params[:id] = id
|
@@ -65,8 +65,8 @@ module Files
|
|
65
65
|
end
|
66
66
|
|
67
67
|
# Parameters:
|
68
|
-
# page -
|
69
|
-
# per_page -
|
68
|
+
# page - int64 - Current page number.
|
69
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
70
70
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
71
71
|
def self.list(params = {}, options = {})
|
72
72
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -81,7 +81,7 @@ module Files
|
|
81
81
|
end
|
82
82
|
|
83
83
|
# Parameters:
|
84
|
-
# id (required) -
|
84
|
+
# id (required) - int64 - Project ID.
|
85
85
|
def self.find(id, params = {}, options = {})
|
86
86
|
params ||= {}
|
87
87
|
params[:id] = id
|
@@ -97,9 +97,9 @@ module Files
|
|
97
97
|
end
|
98
98
|
|
99
99
|
# Parameters:
|
100
|
-
# user_id -
|
101
|
-
# page -
|
102
|
-
# per_page -
|
100
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
101
|
+
# page - int64 - Current page number.
|
102
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
103
103
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
104
104
|
def self.list(params = {}, options = {})
|
105
105
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
@@ -115,7 +115,7 @@ module Files
|
|
115
115
|
end
|
116
116
|
|
117
117
|
# Parameters:
|
118
|
-
# id (required) -
|
118
|
+
# id (required) - int64 - Public Key ID.
|
119
119
|
def self.find(id, params = {}, options = {})
|
120
120
|
params ||= {}
|
121
121
|
params[:id] = id
|
@@ -131,7 +131,7 @@ module Files
|
|
131
131
|
end
|
132
132
|
|
133
133
|
# Parameters:
|
134
|
-
# user_id -
|
134
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
135
135
|
# title (required) - string - Internal reference for key.
|
136
136
|
# public_key (required) - string - Actual contents of SSH key.
|
137
137
|
def self.create(params = {}, options = {})
|
@@ -264,8 +264,8 @@ module Files
|
|
264
264
|
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
|
265
265
|
# hostname - string - Hostname or IP address
|
266
266
|
# name - string - Internal name for your reference
|
267
|
-
# max_connections -
|
268
|
-
# port -
|
267
|
+
# max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
|
268
|
+
# port - int64 - Port for remote server. Not needed for S3.
|
269
269
|
# s3_bucket - string - S3 bucket name
|
270
270
|
# s3_region - string - S3 region
|
271
271
|
# server_certificate - string - Remote server certificate
|
@@ -337,8 +337,8 @@ module Files
|
|
337
337
|
end
|
338
338
|
|
339
339
|
# Parameters:
|
340
|
-
# page -
|
341
|
-
# per_page -
|
340
|
+
# page - int64 - Current page number.
|
341
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
342
342
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
343
343
|
def self.list(params = {}, options = {})
|
344
344
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -353,7 +353,7 @@ module Files
|
|
353
353
|
end
|
354
354
|
|
355
355
|
# Parameters:
|
356
|
-
# id (required) -
|
356
|
+
# id (required) - int64 - Remote Server ID.
|
357
357
|
def self.find(id, params = {}, options = {})
|
358
358
|
params ||= {}
|
359
359
|
params[:id] = id
|
@@ -380,8 +380,8 @@ module Files
|
|
380
380
|
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
|
381
381
|
# hostname - string - Hostname or IP address
|
382
382
|
# name - string - Internal name for your reference
|
383
|
-
# max_connections -
|
384
|
-
# port -
|
383
|
+
# max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
|
384
|
+
# port - int64 - Port for remote server. Not needed for S3.
|
385
385
|
# s3_bucket - string - S3 bucket name
|
386
386
|
# s3_region - string - S3 region
|
387
387
|
# server_certificate - string - Remote server certificate
|
@@ -437,8 +437,8 @@ module Files
|
|
437
437
|
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
|
438
438
|
# hostname - string - Hostname or IP address
|
439
439
|
# name - string - Internal name for your reference
|
440
|
-
# max_connections -
|
441
|
-
# port -
|
440
|
+
# max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
|
441
|
+
# port - int64 - Port for remote server. Not needed for S3.
|
442
442
|
# s3_bucket - string - S3 bucket name
|
443
443
|
# s3_region - string - S3 region
|
444
444
|
# server_certificate - string - Remote server certificate
|
@@ -84,8 +84,8 @@ module Files
|
|
84
84
|
# List Requests
|
85
85
|
#
|
86
86
|
# Parameters:
|
87
|
-
# page -
|
88
|
-
# per_page -
|
87
|
+
# page - int64 - Current page number.
|
88
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
89
89
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
90
90
|
# mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
91
91
|
def folders(params = {})
|
@@ -110,8 +110,8 @@ module Files
|
|
110
110
|
end
|
111
111
|
|
112
112
|
# Parameters:
|
113
|
-
# page -
|
114
|
-
# per_page -
|
113
|
+
# page - int64 - Current page number.
|
114
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
115
115
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
116
116
|
# mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
117
117
|
# path - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
|
@@ -133,8 +133,8 @@ module Files
|
|
133
133
|
# List Requests
|
134
134
|
#
|
135
135
|
# Parameters:
|
136
|
-
# page -
|
137
|
-
# per_page -
|
136
|
+
# page - int64 - Current page number.
|
137
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
138
138
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
139
139
|
# mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
140
140
|
def self.folders(path, params = {}, options = {})
|
@@ -168,7 +168,7 @@ module Files
|
|
168
168
|
end
|
169
169
|
|
170
170
|
# Parameters:
|
171
|
-
# id (required) -
|
171
|
+
# id (required) - int64 - Request ID.
|
172
172
|
def self.delete(id, params = {}, options = {})
|
173
173
|
params ||= {}
|
174
174
|
params[:id] = id
|
@@ -44,11 +44,6 @@ module Files
|
|
44
44
|
@attributes[:allow_bundle_names]
|
45
45
|
end
|
46
46
|
|
47
|
-
# string - List of allowed file types
|
48
|
-
def allowed_file_types
|
49
|
-
@attributes[:allowed_file_types]
|
50
|
-
end
|
51
|
-
|
52
47
|
# string - List of allowed IP addresses
|
53
48
|
def allowed_ips
|
54
49
|
@attributes[:allowed_ips]
|
@@ -555,7 +550,7 @@ module Files
|
|
555
550
|
# domain - string - Custom domain
|
556
551
|
# email - string - Main email for this site
|
557
552
|
# allow_bundle_names - boolean - Are manual Bundle names allowed?
|
558
|
-
# bundle_expiration -
|
553
|
+
# bundle_expiration - int64 - Site-wide Bundle expiration in days
|
559
554
|
# overage_notify - boolean - Notify site email of overages?
|
560
555
|
# welcome_email_enabled - boolean - Will the welcome email be sent to new users?
|
561
556
|
# ask_about_overwrites - boolean - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
|
@@ -567,23 +562,22 @@ module Files
|
|
567
562
|
# default_time_zone - string - Site default time zone
|
568
563
|
# desktop_app - boolean - Is the desktop app enabled?
|
569
564
|
# desktop_app_session_ip_pinning - boolean - Is desktop app session IP pinning enabled?
|
570
|
-
# desktop_app_session_lifetime -
|
565
|
+
# desktop_app_session_lifetime - int64 - Desktop app session lifetime (in hours)
|
571
566
|
# folder_permissions_groups_only - boolean - If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
|
572
567
|
# welcome_screen - string - Does the welcome screen appear?
|
573
|
-
# session_expiry -
|
568
|
+
# session_expiry - double - Session expiry in hours
|
574
569
|
# ssl_required - boolean - Is SSL required? Disabling this is insecure.
|
575
570
|
# tls_disabled - boolean - Is TLS disabled(site setting)?
|
576
571
|
# user_lockout - boolean - Will users be locked out after incorrect login attempts?
|
577
|
-
# user_lockout_tries -
|
578
|
-
# user_lockout_within -
|
579
|
-
# user_lockout_lock_period -
|
572
|
+
# user_lockout_tries - int64 - Number of login tries within `user_lockout_within` hours before users are locked out
|
573
|
+
# user_lockout_within - int64 - Number of hours for user lockout window
|
574
|
+
# user_lockout_lock_period - int64 - How many hours to lock user out for failed password?
|
580
575
|
# include_password_in_welcome_email - boolean - Include password in emails to new users?
|
581
|
-
# allowed_file_types - string - List of allowed file types
|
582
576
|
# allowed_ips - string - List of allowed IP addresses
|
583
|
-
# days_to_retain_backups -
|
584
|
-
# max_prior_passwords -
|
585
|
-
# password_validity_days -
|
586
|
-
# password_min_length -
|
577
|
+
# days_to_retain_backups - int64 - Number of days to keep deleted files
|
578
|
+
# max_prior_passwords - int64 - Number of prior passwords to disallow
|
579
|
+
# password_validity_days - int64 - Number of days password is valid
|
580
|
+
# password_min_length - int64 - Shortest password length for users
|
587
581
|
# password_require_letter - boolean - Require a letter in passwords?
|
588
582
|
# password_require_mixed - boolean - Require lower and upper case letters in passwords?
|
589
583
|
# password_require_special - boolean - Require special characters in password?
|
@@ -598,7 +592,7 @@ module Files
|
|
598
592
|
# opt_out_global - boolean - Use servers in the USA only?
|
599
593
|
# use_provided_modified_at - boolean - Allow uploaders to set `provided_modified_at` for uploaded files?
|
600
594
|
# custom_namespace - boolean - Is this site using a custom namespace for users?
|
601
|
-
# disable_users_from_inactivity_period_days -
|
595
|
+
# disable_users_from_inactivity_period_days - int64 - If greater than zero, users will unable to login if they do not show activity within this number of days.
|
602
596
|
# allowed_2fa_method_sms - boolean - Is SMS two factor authentication allowed?
|
603
597
|
# allowed_2fa_method_u2f - boolean - Is U2F two factor authentication allowed?
|
604
598
|
# allowed_2fa_method_totp - boolean - Is TOTP two factor authentication allowed?
|
@@ -617,13 +611,13 @@ module Files
|
|
617
611
|
# smtp_authentication - string - SMTP server authentication type
|
618
612
|
# smtp_from - string - From address to use when mailing through custom SMTP
|
619
613
|
# smtp_username - string - SMTP server username
|
620
|
-
# smtp_port -
|
614
|
+
# smtp_port - int64 - SMTP server port
|
621
615
|
# ldap_enabled - boolean - Main LDAP setting: is LDAP enabled?
|
622
616
|
# ldap_type - string - LDAP type
|
623
617
|
# ldap_host - string - LDAP host
|
624
618
|
# ldap_host_2 - string - LDAP backup host
|
625
619
|
# ldap_host_3 - string - LDAP backup host
|
626
|
-
# ldap_port -
|
620
|
+
# ldap_port - int64 - LDAP port
|
627
621
|
# ldap_secure - boolean - Use secure LDAP?
|
628
622
|
# ldap_username - string - Username for signing in to LDAP server.
|
629
623
|
# ldap_username_field - string - LDAP username field
|
@@ -663,7 +657,6 @@ module Files
|
|
663
657
|
raise InvalidParameterError.new("Bad parameter: user_lockout_tries must be an Integer") if params.dig(:user_lockout_tries) and !params.dig(:user_lockout_tries).is_a?(Integer)
|
664
658
|
raise InvalidParameterError.new("Bad parameter: user_lockout_within must be an Integer") if params.dig(:user_lockout_within) and !params.dig(:user_lockout_within).is_a?(Integer)
|
665
659
|
raise InvalidParameterError.new("Bad parameter: user_lockout_lock_period must be an Integer") if params.dig(:user_lockout_lock_period) and !params.dig(:user_lockout_lock_period).is_a?(Integer)
|
666
|
-
raise InvalidParameterError.new("Bad parameter: allowed_file_types must be an String") if params.dig(:allowed_file_types) and !params.dig(:allowed_file_types).is_a?(String)
|
667
660
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params.dig(:allowed_ips) and !params.dig(:allowed_ips).is_a?(String)
|
668
661
|
raise InvalidParameterError.new("Bad parameter: days_to_retain_backups must be an Integer") if params.dig(:days_to_retain_backups) and !params.dig(:days_to_retain_backups).is_a?(Integer)
|
669
662
|
raise InvalidParameterError.new("Bad parameter: max_prior_passwords must be an Integer") if params.dig(:max_prior_passwords) and !params.dig(:max_prior_passwords).is_a?(Integer)
|
@@ -19,6 +19,16 @@ module Files
|
|
19
19
|
@attributes[:provider]
|
20
20
|
end
|
21
21
|
|
22
|
+
# string - Custom label for the SSO provider on the login page.
|
23
|
+
def label
|
24
|
+
@attributes[:label]
|
25
|
+
end
|
26
|
+
|
27
|
+
# string - URL holding a custom logo for the SSO provider on the login page.
|
28
|
+
def logo_url
|
29
|
+
@attributes[:logo_url]
|
30
|
+
end
|
31
|
+
|
22
32
|
# int64 - ID
|
23
33
|
def id
|
24
34
|
@attributes[:id]
|
@@ -120,8 +130,8 @@ module Files
|
|
120
130
|
end
|
121
131
|
|
122
132
|
# Parameters:
|
123
|
-
# page -
|
124
|
-
# per_page -
|
133
|
+
# page - int64 - Current page number.
|
134
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
125
135
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
126
136
|
def self.list(params = {}, options = {})
|
127
137
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -136,7 +146,7 @@ module Files
|
|
136
146
|
end
|
137
147
|
|
138
148
|
# Parameters:
|
139
|
-
# id (required) -
|
149
|
+
# id (required) - int64 - Sso Strategy ID.
|
140
150
|
def self.find(id, params = {}, options = {})
|
141
151
|
params ||= {}
|
142
152
|
params[:id] = id
|
@@ -30,8 +30,8 @@ module Files
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Parameters:
|
33
|
-
# page -
|
34
|
-
# per_page -
|
33
|
+
# page - int64 - Current page number.
|
34
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
35
35
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
36
36
|
def self.list(params = {}, options = {})
|
37
37
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -75,8 +75,8 @@ module Files
|
|
75
75
|
end
|
76
76
|
|
77
77
|
# Parameters:
|
78
|
-
# page -
|
79
|
-
# per_page -
|
78
|
+
# page - int64 - Current page number.
|
79
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
80
80
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
81
81
|
def self.list(params = {}, options = {})
|
82
82
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -513,7 +513,7 @@ module Files
|
|
513
513
|
# change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
514
514
|
# email - string - User's email.
|
515
515
|
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `preview`, or `history`.
|
516
|
-
# group_id -
|
516
|
+
# group_id - int64 - Group ID to associate this user with.
|
517
517
|
# group_ids - string - A list of group ids to associate this user with. Comma delimited.
|
518
518
|
# password - string - User password.
|
519
519
|
# password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
@@ -529,10 +529,10 @@ module Files
|
|
529
529
|
# 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.
|
530
530
|
# ftp_permission - boolean - Can the user access with FTP/FTPS?
|
531
531
|
# language - string - Preferred language
|
532
|
-
# notification_daily_send_time -
|
532
|
+
# notification_daily_send_time - int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
|
533
533
|
# name - string - User's full name
|
534
534
|
# notes - string - Any internal notes on the user
|
535
|
-
# password_validity_days -
|
535
|
+
# password_validity_days - int64 - Number of days to allow user to use the same password
|
536
536
|
# receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
|
537
537
|
# require_password_change - boolean - Is a password change required upon next user login?
|
538
538
|
# restapi_permission - boolean - Can this user access the REST API?
|
@@ -541,7 +541,7 @@ module Files
|
|
541
541
|
# site_admin - boolean - Is the user an administrator for this site?
|
542
542
|
# skip_welcome_screen - boolean - Skip Welcome page in the UI?
|
543
543
|
# ssl_required - string - SSL required setting
|
544
|
-
# sso_strategy_id -
|
544
|
+
# sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
|
545
545
|
# subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
|
546
546
|
# time_zone - string - User time zone
|
547
547
|
# 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.
|
@@ -601,8 +601,8 @@ module Files
|
|
601
601
|
end
|
602
602
|
|
603
603
|
# Parameters:
|
604
|
-
# page -
|
605
|
-
# per_page -
|
604
|
+
# page - int64 - Current page number.
|
605
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
606
606
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
607
607
|
# q[username] - string - List users matching username.
|
608
608
|
# q[email] - string - List users matching email.
|
@@ -626,7 +626,7 @@ module Files
|
|
626
626
|
end
|
627
627
|
|
628
628
|
# Parameters:
|
629
|
-
# id (required) -
|
629
|
+
# id (required) - int64 - User ID.
|
630
630
|
def self.find(id, params = {}, options = {})
|
631
631
|
params ||= {}
|
632
632
|
params[:id] = id
|
@@ -648,7 +648,7 @@ module Files
|
|
648
648
|
# change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
649
649
|
# email - string - User's email.
|
650
650
|
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `preview`, or `history`.
|
651
|
-
# group_id -
|
651
|
+
# group_id - int64 - Group ID to associate this user with.
|
652
652
|
# group_ids - string - A list of group ids to associate this user with. Comma delimited.
|
653
653
|
# password - string - User password.
|
654
654
|
# password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
@@ -664,10 +664,10 @@ module Files
|
|
664
664
|
# 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.
|
665
665
|
# ftp_permission - boolean - Can the user access with FTP/FTPS?
|
666
666
|
# language - string - Preferred language
|
667
|
-
# notification_daily_send_time -
|
667
|
+
# notification_daily_send_time - int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
|
668
668
|
# name - string - User's full name
|
669
669
|
# notes - string - Any internal notes on the user
|
670
|
-
# password_validity_days -
|
670
|
+
# password_validity_days - int64 - Number of days to allow user to use the same password
|
671
671
|
# receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
|
672
672
|
# require_password_change - boolean - Is a password change required upon next user login?
|
673
673
|
# restapi_permission - boolean - Can this user access the REST API?
|
@@ -676,7 +676,7 @@ module Files
|
|
676
676
|
# site_admin - boolean - Is the user an administrator for this site?
|
677
677
|
# skip_welcome_screen - boolean - Skip Welcome page in the UI?
|
678
678
|
# ssl_required - string - SSL required setting
|
679
|
-
# sso_strategy_id -
|
679
|
+
# sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
|
680
680
|
# subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
|
681
681
|
# time_zone - string - User time zone
|
682
682
|
# 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.
|
@@ -748,7 +748,7 @@ module Files
|
|
748
748
|
# change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
749
749
|
# email - string - User's email.
|
750
750
|
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `preview`, or `history`.
|
751
|
-
# group_id -
|
751
|
+
# group_id - int64 - Group ID to associate this user with.
|
752
752
|
# group_ids - string - A list of group ids to associate this user with. Comma delimited.
|
753
753
|
# password - string - User password.
|
754
754
|
# password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
@@ -764,10 +764,10 @@ module Files
|
|
764
764
|
# 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.
|
765
765
|
# ftp_permission - boolean - Can the user access with FTP/FTPS?
|
766
766
|
# language - string - Preferred language
|
767
|
-
# notification_daily_send_time -
|
767
|
+
# notification_daily_send_time - int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
|
768
768
|
# name - string - User's full name
|
769
769
|
# notes - string - Any internal notes on the user
|
770
|
-
# password_validity_days -
|
770
|
+
# password_validity_days - int64 - Number of days to allow user to use the same password
|
771
771
|
# receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
|
772
772
|
# require_password_change - boolean - Is a password change required upon next user login?
|
773
773
|
# restapi_permission - boolean - Can this user access the REST API?
|
@@ -776,7 +776,7 @@ module Files
|
|
776
776
|
# site_admin - boolean - Is the user an administrator for this site?
|
777
777
|
# skip_welcome_screen - boolean - Skip Welcome page in the UI?
|
778
778
|
# ssl_required - string - SSL required setting
|
779
|
-
# sso_strategy_id -
|
779
|
+
# sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
|
780
780
|
# subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
|
781
781
|
# time_zone - string - User time zone
|
782
782
|
# 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.
|