files.com 1.0.56 → 1.0.61
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/api_key.md +4 -2
- data/docs/as2_key.md +4 -2
- data/docs/automation.md +4 -2
- data/docs/behavior.md +4 -2
- data/docs/bundle.md +9 -6
- data/docs/file.md +6 -3
- data/docs/file_action.md +6 -3
- data/docs/file_comment.md +4 -2
- data/docs/file_comment_reaction.md +2 -1
- data/docs/group.md +4 -2
- data/docs/group_user.md +4 -2
- data/docs/history_export.md +2 -1
- data/docs/lock.md +2 -1
- data/docs/message.md +4 -2
- data/docs/message_comment.md +4 -2
- data/docs/message_comment_reaction.md +2 -1
- data/docs/message_reaction.md +2 -1
- data/docs/notification.md +4 -2
- data/docs/project.md +4 -2
- data/docs/public_key.md +4 -2
- data/docs/remote_server.md +12 -2
- data/docs/request.md +2 -1
- data/docs/site.md +2 -2
- data/docs/sso_strategy.md +27 -1
- data/docs/style.md +4 -2
- data/docs/user.md +10 -5
- 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 +9 -9
- 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 +24 -9
- data/lib/files.com/models/request.rb +7 -7
- data/lib/files.com/models/site.rb +13 -13
- data/lib/files.com/models/sso_strategy.rb +68 -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
@@ -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 = {})
|
@@ -90,6 +90,15 @@ module Files
|
|
90
90
|
@attributes[:server_certificate] = value
|
91
91
|
end
|
92
92
|
|
93
|
+
# string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
|
94
|
+
def server_host_key
|
95
|
+
@attributes[:server_host_key]
|
96
|
+
end
|
97
|
+
|
98
|
+
def server_host_key=(value)
|
99
|
+
@attributes[:server_host_key] = value
|
100
|
+
end
|
101
|
+
|
93
102
|
# string - Remote server type.
|
94
103
|
def server_type
|
95
104
|
@attributes[:server_type]
|
@@ -264,11 +273,12 @@ module Files
|
|
264
273
|
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
|
265
274
|
# hostname - string - Hostname or IP address
|
266
275
|
# name - string - Internal name for your reference
|
267
|
-
# max_connections -
|
268
|
-
# port -
|
276
|
+
# max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
|
277
|
+
# port - int64 - Port for remote server. Not needed for S3.
|
269
278
|
# s3_bucket - string - S3 bucket name
|
270
279
|
# s3_region - string - S3 region
|
271
280
|
# server_certificate - string - Remote server certificate
|
281
|
+
# server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
|
272
282
|
# server_type - string - Remote server type.
|
273
283
|
# ssl - string - Should we require SSL?
|
274
284
|
# username - string - Remote server username. Not needed for S3 buckets.
|
@@ -299,6 +309,7 @@ module Files
|
|
299
309
|
raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params.dig(:s3_bucket) and !params.dig(:s3_bucket).is_a?(String)
|
300
310
|
raise InvalidParameterError.new("Bad parameter: s3_region must be an String") if params.dig(:s3_region) and !params.dig(:s3_region).is_a?(String)
|
301
311
|
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params.dig(:server_certificate) and !params.dig(:server_certificate).is_a?(String)
|
312
|
+
raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params.dig(:server_host_key) and !params.dig(:server_host_key).is_a?(String)
|
302
313
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params.dig(:server_type) and !params.dig(:server_type).is_a?(String)
|
303
314
|
raise InvalidParameterError.new("Bad parameter: ssl must be an String") if params.dig(:ssl) and !params.dig(:ssl).is_a?(String)
|
304
315
|
raise InvalidParameterError.new("Bad parameter: username must be an String") if params.dig(:username) and !params.dig(:username).is_a?(String)
|
@@ -337,8 +348,8 @@ module Files
|
|
337
348
|
end
|
338
349
|
|
339
350
|
# Parameters:
|
340
|
-
# page -
|
341
|
-
# per_page -
|
351
|
+
# page - int64 - Current page number.
|
352
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
342
353
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
343
354
|
def self.list(params = {}, options = {})
|
344
355
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -353,7 +364,7 @@ module Files
|
|
353
364
|
end
|
354
365
|
|
355
366
|
# Parameters:
|
356
|
-
# id (required) -
|
367
|
+
# id (required) - int64 - Remote Server ID.
|
357
368
|
def self.find(id, params = {}, options = {})
|
358
369
|
params ||= {}
|
359
370
|
params[:id] = id
|
@@ -380,11 +391,12 @@ module Files
|
|
380
391
|
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
|
381
392
|
# hostname - string - Hostname or IP address
|
382
393
|
# name - string - Internal name for your reference
|
383
|
-
# max_connections -
|
384
|
-
# port -
|
394
|
+
# max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
|
395
|
+
# port - int64 - Port for remote server. Not needed for S3.
|
385
396
|
# s3_bucket - string - S3 bucket name
|
386
397
|
# s3_region - string - S3 region
|
387
398
|
# server_certificate - string - Remote server certificate
|
399
|
+
# server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
|
388
400
|
# server_type - string - Remote server type.
|
389
401
|
# ssl - string - Should we require SSL?
|
390
402
|
# username - string - Remote server username. Not needed for S3 buckets.
|
@@ -411,6 +423,7 @@ module Files
|
|
411
423
|
raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params.dig(:s3_bucket) and !params.dig(:s3_bucket).is_a?(String)
|
412
424
|
raise InvalidParameterError.new("Bad parameter: s3_region must be an String") if params.dig(:s3_region) and !params.dig(:s3_region).is_a?(String)
|
413
425
|
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params.dig(:server_certificate) and !params.dig(:server_certificate).is_a?(String)
|
426
|
+
raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params.dig(:server_host_key) and !params.dig(:server_host_key).is_a?(String)
|
414
427
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params.dig(:server_type) and !params.dig(:server_type).is_a?(String)
|
415
428
|
raise InvalidParameterError.new("Bad parameter: ssl must be an String") if params.dig(:ssl) and !params.dig(:ssl).is_a?(String)
|
416
429
|
raise InvalidParameterError.new("Bad parameter: username must be an String") if params.dig(:username) and !params.dig(:username).is_a?(String)
|
@@ -437,11 +450,12 @@ module Files
|
|
437
450
|
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
|
438
451
|
# hostname - string - Hostname or IP address
|
439
452
|
# name - string - Internal name for your reference
|
440
|
-
# max_connections -
|
441
|
-
# port -
|
453
|
+
# max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
|
454
|
+
# port - int64 - Port for remote server. Not needed for S3.
|
442
455
|
# s3_bucket - string - S3 bucket name
|
443
456
|
# s3_region - string - S3 region
|
444
457
|
# server_certificate - string - Remote server certificate
|
458
|
+
# server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
|
445
459
|
# server_type - string - Remote server type.
|
446
460
|
# ssl - string - Should we require SSL?
|
447
461
|
# username - string - Remote server username. Not needed for S3 buckets.
|
@@ -471,6 +485,7 @@ module Files
|
|
471
485
|
raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params.dig(:s3_bucket) and !params.dig(:s3_bucket).is_a?(String)
|
472
486
|
raise InvalidParameterError.new("Bad parameter: s3_region must be an String") if params.dig(:s3_region) and !params.dig(:s3_region).is_a?(String)
|
473
487
|
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params.dig(:server_certificate) and !params.dig(:server_certificate).is_a?(String)
|
488
|
+
raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params.dig(:server_host_key) and !params.dig(:server_host_key).is_a?(String)
|
474
489
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params.dig(:server_type) and !params.dig(:server_type).is_a?(String)
|
475
490
|
raise InvalidParameterError.new("Bad parameter: ssl must be an String") if params.dig(:ssl) and !params.dig(:ssl).is_a?(String)
|
476
491
|
raise InvalidParameterError.new("Bad parameter: username must be an String") if params.dig(:username) and !params.dig(:username).is_a?(String)
|
@@ -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
|
@@ -550,7 +550,7 @@ module Files
|
|
550
550
|
# domain - string - Custom domain
|
551
551
|
# email - string - Main email for this site
|
552
552
|
# allow_bundle_names - boolean - Are manual Bundle names allowed?
|
553
|
-
# bundle_expiration -
|
553
|
+
# bundle_expiration - int64 - Site-wide Bundle expiration in days
|
554
554
|
# overage_notify - boolean - Notify site email of overages?
|
555
555
|
# welcome_email_enabled - boolean - Will the welcome email be sent to new users?
|
556
556
|
# ask_about_overwrites - boolean - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
|
@@ -562,22 +562,22 @@ module Files
|
|
562
562
|
# default_time_zone - string - Site default time zone
|
563
563
|
# desktop_app - boolean - Is the desktop app enabled?
|
564
564
|
# desktop_app_session_ip_pinning - boolean - Is desktop app session IP pinning enabled?
|
565
|
-
# desktop_app_session_lifetime -
|
565
|
+
# desktop_app_session_lifetime - int64 - Desktop app session lifetime (in hours)
|
566
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.
|
567
567
|
# welcome_screen - string - Does the welcome screen appear?
|
568
|
-
# session_expiry -
|
568
|
+
# session_expiry - double - Session expiry in hours
|
569
569
|
# ssl_required - boolean - Is SSL required? Disabling this is insecure.
|
570
570
|
# tls_disabled - boolean - Is TLS disabled(site setting)?
|
571
571
|
# user_lockout - boolean - Will users be locked out after incorrect login attempts?
|
572
|
-
# user_lockout_tries -
|
573
|
-
# user_lockout_within -
|
574
|
-
# 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?
|
575
575
|
# include_password_in_welcome_email - boolean - Include password in emails to new users?
|
576
576
|
# allowed_ips - string - List of allowed IP addresses
|
577
|
-
# days_to_retain_backups -
|
578
|
-
# max_prior_passwords -
|
579
|
-
# password_validity_days -
|
580
|
-
# 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
|
581
581
|
# password_require_letter - boolean - Require a letter in passwords?
|
582
582
|
# password_require_mixed - boolean - Require lower and upper case letters in passwords?
|
583
583
|
# password_require_special - boolean - Require special characters in password?
|
@@ -592,7 +592,7 @@ module Files
|
|
592
592
|
# opt_out_global - boolean - Use servers in the USA only?
|
593
593
|
# use_provided_modified_at - boolean - Allow uploaders to set `provided_modified_at` for uploaded files?
|
594
594
|
# custom_namespace - boolean - Is this site using a custom namespace for users?
|
595
|
-
# 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.
|
596
596
|
# allowed_2fa_method_sms - boolean - Is SMS two factor authentication allowed?
|
597
597
|
# allowed_2fa_method_u2f - boolean - Is U2F two factor authentication allowed?
|
598
598
|
# allowed_2fa_method_totp - boolean - Is TOTP two factor authentication allowed?
|
@@ -611,13 +611,13 @@ module Files
|
|
611
611
|
# smtp_authentication - string - SMTP server authentication type
|
612
612
|
# smtp_from - string - From address to use when mailing through custom SMTP
|
613
613
|
# smtp_username - string - SMTP server username
|
614
|
-
# smtp_port -
|
614
|
+
# smtp_port - int64 - SMTP server port
|
615
615
|
# ldap_enabled - boolean - Main LDAP setting: is LDAP enabled?
|
616
616
|
# ldap_type - string - LDAP type
|
617
617
|
# ldap_host - string - LDAP host
|
618
618
|
# ldap_host_2 - string - LDAP backup host
|
619
619
|
# ldap_host_3 - string - LDAP backup host
|
620
|
-
# ldap_port -
|
620
|
+
# ldap_port - int64 - LDAP port
|
621
621
|
# ldap_secure - boolean - Use secure LDAP?
|
622
622
|
# ldap_username - string - Username for signing in to LDAP server.
|
623
623
|
# ldap_username_field - string - LDAP username field
|
@@ -119,6 +119,11 @@ module Files
|
|
119
119
|
@attributes[:provision_ftp_permission]
|
120
120
|
end
|
121
121
|
|
122
|
+
# string - Should we sync groups from this strategy?
|
123
|
+
def provision_group_action
|
124
|
+
@attributes[:provision_group_action]
|
125
|
+
end
|
126
|
+
|
122
127
|
# boolean - Auto-provisioned users get SFTP permission?
|
123
128
|
def provision_sftp_permission
|
124
129
|
@attributes[:provision_sftp_permission]
|
@@ -129,9 +134,69 @@ module Files
|
|
129
134
|
@attributes[:provision_time_zone]
|
130
135
|
end
|
131
136
|
|
137
|
+
# string - Should we sync users from this strategy?
|
138
|
+
def provision_user_action
|
139
|
+
@attributes[:provision_user_action]
|
140
|
+
end
|
141
|
+
|
142
|
+
# string - Base DN for looking up users in LDAP server
|
143
|
+
def ldap_base_dn
|
144
|
+
@attributes[:ldap_base_dn]
|
145
|
+
end
|
146
|
+
|
147
|
+
# string - Domain name that will be appended to LDAP usernames
|
148
|
+
def ldap_domain
|
149
|
+
@attributes[:ldap_domain]
|
150
|
+
end
|
151
|
+
|
152
|
+
# boolean - Is strategy enabled?
|
153
|
+
def enabled
|
154
|
+
@attributes[:enabled]
|
155
|
+
end
|
156
|
+
|
157
|
+
# string - LDAP host
|
158
|
+
def ldap_host
|
159
|
+
@attributes[:ldap_host]
|
160
|
+
end
|
161
|
+
|
162
|
+
# string - LDAP backup host
|
163
|
+
def ldap_host_2
|
164
|
+
@attributes[:ldap_host_2]
|
165
|
+
end
|
166
|
+
|
167
|
+
# string - LDAP backup host
|
168
|
+
def ldap_host_3
|
169
|
+
@attributes[:ldap_host_3]
|
170
|
+
end
|
171
|
+
|
172
|
+
# int64 - LDAP port
|
173
|
+
def ldap_port
|
174
|
+
@attributes[:ldap_port]
|
175
|
+
end
|
176
|
+
|
177
|
+
# boolean - Use secure LDAP?
|
178
|
+
def ldap_secure
|
179
|
+
@attributes[:ldap_secure]
|
180
|
+
end
|
181
|
+
|
182
|
+
# string - Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
|
183
|
+
def ldap_user_include_groups
|
184
|
+
@attributes[:ldap_user_include_groups]
|
185
|
+
end
|
186
|
+
|
187
|
+
# string - Username for signing in to LDAP server.
|
188
|
+
def ldap_username
|
189
|
+
@attributes[:ldap_username]
|
190
|
+
end
|
191
|
+
|
192
|
+
# string - LDAP username field
|
193
|
+
def ldap_username_field
|
194
|
+
@attributes[:ldap_username_field]
|
195
|
+
end
|
196
|
+
|
132
197
|
# Parameters:
|
133
|
-
# page -
|
134
|
-
# per_page -
|
198
|
+
# page - int64 - Current page number.
|
199
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
135
200
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
136
201
|
def self.list(params = {}, options = {})
|
137
202
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -146,7 +211,7 @@ module Files
|
|
146
211
|
end
|
147
212
|
|
148
213
|
# Parameters:
|
149
|
-
# id (required) -
|
214
|
+
# id (required) - int64 - Sso Strategy ID.
|
150
215
|
def self.find(id, params = {}, options = {})
|
151
216
|
params ||= {}
|
152
217
|
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.
|