files.com 1.1.729 → 1.1.731
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/api_key.md +2 -2
- data/docs/group.md +8 -0
- data/docs/history_export.md +2 -2
- data/docs/history_export_result.md +1 -1
- data/docs/site.md +1 -0
- data/docs/user.md +8 -0
- data/lib/files.com/models/api_key.rb +2 -2
- data/lib/files.com/models/group.rb +12 -0
- data/lib/files.com/models/history_export.rb +2 -2
- data/lib/files.com/models/history_export_result.rb +1 -1
- data/lib/files.com/models/user.rb +12 -0
- data/lib/files.com/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3f40fa00c80dc832789f750ba194739c7486b2215ef83798c663830bca706368
|
|
4
|
+
data.tar.gz: 623a0815ae9862b17a5a9afe9f8fc26ad5f9693331e6f59c491e2e26ff8e16dd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5b1caf13b08e3aa20561131e036bf117862c2f6301cd5cd1e605b3f40cb1cb0ec86c58724746a0c5c62b3c9659b1640ed8d660de20fc0e234342b29943941cc6
|
|
7
|
+
data.tar.gz: 6118651915d6dbc4938c8fbcc6992bb1528f49b4b3df9ef62e5ad5853871ec60427918569f245138a8cdaeedffd5fc6e939ae5fad92b86962982e897cb4ed9ac
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.731
|
data/docs/api_key.md
CHANGED
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
* `url` (string): URL for API host.
|
|
44
44
|
* `user_id` (int64): User ID for the owner of this API Key. May be blank for Site-wide API Keys.
|
|
45
45
|
* `workspace_id` (int64): Workspace ID for this API Key. `0` means the default workspace.
|
|
46
|
-
* `path` (string):
|
|
46
|
+
* `path` (string): Restricts this API key to the specified folder and its descendants. Applies to every permission set and all paths accessed by a request, including copy and move destinations. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
---
|
|
@@ -115,7 +115,7 @@ Files::ApiKey.create(
|
|
|
115
115
|
* `expires_at` (string): API Key expiration date
|
|
116
116
|
* `name` (string): Required - Internal name for the API Key. For your use.
|
|
117
117
|
* `aws_style_credentials` (boolean): If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
|
|
118
|
-
* `path` (string):
|
|
118
|
+
* `path` (string): Restricts this API key to the specified folder and its descendants. Applies to every permission set and all paths accessed by a request, including copy and move destinations. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
|
|
119
119
|
* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
|
|
120
120
|
* `workspace_id` (int64): Workspace ID for this API Key. `0` means the default workspace.
|
|
121
121
|
|
data/docs/group.md
CHANGED
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
"sftp_permission": true,
|
|
17
17
|
"dav_permission": true,
|
|
18
18
|
"restapi_permission": true,
|
|
19
|
+
"s3_compatible_endpoint_permission": true,
|
|
19
20
|
"desktop_configuration_profile_id": 1,
|
|
20
21
|
"integration_centric_profile_id": 1,
|
|
21
22
|
"site_id": 1,
|
|
@@ -35,6 +36,7 @@
|
|
|
35
36
|
* `sftp_permission` (boolean): If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
36
37
|
* `dav_permission` (boolean): If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
37
38
|
* `restapi_permission` (boolean): If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
|
|
39
|
+
* `s3_compatible_endpoint_permission` (boolean): If true, users in this group can access the S3-compatible endpoint. This will override a false value of `s3_compatible_endpoint_permission` on the user level. Defaults to false.
|
|
38
40
|
* `desktop_configuration_profile_id` (int64): Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
39
41
|
* `integration_centric_profile_id` (int64): Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
40
42
|
* `site_id` (int64): Site ID
|
|
@@ -89,6 +91,7 @@ Files::Group.create(
|
|
|
89
91
|
sftp_permission: true,
|
|
90
92
|
dav_permission: true,
|
|
91
93
|
restapi_permission: true,
|
|
94
|
+
s3_compatible_endpoint_permission: true,
|
|
92
95
|
desktop_configuration_profile_id: 1,
|
|
93
96
|
integration_centric_profile_id: 1,
|
|
94
97
|
allowed_ips: "10.0.0.0/8\n127.0.0.1",
|
|
@@ -107,6 +110,7 @@ Files::Group.create(
|
|
|
107
110
|
* `sftp_permission` (boolean): If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
108
111
|
* `dav_permission` (boolean): If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
109
112
|
* `restapi_permission` (boolean): If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
|
|
113
|
+
* `s3_compatible_endpoint_permission` (boolean): If true, users in this group can access the S3-compatible endpoint. This will override a false value of `s3_compatible_endpoint_permission` on the user level. Defaults to false.
|
|
110
114
|
* `desktop_configuration_profile_id` (int64): Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
111
115
|
* `integration_centric_profile_id` (int64): Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
112
116
|
* `allowed_ips` (string): A list of allowed IPs if applicable. Newline delimited
|
|
@@ -128,6 +132,7 @@ Files::Group.update(id,
|
|
|
128
132
|
sftp_permission: true,
|
|
129
133
|
dav_permission: true,
|
|
130
134
|
restapi_permission: true,
|
|
135
|
+
s3_compatible_endpoint_permission: true,
|
|
131
136
|
desktop_configuration_profile_id: 1,
|
|
132
137
|
integration_centric_profile_id: 1,
|
|
133
138
|
allowed_ips: "10.0.0.0/8\n127.0.0.1",
|
|
@@ -146,6 +151,7 @@ Files::Group.update(id,
|
|
|
146
151
|
* `sftp_permission` (boolean): If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
147
152
|
* `dav_permission` (boolean): If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
148
153
|
* `restapi_permission` (boolean): If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
|
|
154
|
+
* `s3_compatible_endpoint_permission` (boolean): If true, users in this group can access the S3-compatible endpoint. This will override a false value of `s3_compatible_endpoint_permission` on the user level. Defaults to false.
|
|
149
155
|
* `desktop_configuration_profile_id` (int64): Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
150
156
|
* `integration_centric_profile_id` (int64): Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
151
157
|
* `allowed_ips` (string): A list of allowed IPs if applicable. Newline delimited
|
|
@@ -181,6 +187,7 @@ group.update(
|
|
|
181
187
|
sftp_permission: true,
|
|
182
188
|
dav_permission: true,
|
|
183
189
|
restapi_permission: true,
|
|
190
|
+
s3_compatible_endpoint_permission: true,
|
|
184
191
|
desktop_configuration_profile_id: 1,
|
|
185
192
|
integration_centric_profile_id: 1,
|
|
186
193
|
allowed_ips: "10.0.0.0/8\n127.0.0.1",
|
|
@@ -199,6 +206,7 @@ group.update(
|
|
|
199
206
|
* `sftp_permission` (boolean): If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
200
207
|
* `dav_permission` (boolean): If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
201
208
|
* `restapi_permission` (boolean): If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
|
|
209
|
+
* `s3_compatible_endpoint_permission` (boolean): If true, users in this group can access the S3-compatible endpoint. This will override a false value of `s3_compatible_endpoint_permission` on the user level. Defaults to false.
|
|
202
210
|
* `desktop_configuration_profile_id` (int64): Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
203
211
|
* `integration_centric_profile_id` (int64): Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
204
212
|
* `allowed_ips` (string): A list of allowed IPs if applicable. Newline delimited
|
data/docs/history_export.md
CHANGED
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
* `query_destination` (string): Return results that are file moves with paths matching this pattern as destination.
|
|
49
49
|
* `query_ip` (string): Filter results by this IP address.
|
|
50
50
|
* `query_username` (string): Filter results by this username.
|
|
51
|
-
* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
|
|
51
|
+
* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`, `no_s3_compatible_endpoint_permission`
|
|
52
52
|
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
|
|
53
53
|
* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
|
|
54
54
|
* `query_target_permission` (string): If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
|
|
@@ -120,7 +120,7 @@ Files::HistoryExport.create(
|
|
|
120
120
|
* `query_destination` (string): Return results that are file moves with paths matching this pattern as destination.
|
|
121
121
|
* `query_ip` (string): Filter results by this IP address.
|
|
122
122
|
* `query_username` (string): Filter results by this username.
|
|
123
|
-
* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
|
|
123
|
+
* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`, `no_s3_compatible_endpoint_permission`
|
|
124
124
|
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
|
|
125
125
|
* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
|
|
126
126
|
* `query_target_permission` (string): If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
* `username` (string): Username of the user that performed the action
|
|
48
48
|
* `user_is_from_parent_site` (boolean): true if this change was performed by a user on a parent site.
|
|
49
49
|
* `action` (string): What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
|
|
50
|
-
* `failure_type` (string): The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
|
|
50
|
+
* `failure_type` (string): The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`, `no_s3_compatible_endpoint_permission`
|
|
51
51
|
* `interface` (string): Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
|
|
52
52
|
* `target_id` (int64): ID of the object (such as Users, or API Keys) on which the action was taken
|
|
53
53
|
* `target_name` (string): Name of the User, Group or other object with a name related to this action
|
data/docs/site.md
CHANGED
data/docs/user.md
CHANGED
|
@@ -74,6 +74,7 @@
|
|
|
74
74
|
"responsible_user_id": 1,
|
|
75
75
|
"readonly_site_admin": true,
|
|
76
76
|
"restapi_permission": true,
|
|
77
|
+
"s3_compatible_endpoint_permission": true,
|
|
77
78
|
"self_managed": true,
|
|
78
79
|
"sftp_permission": true,
|
|
79
80
|
"site_admin": true,
|
|
@@ -165,6 +166,7 @@
|
|
|
165
166
|
* `responsible_user_id` (int64): ID of the internal User responsible for this Partner User, overriding the Partner default.
|
|
166
167
|
* `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
167
168
|
* `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.)
|
|
169
|
+
* `s3_compatible_endpoint_permission` (boolean): Can the user access the S3-compatible endpoint? Defaults to true.
|
|
168
170
|
* `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
|
|
169
171
|
* `sftp_permission` (boolean): Can the user access with SFTP?
|
|
170
172
|
* `site_admin` (boolean): Is the user an administrator for this site?
|
|
@@ -290,6 +292,7 @@ Files::User.create(
|
|
|
290
292
|
responsible_group_id: 1,
|
|
291
293
|
responsible_user_id: 1,
|
|
292
294
|
restapi_permission: true,
|
|
295
|
+
s3_compatible_endpoint_permission: true,
|
|
293
296
|
self_managed: true,
|
|
294
297
|
sftp_permission: true,
|
|
295
298
|
site_admin: true,
|
|
@@ -363,6 +366,7 @@ Files::User.create(
|
|
|
363
366
|
* `responsible_group_id` (int64): ID of the internal Group responsible for this Partner User, overriding the Partner default.
|
|
364
367
|
* `responsible_user_id` (int64): ID of the internal User responsible for this Partner User, overriding the Partner default.
|
|
365
368
|
* `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.)
|
|
369
|
+
* `s3_compatible_endpoint_permission` (boolean): Can the user access the S3-compatible endpoint? Defaults to true.
|
|
366
370
|
* `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
|
|
367
371
|
* `sftp_permission` (boolean): Can the user access with SFTP?
|
|
368
372
|
* `site_admin` (boolean): Is the user an administrator for this site?
|
|
@@ -471,6 +475,7 @@ Files::User.update(id,
|
|
|
471
475
|
responsible_group_id: 1,
|
|
472
476
|
responsible_user_id: 1,
|
|
473
477
|
restapi_permission: true,
|
|
478
|
+
s3_compatible_endpoint_permission: true,
|
|
474
479
|
self_managed: true,
|
|
475
480
|
sftp_permission: true,
|
|
476
481
|
site_admin: true,
|
|
@@ -547,6 +552,7 @@ Files::User.update(id,
|
|
|
547
552
|
* `responsible_group_id` (int64): ID of the internal Group responsible for this Partner User, overriding the Partner default.
|
|
548
553
|
* `responsible_user_id` (int64): ID of the internal User responsible for this Partner User, overriding the Partner default.
|
|
549
554
|
* `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.)
|
|
555
|
+
* `s3_compatible_endpoint_permission` (boolean): Can the user access the S3-compatible endpoint? Defaults to true.
|
|
550
556
|
* `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
|
|
551
557
|
* `sftp_permission` (boolean): Can the user access with SFTP?
|
|
552
558
|
* `site_admin` (boolean): Is the user an administrator for this site?
|
|
@@ -681,6 +687,7 @@ user.update(
|
|
|
681
687
|
responsible_group_id: 1,
|
|
682
688
|
responsible_user_id: 1,
|
|
683
689
|
restapi_permission: true,
|
|
690
|
+
s3_compatible_endpoint_permission: true,
|
|
684
691
|
self_managed: true,
|
|
685
692
|
sftp_permission: true,
|
|
686
693
|
site_admin: true,
|
|
@@ -757,6 +764,7 @@ user.update(
|
|
|
757
764
|
* `responsible_group_id` (int64): ID of the internal Group responsible for this Partner User, overriding the Partner default.
|
|
758
765
|
* `responsible_user_id` (int64): ID of the internal User responsible for this Partner User, overriding the Partner default.
|
|
759
766
|
* `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.)
|
|
767
|
+
* `s3_compatible_endpoint_permission` (boolean): Can the user access the S3-compatible endpoint? Defaults to true.
|
|
760
768
|
* `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
|
|
761
769
|
* `sftp_permission` (boolean): Can the user access with SFTP?
|
|
762
770
|
* `site_admin` (boolean): Is the user an administrator for this site?
|
|
@@ -167,7 +167,7 @@ module Files
|
|
|
167
167
|
@attributes[:workspace_id] = value
|
|
168
168
|
end
|
|
169
169
|
|
|
170
|
-
# string -
|
|
170
|
+
# string - Restricts this API key to the specified folder and its descendants. Applies to every permission set and all paths accessed by a request, including copy and move destinations. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
|
|
171
171
|
def path
|
|
172
172
|
@attributes[:path]
|
|
173
173
|
end
|
|
@@ -276,7 +276,7 @@ module Files
|
|
|
276
276
|
# expires_at - string - API Key expiration date
|
|
277
277
|
# name (required) - string - Internal name for the API Key. For your use.
|
|
278
278
|
# aws_style_credentials - boolean - If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
|
|
279
|
-
# path - string -
|
|
279
|
+
# path - string - Restricts this API key to the specified folder and its descendants. Applies to every permission set and all paths accessed by a request, including copy and move destinations. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
|
|
280
280
|
# permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
|
|
281
281
|
# workspace_id - int64 - Workspace ID for this API Key. `0` means the default workspace.
|
|
282
282
|
def self.create(params = {}, options = {})
|
|
@@ -117,6 +117,15 @@ module Files
|
|
|
117
117
|
@attributes[:restapi_permission] = value
|
|
118
118
|
end
|
|
119
119
|
|
|
120
|
+
# boolean - If true, users in this group can access the S3-compatible endpoint. This will override a false value of `s3_compatible_endpoint_permission` on the user level. Defaults to false.
|
|
121
|
+
def s3_compatible_endpoint_permission
|
|
122
|
+
@attributes[:s3_compatible_endpoint_permission]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def s3_compatible_endpoint_permission=(value)
|
|
126
|
+
@attributes[:s3_compatible_endpoint_permission] = value
|
|
127
|
+
end
|
|
128
|
+
|
|
120
129
|
# int64 - Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
121
130
|
def desktop_configuration_profile_id
|
|
122
131
|
@attributes[:desktop_configuration_profile_id]
|
|
@@ -162,6 +171,7 @@ module Files
|
|
|
162
171
|
# sftp_permission - boolean - If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
163
172
|
# dav_permission - boolean - If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
164
173
|
# restapi_permission - boolean - If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
|
|
174
|
+
# s3_compatible_endpoint_permission - boolean - If true, users in this group can access the S3-compatible endpoint. This will override a false value of `s3_compatible_endpoint_permission` on the user level. Defaults to false.
|
|
165
175
|
# desktop_configuration_profile_id - int64 - Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
166
176
|
# integration_centric_profile_id - int64 - Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
167
177
|
# allowed_ips - string - A list of allowed IPs if applicable. Newline delimited
|
|
@@ -260,6 +270,7 @@ module Files
|
|
|
260
270
|
# sftp_permission - boolean - If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
261
271
|
# dav_permission - boolean - If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
262
272
|
# restapi_permission - boolean - If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
|
|
273
|
+
# s3_compatible_endpoint_permission - boolean - If true, users in this group can access the S3-compatible endpoint. This will override a false value of `s3_compatible_endpoint_permission` on the user level. Defaults to false.
|
|
263
274
|
# desktop_configuration_profile_id - int64 - Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
264
275
|
# integration_centric_profile_id - int64 - Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
265
276
|
# allowed_ips - string - A list of allowed IPs if applicable. Newline delimited
|
|
@@ -290,6 +301,7 @@ module Files
|
|
|
290
301
|
# sftp_permission - boolean - If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
291
302
|
# dav_permission - boolean - If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
292
303
|
# restapi_permission - boolean - If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
|
|
304
|
+
# s3_compatible_endpoint_permission - boolean - If true, users in this group can access the S3-compatible endpoint. This will override a false value of `s3_compatible_endpoint_permission` on the user level. Defaults to false.
|
|
293
305
|
# desktop_configuration_profile_id - int64 - Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
294
306
|
# integration_centric_profile_id - int64 - Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
|
|
295
307
|
# allowed_ips - string - A list of allowed IPs if applicable. Newline delimited
|
|
@@ -153,7 +153,7 @@ module Files
|
|
|
153
153
|
@attributes[:query_username] = value
|
|
154
154
|
end
|
|
155
155
|
|
|
156
|
-
# string - If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
|
|
156
|
+
# string - If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`, `no_s3_compatible_endpoint_permission`
|
|
157
157
|
def query_failure_type
|
|
158
158
|
@attributes[:query_failure_type]
|
|
159
159
|
end
|
|
@@ -285,7 +285,7 @@ module Files
|
|
|
285
285
|
# query_destination - string - Return results that are file moves with paths matching this pattern as destination.
|
|
286
286
|
# query_ip - string - Filter results by this IP address.
|
|
287
287
|
# query_username - string - Filter results by this username.
|
|
288
|
-
# query_failure_type - string - If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
|
|
288
|
+
# query_failure_type - string - If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`, `no_s3_compatible_endpoint_permission`
|
|
289
289
|
# query_target_id - string - If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
|
|
290
290
|
# query_target_name - string - If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
|
|
291
291
|
# query_target_permission - string - If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
|
|
@@ -79,7 +79,7 @@ module Files
|
|
|
79
79
|
@attributes[:action]
|
|
80
80
|
end
|
|
81
81
|
|
|
82
|
-
# string - The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
|
|
82
|
+
# string - The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`, `no_s3_compatible_endpoint_permission`
|
|
83
83
|
def failure_type
|
|
84
84
|
@attributes[:failure_type]
|
|
85
85
|
end
|
|
@@ -617,6 +617,15 @@ module Files
|
|
|
617
617
|
@attributes[:restapi_permission] = value
|
|
618
618
|
end
|
|
619
619
|
|
|
620
|
+
# boolean - Can the user access the S3-compatible endpoint? Defaults to true.
|
|
621
|
+
def s3_compatible_endpoint_permission
|
|
622
|
+
@attributes[:s3_compatible_endpoint_permission]
|
|
623
|
+
end
|
|
624
|
+
|
|
625
|
+
def s3_compatible_endpoint_permission=(value)
|
|
626
|
+
@attributes[:s3_compatible_endpoint_permission] = value
|
|
627
|
+
end
|
|
628
|
+
|
|
620
629
|
# boolean - Does this user manage it's own credentials or is it a shared/bot user?
|
|
621
630
|
def self_managed
|
|
622
631
|
@attributes[:self_managed]
|
|
@@ -992,6 +1001,7 @@ module Files
|
|
|
992
1001
|
# responsible_group_id - int64 - ID of the internal Group responsible for this Partner User, overriding the Partner default.
|
|
993
1002
|
# responsible_user_id - int64 - ID of the internal User responsible for this Partner User, overriding the Partner default.
|
|
994
1003
|
# 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.)
|
|
1004
|
+
# s3_compatible_endpoint_permission - boolean - Can the user access the S3-compatible endpoint? Defaults to true.
|
|
995
1005
|
# self_managed - boolean - Does this user manage it's own credentials or is it a shared/bot user?
|
|
996
1006
|
# sftp_permission - boolean - Can the user access with SFTP?
|
|
997
1007
|
# site_admin - boolean - Is the user an administrator for this site?
|
|
@@ -1191,6 +1201,7 @@ module Files
|
|
|
1191
1201
|
# responsible_group_id - int64 - ID of the internal Group responsible for this Partner User, overriding the Partner default.
|
|
1192
1202
|
# responsible_user_id - int64 - ID of the internal User responsible for this Partner User, overriding the Partner default.
|
|
1193
1203
|
# 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.)
|
|
1204
|
+
# s3_compatible_endpoint_permission - boolean - Can the user access the S3-compatible endpoint? Defaults to true.
|
|
1194
1205
|
# self_managed - boolean - Does this user manage it's own credentials or is it a shared/bot user?
|
|
1195
1206
|
# sftp_permission - boolean - Can the user access with SFTP?
|
|
1196
1207
|
# site_admin - boolean - Is the user an administrator for this site?
|
|
@@ -1338,6 +1349,7 @@ module Files
|
|
|
1338
1349
|
# responsible_group_id - int64 - ID of the internal Group responsible for this Partner User, overriding the Partner default.
|
|
1339
1350
|
# responsible_user_id - int64 - ID of the internal User responsible for this Partner User, overriding the Partner default.
|
|
1340
1351
|
# 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.)
|
|
1352
|
+
# s3_compatible_endpoint_permission - boolean - Can the user access the S3-compatible endpoint? Defaults to true.
|
|
1341
1353
|
# self_managed - boolean - Does this user manage it's own credentials or is it a shared/bot user?
|
|
1342
1354
|
# sftp_permission - boolean - Can the user access with SFTP?
|
|
1343
1355
|
# site_admin - boolean - Is the user an administrator for this site?
|
data/lib/files.com/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: files.com
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.1.
|
|
4
|
+
version: 1.1.731
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- files.com
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-09-
|
|
11
|
+
date: 2026-09-18 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|