files.com 1.0.101 → 1.0.106
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 +18 -2
- data/docs/as2_key.md +1 -0
- data/docs/bandwidth_snapshot.md +8 -0
- data/docs/bundle_download.md +1 -0
- data/docs/bundle_recipient.md +1 -0
- data/docs/clickwrap.md +1 -0
- data/docs/dns_record.md +1 -0
- data/docs/external_event.md +43 -0
- data/docs/file.md +2 -2
- data/docs/file_comment.md +1 -0
- data/docs/file_part_upload.md +2 -0
- data/docs/folder.md +2 -2
- data/docs/group_user.md +1 -0
- data/docs/history_export.md +23 -69
- data/docs/history_export_result.md +79 -0
- data/docs/invoice.md +1 -0
- data/docs/ip_address.md +2 -0
- data/docs/lock.md +1 -0
- data/docs/message.md +1 -0
- data/docs/message_comment.md +1 -0
- data/docs/message_comment_reaction.md +1 -0
- data/docs/message_reaction.md +1 -0
- data/docs/payment.md +1 -0
- data/docs/project.md +1 -0
- data/docs/public_key.md +1 -0
- data/docs/remote_server.md +1 -0
- data/docs/session.md +10 -2
- data/docs/site.md +18 -2
- data/docs/sso_strategy.md +3 -0
- data/docs/usage_snapshot.md +1 -0
- data/docs/user_cipher_use.md +1 -0
- data/docs/user_request.md +3 -0
- data/lib/files.com.rb +2 -0
- data/lib/files.com/api_client.rb +2 -1
- data/lib/files.com/models/api_key.rb +12 -0
- data/lib/files.com/models/as2_key.rb +4 -3
- data/lib/files.com/models/bandwidth_snapshot.rb +18 -3
- data/lib/files.com/models/bundle_download.rb +4 -3
- data/lib/files.com/models/bundle_recipient.rb +4 -3
- data/lib/files.com/models/clickwrap.rb +4 -3
- data/lib/files.com/models/dns_record.rb +4 -3
- data/lib/files.com/models/external_event.rb +66 -0
- data/lib/files.com/models/file.rb +6 -6
- data/lib/files.com/models/file_comment.rb +4 -3
- data/lib/files.com/models/file_part_upload.rb +5 -0
- data/lib/files.com/models/folder.rb +3 -3
- data/lib/files.com/models/group_user.rb +4 -3
- data/lib/files.com/models/history_export.rb +24 -64
- data/lib/files.com/models/history_export_result.rb +152 -0
- data/lib/files.com/models/invoice.rb +4 -3
- data/lib/files.com/models/ip_address.rb +8 -6
- data/lib/files.com/models/lock.rb +4 -3
- data/lib/files.com/models/message.rb +4 -3
- data/lib/files.com/models/message_comment.rb +4 -3
- data/lib/files.com/models/message_comment_reaction.rb +4 -3
- data/lib/files.com/models/message_reaction.rb +4 -3
- data/lib/files.com/models/payment.rb +4 -3
- data/lib/files.com/models/project.rb +4 -3
- data/lib/files.com/models/public_key.rb +4 -3
- data/lib/files.com/models/remote_server.rb +4 -3
- data/lib/files.com/models/session.rb +6 -0
- data/lib/files.com/models/site.rb +12 -0
- data/lib/files.com/models/sso_strategy.rb +9 -3
- data/lib/files.com/models/usage_snapshot.rb +4 -3
- data/lib/files.com/models/user_cipher_use.rb +4 -3
- data/lib/files.com/models/user_request.rb +13 -3
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 32131f5bd3bf8f5002f21ab2ad489b1ccf93bc1fcb7c42427ea5c18f83af9977
|
4
|
+
data.tar.gz: 797cf35c63d959a478f124ff84d5f3cdef1d1c1a0d1098cc2d201cc8950ec1c8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0b0ec308bc1cfd10683b7fd92796eb4bc686de078b364dcb819f2531b9850b120a2721da2e49e97949b424c2648b131f83195358e404ff98bb814594193bca4f
|
7
|
+
data.tar.gz: 4c57b09e30babaeeada3e8d08f9904dbcf17b4fe22ed9be57285e8f7cde9d2142e551b61c87f9feb955269c144989eac1d16660919ea95b47dacbba639f681ff
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.106
|
data/docs/api_key.md
CHANGED
@@ -64,9 +64,17 @@ Files::ApiKey.list(
|
|
64
64
|
## Show information about current API key. (Requires current API connection to be using an API key.)
|
65
65
|
|
66
66
|
```
|
67
|
-
Files::ApiKey.find_current
|
67
|
+
Files::ApiKey.find_current(
|
68
|
+
format: "",
|
69
|
+
api_key: ""
|
70
|
+
)
|
68
71
|
```
|
69
72
|
|
73
|
+
### Parameters
|
74
|
+
|
75
|
+
* `format` (string):
|
76
|
+
* `api_key` (object):
|
77
|
+
|
70
78
|
|
71
79
|
---
|
72
80
|
|
@@ -148,9 +156,17 @@ Files::ApiKey.update(id,
|
|
148
156
|
## Delete current API key. (Requires current API connection to be using an API key.)
|
149
157
|
|
150
158
|
```
|
151
|
-
Files::ApiKey.delete_current
|
159
|
+
Files::ApiKey.delete_current(
|
160
|
+
format: "",
|
161
|
+
api_key: ""
|
162
|
+
)
|
152
163
|
```
|
153
164
|
|
165
|
+
### Parameters
|
166
|
+
|
167
|
+
* `format` (string):
|
168
|
+
* `api_key` (object):
|
169
|
+
|
154
170
|
|
155
171
|
---
|
156
172
|
|
data/docs/as2_key.md
CHANGED
@@ -37,6 +37,7 @@ Files::As2Key.list(
|
|
37
37
|
* `page` (int64): Current page number.
|
38
38
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
39
39
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
40
|
+
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
40
41
|
|
41
42
|
|
42
43
|
---
|
data/docs/bandwidth_snapshot.md
CHANGED
@@ -43,3 +43,11 @@ Files::BandwidthSnapshot.list(
|
|
43
43
|
* `page` (int64): Current page number.
|
44
44
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
45
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
46
|
+
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
47
|
+
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `logged_at`.
|
48
|
+
* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
|
49
|
+
* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.
|
50
|
+
* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `logged_at`.
|
51
|
+
* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
|
52
|
+
* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `logged_at`.
|
53
|
+
* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `logged_at`.
|
data/docs/bundle_download.md
CHANGED
@@ -32,4 +32,5 @@ Files::BundleDownload.list(
|
|
32
32
|
* `page` (int64): Current page number.
|
33
33
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
34
34
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
35
|
+
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
35
36
|
* `bundle_registration_id` (int64): Required - BundleRegistration ID
|
data/docs/bundle_recipient.md
CHANGED
@@ -38,4 +38,5 @@ Files::BundleRecipient.list(
|
|
38
38
|
* `page` (int64): Current page number.
|
39
39
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
40
40
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
41
|
+
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
41
42
|
* `bundle_id` (int64): Required - List recipients for the bundle with this ID.
|
data/docs/clickwrap.md
CHANGED
@@ -36,6 +36,7 @@ Files::Clickwrap.list(
|
|
36
36
|
* `page` (int64): Current page number.
|
37
37
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
38
38
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
39
|
+
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
39
40
|
|
40
41
|
|
41
42
|
---
|
data/docs/dns_record.md
CHANGED
@@ -33,3 +33,4 @@ Files::DnsRecord.list(
|
|
33
33
|
* `page` (int64): Current page number.
|
34
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
|
+
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
@@ -0,0 +1,43 @@
|
|
1
|
+
# ExternalEvent
|
2
|
+
|
3
|
+
## Example ExternalEvent Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"event_type": "",
|
8
|
+
"status": "",
|
9
|
+
"body": "",
|
10
|
+
"created_at": "2000-01-01T01:00:00Z"
|
11
|
+
}
|
12
|
+
```
|
13
|
+
|
14
|
+
* `event_type` (string): Type of event being recorded. Valid values: `remote_server_sync`, `lockout`, `ldap_login`, `saml_login`
|
15
|
+
* `status` (string): Status of event. Valid values: `error`
|
16
|
+
* `body` (string): Event body
|
17
|
+
* `created_at` (date-time): External event create date/time
|
18
|
+
|
19
|
+
|
20
|
+
---
|
21
|
+
|
22
|
+
## List External Events
|
23
|
+
|
24
|
+
```
|
25
|
+
Files::ExternalEvent.list(
|
26
|
+
page: 1,
|
27
|
+
per_page: 1
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
31
|
+
### Parameters
|
32
|
+
|
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
|
+
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
36
|
+
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
37
|
+
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `site_id`, `event_type`, `created_at` or `status`.
|
38
|
+
* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
|
39
|
+
* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
|
40
|
+
* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
|
41
|
+
* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
|
42
|
+
* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
|
43
|
+
* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
|
data/docs/file.md
CHANGED
@@ -141,7 +141,7 @@ Files::File.delete(path,
|
|
141
141
|
### Parameters
|
142
142
|
|
143
143
|
* `path` (string): Required - Path to operate on.
|
144
|
-
* `recursive` (boolean): If true, will recursively delete folers. Otherwise, will error on non-empty folders.
|
144
|
+
* `recursive` (boolean): If true, will recursively delete folers. Otherwise, will error on non-empty folders.
|
145
145
|
|
146
146
|
|
147
147
|
---
|
@@ -201,4 +201,4 @@ file.delete(
|
|
201
201
|
### Parameters
|
202
202
|
|
203
203
|
* `path` (string): Required - Path to operate on.
|
204
|
-
* `recursive` (boolean): If true, will recursively delete folers. Otherwise, will error on non-empty folders.
|
204
|
+
* `recursive` (boolean): If true, will recursively delete folers. Otherwise, will error on non-empty folders.
|
data/docs/file_comment.md
CHANGED
@@ -34,6 +34,7 @@ Files::FileComment.list_for(path,
|
|
34
34
|
* `page` (int64): Current page number.
|
35
35
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
36
36
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
37
|
+
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
37
38
|
* `path` (string): Required - Path to operate on.
|
38
39
|
|
39
40
|
|
data/docs/file_part_upload.md
CHANGED
@@ -12,6 +12,7 @@
|
|
12
12
|
"headers": "",
|
13
13
|
"http_method": "POST",
|
14
14
|
"next_partsize": "",
|
15
|
+
"parallel_parts": true,
|
15
16
|
"parameters": "",
|
16
17
|
"part_number": "",
|
17
18
|
"partsize": "",
|
@@ -29,6 +30,7 @@
|
|
29
30
|
* `headers` (object): Additional upload headers
|
30
31
|
* `http_method` (string): Upload method, usually POST
|
31
32
|
* `next_partsize` (string): Currently unused
|
33
|
+
* `parallel_parts` (boolean): If true, parts may be uploaded in parallel
|
32
34
|
* `parameters` (string): Additional upload parameters
|
33
35
|
* `part_number` (string): Currently unused
|
34
36
|
* `partsize` (string): Currently unused
|
data/docs/folder.md
CHANGED
@@ -66,9 +66,9 @@ Files::Folder.list_for(path,
|
|
66
66
|
|
67
67
|
* `page` (int64): Current page number.
|
68
68
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
69
|
-
* `action` (string): Action to take. Can be `count`, `
|
70
|
-
* `path` (string): Required - Path to operate on.
|
69
|
+
* `action` (string): Action to take. Can be `count`, `size`, `permissions`, or blank.
|
71
70
|
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor header.
|
71
|
+
* `path` (string): Required - Path to operate on.
|
72
72
|
* `filter` (string): If specified, will to filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
|
73
73
|
* `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
74
74
|
* `search` (string): If `search_all` is `true`, provide the search string here. Otherwise, this parameter acts like an alias of `filter`.
|
data/docs/group_user.md
CHANGED
@@ -41,6 +41,7 @@ Files::GroupUser.list(
|
|
41
41
|
* `page` (int64): Current page number.
|
42
42
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
43
43
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
44
|
+
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
44
45
|
* `group_id` (int64): Group ID. If provided, will return group_users of this group.
|
45
46
|
|
46
47
|
|
data/docs/history_export.md
CHANGED
@@ -10,9 +10,9 @@
|
|
10
10
|
"status": "ready",
|
11
11
|
"query_action": "read",
|
12
12
|
"query_interface": "ftp",
|
13
|
-
"query_user_id": 1,
|
14
|
-
"query_file_id": 1,
|
15
|
-
"query_parent_id": 1,
|
13
|
+
"query_user_id": "1",
|
14
|
+
"query_file_id": "1",
|
15
|
+
"query_parent_id": "1",
|
16
16
|
"query_path": "MyFile.txt",
|
17
17
|
"query_folder": "Folder",
|
18
18
|
"query_src": "SrcFolder",
|
@@ -20,13 +20,14 @@
|
|
20
20
|
"query_ip": "127.0.0.1",
|
21
21
|
"query_username": "jerry",
|
22
22
|
"query_failure_type": "bad_password",
|
23
|
-
"query_target_id": 1,
|
23
|
+
"query_target_id": "1",
|
24
24
|
"query_target_name": "full",
|
25
25
|
"query_target_permission": "full",
|
26
|
-
"query_target_user_id": 1,
|
26
|
+
"query_target_user_id": "1",
|
27
27
|
"query_target_username": "jerry",
|
28
28
|
"query_target_platform": "windows",
|
29
|
-
"query_target_permission_set": "desktop_app"
|
29
|
+
"query_target_permission_set": "desktop_app",
|
30
|
+
"results_url": "https://files.com/history_results.csv"
|
30
31
|
}
|
31
32
|
```
|
32
33
|
|
@@ -36,9 +37,9 @@
|
|
36
37
|
* `status` (string): Status of export. Will be: `building` or `ready`
|
37
38
|
* `query_action` (string): Filter results by this this action type. 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`
|
38
39
|
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
|
39
|
-
* `query_user_id` (
|
40
|
-
* `query_file_id` (
|
41
|
-
* `query_parent_id` (
|
40
|
+
* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
|
41
|
+
* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
|
42
|
+
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
42
43
|
* `query_path` (string): Return results that are file actions related to this path.
|
43
44
|
* `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
|
44
45
|
* `query_src` (string): Return results that are file moves originating from this path.
|
@@ -46,36 +47,17 @@
|
|
46
47
|
* `query_ip` (string): Filter results by this IP address.
|
47
48
|
* `query_username` (string): Filter results by this username.
|
48
49
|
* `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`
|
49
|
-
* `query_target_id` (
|
50
|
+
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
|
50
51
|
* `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.
|
51
52
|
* `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
|
52
|
-
* `query_target_user_id` (
|
53
|
+
* `query_target_user_id` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
|
53
54
|
* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
54
55
|
* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
55
56
|
* `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
|
57
|
+
* `results_url` (string): If `status` is `ready` and the query succeeded, this will be a URL where all the results can be downloaded at once as a CSV.
|
56
58
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
57
59
|
|
58
60
|
|
59
|
-
---
|
60
|
-
|
61
|
-
## List History Exports
|
62
|
-
|
63
|
-
```
|
64
|
-
Files::HistoryExport.list(
|
65
|
-
user_id: 1,
|
66
|
-
page: 1,
|
67
|
-
per_page: 1
|
68
|
-
)
|
69
|
-
```
|
70
|
-
|
71
|
-
### Parameters
|
72
|
-
|
73
|
-
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
74
|
-
* `page` (int64): Current page number.
|
75
|
-
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
76
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
77
|
-
|
78
|
-
|
79
61
|
---
|
80
62
|
|
81
63
|
## Show History Export
|
@@ -100,9 +82,9 @@ Files::HistoryExport.create(
|
|
100
82
|
end_at: "2000-01-01T01:00:00Z",
|
101
83
|
query_action: "read",
|
102
84
|
query_interface: "ftp",
|
103
|
-
query_user_id: 1,
|
104
|
-
query_file_id: 1,
|
105
|
-
query_parent_id: 1,
|
85
|
+
query_user_id: "1",
|
86
|
+
query_file_id: "1",
|
87
|
+
query_parent_id: "1",
|
106
88
|
query_path: "MyFile.txt",
|
107
89
|
query_folder: "Folder",
|
108
90
|
query_src: "SrcFolder",
|
@@ -110,10 +92,10 @@ Files::HistoryExport.create(
|
|
110
92
|
query_ip: "127.0.0.1",
|
111
93
|
query_username: "jerry",
|
112
94
|
query_failure_type: "bad_password",
|
113
|
-
query_target_id: 1,
|
95
|
+
query_target_id: "1",
|
114
96
|
query_target_name: "full",
|
115
97
|
query_target_permission: "full",
|
116
|
-
query_target_user_id: 1,
|
98
|
+
query_target_user_id: "1",
|
117
99
|
query_target_username: "jerry",
|
118
100
|
query_target_platform: "windows",
|
119
101
|
query_target_permission_set: "desktop_app"
|
@@ -127,9 +109,9 @@ Files::HistoryExport.create(
|
|
127
109
|
* `end_at` (string): End date/time of export range.
|
128
110
|
* `query_action` (string): Filter results by this this action type. 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`
|
129
111
|
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
|
130
|
-
* `query_user_id` (
|
131
|
-
* `query_file_id` (
|
132
|
-
* `query_parent_id` (
|
112
|
+
* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
|
113
|
+
* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
|
114
|
+
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
133
115
|
* `query_path` (string): Return results that are file actions related to this path.
|
134
116
|
* `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
|
135
117
|
* `query_src` (string): Return results that are file moves originating from this path.
|
@@ -137,38 +119,10 @@ Files::HistoryExport.create(
|
|
137
119
|
* `query_ip` (string): Filter results by this IP address.
|
138
120
|
* `query_username` (string): Filter results by this username.
|
139
121
|
* `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`
|
140
|
-
* `query_target_id` (
|
122
|
+
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
|
141
123
|
* `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.
|
142
124
|
* `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
|
143
|
-
* `query_target_user_id` (
|
125
|
+
* `query_target_user_id` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
|
144
126
|
* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
145
127
|
* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
146
128
|
* `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
|
147
|
-
|
148
|
-
|
149
|
-
---
|
150
|
-
|
151
|
-
## Delete History Export
|
152
|
-
|
153
|
-
```
|
154
|
-
Files::HistoryExport.delete(id)
|
155
|
-
```
|
156
|
-
|
157
|
-
### Parameters
|
158
|
-
|
159
|
-
* `id` (int64): Required - History Export ID.
|
160
|
-
|
161
|
-
|
162
|
-
---
|
163
|
-
|
164
|
-
## Delete History Export
|
165
|
-
|
166
|
-
```
|
167
|
-
history_export = Files::HistoryExport.list_for(path).first
|
168
|
-
|
169
|
-
history_export.delete
|
170
|
-
```
|
171
|
-
|
172
|
-
### Parameters
|
173
|
-
|
174
|
-
* `id` (int64): Required - History Export ID.
|
@@ -0,0 +1,79 @@
|
|
1
|
+
# HistoryExportResult
|
2
|
+
|
3
|
+
## Example HistoryExportResult Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"created_at": 1,
|
9
|
+
"user_id": 1,
|
10
|
+
"file_id": 1,
|
11
|
+
"parent_id": 1,
|
12
|
+
"path": "MyFile.txt",
|
13
|
+
"folder": "Folder",
|
14
|
+
"src": "SrcFolder",
|
15
|
+
"destination": "DestFolder",
|
16
|
+
"ip": "127.0.0.1",
|
17
|
+
"username": "jerry",
|
18
|
+
"action": "read",
|
19
|
+
"failure_type": "bad_password",
|
20
|
+
"interface": "ftp",
|
21
|
+
"target_id": 1,
|
22
|
+
"target_name": "full",
|
23
|
+
"target_permission": "full",
|
24
|
+
"target_recursive": true,
|
25
|
+
"target_expires_at": 1,
|
26
|
+
"target_permission_set": "desktop_app",
|
27
|
+
"target_platform": "windows",
|
28
|
+
"target_username": "jerry",
|
29
|
+
"target_user_id": 1
|
30
|
+
}
|
31
|
+
```
|
32
|
+
|
33
|
+
* `id` (int64): Action ID
|
34
|
+
* `created_at` (int64): When the action happened
|
35
|
+
* `user_id` (int64): User ID
|
36
|
+
* `file_id` (int64): File ID related to the action
|
37
|
+
* `parent_id` (int64): ID of the parent folder
|
38
|
+
* `path` (string): Path of the related action This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
39
|
+
* `folder` (string): Folder in which the action occurred
|
40
|
+
* `src` (string): File move originated from this path
|
41
|
+
* `destination` (string): File moved to this destination folder
|
42
|
+
* `ip` (string): Client IP that performed the action
|
43
|
+
* `username` (string): Username of the user that performed the action
|
44
|
+
* `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`
|
45
|
+
* `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`
|
46
|
+
* `interface` (string): Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
|
47
|
+
* `target_id` (int64): ID of the object (such as Users, or API Keys) on which the action was taken
|
48
|
+
* `target_name` (string): Name of the User, Group or other object with a name related to this action
|
49
|
+
* `target_permission` (string): Permission level of the action
|
50
|
+
* `target_recursive` (boolean): Whether or not the action was recursive
|
51
|
+
* `target_expires_at` (int64): If searching for Histories about API keys, this is when the API key will expire
|
52
|
+
* `target_permission_set` (string): If searching for Histories about API keys, this represents the permission set of the associated API key
|
53
|
+
* `target_platform` (string): If searching for Histories about API keys, this is the platform on which the action was taken
|
54
|
+
* `target_username` (string): If searching for Histories about API keys, this is the username on which the action was taken
|
55
|
+
* `target_user_id` (int64): If searching for Histories about API keys, this is the User ID on which the action was taken
|
56
|
+
|
57
|
+
|
58
|
+
---
|
59
|
+
|
60
|
+
## List History Export Results
|
61
|
+
|
62
|
+
```
|
63
|
+
Files::HistoryExportResult.list(
|
64
|
+
user_id: 1,
|
65
|
+
page: 1,
|
66
|
+
per_page: 1,
|
67
|
+
action: "read",
|
68
|
+
history_export_id: 1
|
69
|
+
)
|
70
|
+
```
|
71
|
+
|
72
|
+
### Parameters
|
73
|
+
|
74
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
75
|
+
* `page` (int64): Current page number.
|
76
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
77
|
+
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
78
|
+
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
79
|
+
* `history_export_id` (int64): Required - ID of the associated history export.
|