files.com 1.2.321 → 1.2.323
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.
- package/_VERSION +1 -1
- package/docs/models/GpgKey.md +8 -1
- package/docs/models/Partner.md +13 -6
- package/docs/models/Permission.md +2 -0
- package/docs/models/PublicKey.md +1 -0
- package/docs/models/ScimLog.md +13 -0
- package/docs/models/Site.md +1 -0
- package/docs/models/Sync.md +30 -28
- package/docs/models/SyncRun.md +28 -26
- package/docs/models/User.md +8 -1
- package/docs/models/UserLifecycleRule.md +36 -21
- package/lib/Files.js +1 -1
- package/lib/models/GpgKey.js +55 -34
- package/lib/models/Partner.js +34 -13
- package/lib/models/Permission.js +7 -0
- package/lib/models/PublicKey.js +1 -0
- package/lib/models/ScimLog.js +52 -0
- package/lib/models/SyncRun.js +48 -44
- package/lib/models/User.js +49 -28
- package/lib/models/UserLifecycleRule.js +87 -44
- package/package.json +1 -1
- package/src/Files.js +1 -1
- package/src/models/GpgKey.js +18 -1
- package/src/models/Partner.js +19 -2
- package/src/models/Permission.js +7 -0
- package/src/models/PublicKey.js +1 -0
- package/src/models/ScimLog.js +25 -0
- package/src/models/SyncRun.js +34 -31
- package/src/models/User.js +18 -1
- package/src/models/UserLifecycleRule.js +64 -29
package/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.2.
|
|
1
|
+
1.2.323
|
package/docs/models/GpgKey.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
"id": 1,
|
|
8
8
|
"expires_at": "2000-01-01T01:00:00Z",
|
|
9
9
|
"name": "key name",
|
|
10
|
+
"partner_id": 1,
|
|
10
11
|
"user_id": 1,
|
|
11
12
|
"public_key_md5": "7f8bc1210b09b9ddf469e6b6b8920e76",
|
|
12
13
|
"private_key_md5": "ab236cfe4a195f0226bc2e674afdd6b0",
|
|
@@ -19,7 +20,8 @@
|
|
|
19
20
|
* `id` (int64): Your GPG key ID.
|
|
20
21
|
* `expires_at` (date-time): Your GPG key expiration date.
|
|
21
22
|
* `name` (string): Your GPG key name.
|
|
22
|
-
* `
|
|
23
|
+
* `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
|
|
24
|
+
* `user_id` (int64): User ID who owns this GPG Key, if applicable.
|
|
23
25
|
* `public_key_md5` (string): MD5 hash of your GPG public key
|
|
24
26
|
* `private_key_md5` (string): MD5 hash of your GPG private key.
|
|
25
27
|
* `generated_public_key` (string): Your GPG public key
|
|
@@ -71,6 +73,7 @@ await GpgKey.find(id)
|
|
|
71
73
|
```
|
|
72
74
|
await GpgKey.create({
|
|
73
75
|
'user_id': 1,
|
|
76
|
+
'partner_id': 1,
|
|
74
77
|
'public_key': "7f8bc1210b09b9ddf469e6b6b8920e76",
|
|
75
78
|
'private_key': "ab236cfe4a195f0226bc2e674afdd6b0",
|
|
76
79
|
'private_key_password': "[your GPG private key password]",
|
|
@@ -86,6 +89,7 @@ await GpgKey.create({
|
|
|
86
89
|
### Parameters
|
|
87
90
|
|
|
88
91
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
92
|
+
* `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
|
|
89
93
|
* `public_key` (string): MD5 hash of your GPG public key
|
|
90
94
|
* `private_key` (string): MD5 hash of your GPG private key.
|
|
91
95
|
* `private_key_password` (string): Your GPG private key password. Only required for password protected keys.
|
|
@@ -103,6 +107,7 @@ await GpgKey.create({
|
|
|
103
107
|
const gpg_key = await GpgKey.find(id)
|
|
104
108
|
|
|
105
109
|
await gpg_key.update({
|
|
110
|
+
'partner_id': 1,
|
|
106
111
|
'public_key': "7f8bc1210b09b9ddf469e6b6b8920e76",
|
|
107
112
|
'private_key': "ab236cfe4a195f0226bc2e674afdd6b0",
|
|
108
113
|
'private_key_password': "[your GPG private key password]",
|
|
@@ -113,6 +118,7 @@ await gpg_key.update({
|
|
|
113
118
|
### Parameters
|
|
114
119
|
|
|
115
120
|
* `id` (int64): Required - Gpg Key ID.
|
|
121
|
+
* `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
|
|
116
122
|
* `public_key` (string): MD5 hash of your GPG public key
|
|
117
123
|
* `private_key` (string): MD5 hash of your GPG private key.
|
|
118
124
|
* `private_key_password` (string): Your GPG private key password. Only required for password protected keys.
|
|
@@ -125,6 +131,7 @@ await gpg_key.update({
|
|
|
125
131
|
"id": 1,
|
|
126
132
|
"expires_at": "2000-01-01T01:00:00Z",
|
|
127
133
|
"name": "key name",
|
|
134
|
+
"partner_id": 1,
|
|
128
135
|
"user_id": 1,
|
|
129
136
|
"public_key_md5": "7f8bc1210b09b9ddf469e6b6b8920e76",
|
|
130
137
|
"private_key_md5": "ab236cfe4a195f0226bc2e674afdd6b0",
|
package/docs/models/Partner.md
CHANGED
|
@@ -10,7 +10,8 @@
|
|
|
10
10
|
"id": 1,
|
|
11
11
|
"name": "Acme Corp",
|
|
12
12
|
"notes": "This is a note about the partner.",
|
|
13
|
-
"root_folder": "/AcmeCorp"
|
|
13
|
+
"root_folder": "/AcmeCorp",
|
|
14
|
+
"tags": "example"
|
|
14
15
|
}
|
|
15
16
|
```
|
|
16
17
|
|
|
@@ -21,6 +22,7 @@
|
|
|
21
22
|
* `name` (string): The name of the Partner.
|
|
22
23
|
* `notes` (string): Notes about this Partner.
|
|
23
24
|
* `root_folder` (string): The root folder path for this Partner.
|
|
25
|
+
* `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
24
26
|
|
|
25
27
|
---
|
|
26
28
|
|
|
@@ -56,24 +58,26 @@ await Partner.find(id)
|
|
|
56
58
|
|
|
57
59
|
```
|
|
58
60
|
await Partner.create({
|
|
61
|
+
'name': "Acme Corp",
|
|
59
62
|
'allow_bypassing_2fa_policies': false,
|
|
60
63
|
'allow_credential_changes': false,
|
|
61
64
|
'allow_user_creation': false,
|
|
62
|
-
'name': "Acme Corp",
|
|
63
65
|
'notes': "This is a note about the partner.",
|
|
64
66
|
'root_folder': "/AcmeCorp",
|
|
67
|
+
'tags': "example",
|
|
65
68
|
})
|
|
66
69
|
```
|
|
67
70
|
|
|
68
71
|
|
|
69
72
|
### Parameters
|
|
70
73
|
|
|
74
|
+
* `name` (string): The name of the Partner.
|
|
71
75
|
* `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
|
|
72
76
|
* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
73
77
|
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
74
|
-
* `name` (string): The name of the Partner.
|
|
75
78
|
* `notes` (string): Notes about this Partner.
|
|
76
79
|
* `root_folder` (string): The root folder path for this Partner.
|
|
80
|
+
* `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
77
81
|
|
|
78
82
|
---
|
|
79
83
|
|
|
@@ -83,24 +87,26 @@ await Partner.create({
|
|
|
83
87
|
const partner = await Partner.find(id)
|
|
84
88
|
|
|
85
89
|
await partner.update({
|
|
90
|
+
'name': "Acme Corp",
|
|
86
91
|
'allow_bypassing_2fa_policies': false,
|
|
87
92
|
'allow_credential_changes': false,
|
|
88
93
|
'allow_user_creation': false,
|
|
89
|
-
'name': "Acme Corp",
|
|
90
94
|
'notes': "This is a note about the partner.",
|
|
91
95
|
'root_folder': "/AcmeCorp",
|
|
96
|
+
'tags': "example",
|
|
92
97
|
})
|
|
93
98
|
```
|
|
94
99
|
|
|
95
100
|
### Parameters
|
|
96
101
|
|
|
97
102
|
* `id` (int64): Required - Partner ID.
|
|
103
|
+
* `name` (string): The name of the Partner.
|
|
98
104
|
* `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
|
|
99
105
|
* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
100
106
|
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
101
|
-
* `name` (string): The name of the Partner.
|
|
102
107
|
* `notes` (string): Notes about this Partner.
|
|
103
108
|
* `root_folder` (string): The root folder path for this Partner.
|
|
109
|
+
* `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
104
110
|
|
|
105
111
|
### Example Response
|
|
106
112
|
|
|
@@ -112,7 +118,8 @@ await partner.update({
|
|
|
112
118
|
"id": 1,
|
|
113
119
|
"name": "Acme Corp",
|
|
114
120
|
"notes": "This is a note about the partner.",
|
|
115
|
-
"root_folder": "/AcmeCorp"
|
|
121
|
+
"root_folder": "/AcmeCorp",
|
|
122
|
+
"tags": "example"
|
|
116
123
|
}
|
|
117
124
|
```
|
|
118
125
|
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
"group_id": 1,
|
|
12
12
|
"group_name": "example",
|
|
13
13
|
"partner_id": 1,
|
|
14
|
+
"partner_name": "Acme Corp.",
|
|
14
15
|
"permission": "full",
|
|
15
16
|
"recursive": true,
|
|
16
17
|
"site_id": 1
|
|
@@ -24,6 +25,7 @@
|
|
|
24
25
|
* `group_id` (int64): Group ID
|
|
25
26
|
* `group_name` (string): Group name (if applicable)
|
|
26
27
|
* `partner_id` (int64): Partner ID (if applicable)
|
|
28
|
+
* `partner_name` (string): Partner name (if applicable)
|
|
27
29
|
* `permission` (string): Permission type. See the table referenced in the documentation for an explanation of each permission.
|
|
28
30
|
* `recursive` (boolean): Recursive: does this permission apply to subfolders?
|
|
29
31
|
* `site_id` (int64): Site ID
|
package/docs/models/PublicKey.md
CHANGED
|
@@ -51,6 +51,7 @@ await PublicKey.list({
|
|
|
51
51
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
52
52
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
53
53
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
54
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `title`, `created_at` or `user_id`.
|
|
54
55
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
|
55
56
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
56
57
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
package/docs/models/ScimLog.md
CHANGED
|
@@ -38,3 +38,16 @@ await ScimLog.list
|
|
|
38
38
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
39
39
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
40
40
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Show Scim Log
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
await ScimLog.find(id)
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
* `id` (int64): Required - Scim Log ID.
|
package/docs/models/Site.md
CHANGED
package/docs/models/Sync.md
CHANGED
|
@@ -43,26 +43,27 @@
|
|
|
43
43
|
"holiday_region": "us_dc",
|
|
44
44
|
"latest_sync_run": {
|
|
45
45
|
"id": 1,
|
|
46
|
-
"sync_id": 1,
|
|
47
|
-
"site_id": 1,
|
|
48
|
-
"status": "example",
|
|
49
|
-
"src_remote_server_type": "example",
|
|
50
|
-
"dest_remote_server_type": "example",
|
|
51
46
|
"body": "example",
|
|
52
|
-
"
|
|
53
|
-
"example"
|
|
54
|
-
],
|
|
47
|
+
"bytes_synced": 1,
|
|
55
48
|
"compared_files": 1,
|
|
56
49
|
"compared_folders": 1,
|
|
57
|
-
"errored_files": 1,
|
|
58
|
-
"successful_files": 1,
|
|
59
|
-
"runtime": 1.0,
|
|
60
|
-
"log_url": "https://www.example.com/log_file.txt",
|
|
61
50
|
"completed_at": "2000-01-01T01:00:00Z",
|
|
51
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
52
|
+
"dest_remote_server_type": "example",
|
|
62
53
|
"dry_run": true,
|
|
63
|
-
"
|
|
54
|
+
"errored_files": 1,
|
|
64
55
|
"estimated_bytes_count": 1,
|
|
65
|
-
"
|
|
56
|
+
"event_errors": [
|
|
57
|
+
"example"
|
|
58
|
+
],
|
|
59
|
+
"log_url": "https://www.example.com/log_file.txt",
|
|
60
|
+
"runtime": 1.0,
|
|
61
|
+
"site_id": 1,
|
|
62
|
+
"src_remote_server_type": "example",
|
|
63
|
+
"status": "example",
|
|
64
|
+
"successful_files": 1,
|
|
65
|
+
"sync_id": 1,
|
|
66
|
+
"sync_name": "Azure to SharePoint Sync",
|
|
66
67
|
"updated_at": "2000-01-01T01:00:00Z"
|
|
67
68
|
}
|
|
68
69
|
}
|
|
@@ -296,26 +297,27 @@ await sync.update({
|
|
|
296
297
|
"holiday_region": "us_dc",
|
|
297
298
|
"latest_sync_run": {
|
|
298
299
|
"id": 1,
|
|
299
|
-
"sync_id": 1,
|
|
300
|
-
"site_id": 1,
|
|
301
|
-
"status": "example",
|
|
302
|
-
"src_remote_server_type": "example",
|
|
303
|
-
"dest_remote_server_type": "example",
|
|
304
300
|
"body": "example",
|
|
305
|
-
"
|
|
306
|
-
"example"
|
|
307
|
-
],
|
|
301
|
+
"bytes_synced": 1,
|
|
308
302
|
"compared_files": 1,
|
|
309
303
|
"compared_folders": 1,
|
|
310
|
-
"errored_files": 1,
|
|
311
|
-
"successful_files": 1,
|
|
312
|
-
"runtime": 1.0,
|
|
313
|
-
"log_url": "https://www.example.com/log_file.txt",
|
|
314
304
|
"completed_at": "2000-01-01T01:00:00Z",
|
|
305
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
306
|
+
"dest_remote_server_type": "example",
|
|
315
307
|
"dry_run": true,
|
|
316
|
-
"
|
|
308
|
+
"errored_files": 1,
|
|
317
309
|
"estimated_bytes_count": 1,
|
|
318
|
-
"
|
|
310
|
+
"event_errors": [
|
|
311
|
+
"example"
|
|
312
|
+
],
|
|
313
|
+
"log_url": "https://www.example.com/log_file.txt",
|
|
314
|
+
"runtime": 1.0,
|
|
315
|
+
"site_id": 1,
|
|
316
|
+
"src_remote_server_type": "example",
|
|
317
|
+
"status": "example",
|
|
318
|
+
"successful_files": 1,
|
|
319
|
+
"sync_id": 1,
|
|
320
|
+
"sync_name": "Azure to SharePoint Sync",
|
|
319
321
|
"updated_at": "2000-01-01T01:00:00Z"
|
|
320
322
|
}
|
|
321
323
|
}
|
package/docs/models/SyncRun.md
CHANGED
|
@@ -5,49 +5,51 @@
|
|
|
5
5
|
```
|
|
6
6
|
{
|
|
7
7
|
"id": 1,
|
|
8
|
-
"sync_id": 1,
|
|
9
|
-
"site_id": 1,
|
|
10
|
-
"status": "example",
|
|
11
|
-
"src_remote_server_type": "example",
|
|
12
|
-
"dest_remote_server_type": "example",
|
|
13
8
|
"body": "example",
|
|
14
|
-
"
|
|
15
|
-
"example"
|
|
16
|
-
],
|
|
9
|
+
"bytes_synced": 1,
|
|
17
10
|
"compared_files": 1,
|
|
18
11
|
"compared_folders": 1,
|
|
19
|
-
"errored_files": 1,
|
|
20
|
-
"successful_files": 1,
|
|
21
|
-
"runtime": 1.0,
|
|
22
|
-
"log_url": "https://www.example.com/log_file.txt",
|
|
23
12
|
"completed_at": "2000-01-01T01:00:00Z",
|
|
13
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
14
|
+
"dest_remote_server_type": "example",
|
|
24
15
|
"dry_run": true,
|
|
25
|
-
"
|
|
16
|
+
"errored_files": 1,
|
|
26
17
|
"estimated_bytes_count": 1,
|
|
27
|
-
"
|
|
18
|
+
"event_errors": [
|
|
19
|
+
"example"
|
|
20
|
+
],
|
|
21
|
+
"log_url": "https://www.example.com/log_file.txt",
|
|
22
|
+
"runtime": 1.0,
|
|
23
|
+
"site_id": 1,
|
|
24
|
+
"src_remote_server_type": "example",
|
|
25
|
+
"status": "example",
|
|
26
|
+
"successful_files": 1,
|
|
27
|
+
"sync_id": 1,
|
|
28
|
+
"sync_name": "Azure to SharePoint Sync",
|
|
28
29
|
"updated_at": "2000-01-01T01:00:00Z"
|
|
29
30
|
}
|
|
30
31
|
```
|
|
31
32
|
|
|
32
33
|
* `id` (int64): SyncRun ID
|
|
33
|
-
* `sync_id` (int64): ID of the Sync this run belongs to
|
|
34
|
-
* `site_id` (int64): Site ID
|
|
35
|
-
* `status` (string): Status of the sync run (success, failure, partial_failure, in_progress, skipped)
|
|
36
|
-
* `src_remote_server_type` (string): Source remote server type, if any
|
|
37
|
-
* `dest_remote_server_type` (string): Destination remote server type, if any
|
|
38
34
|
* `body` (string): Log or summary body for this run
|
|
39
|
-
* `
|
|
35
|
+
* `bytes_synced` (int64): Total bytes synced in this run
|
|
40
36
|
* `compared_files` (int64): Number of files compared
|
|
41
37
|
* `compared_folders` (int64): Number of folders compared
|
|
42
|
-
* `errored_files` (int64): Number of files that errored
|
|
43
|
-
* `successful_files` (int64): Number of files successfully synced
|
|
44
|
-
* `runtime` (double): Total runtime in seconds
|
|
45
|
-
* `log_url` (string): Link to external log file.
|
|
46
38
|
* `completed_at` (date-time): When this run was completed
|
|
39
|
+
* `created_at` (date-time): When this run was created
|
|
40
|
+
* `dest_remote_server_type` (string): Destination remote server type, if any
|
|
47
41
|
* `dry_run` (boolean): Whether this run was a dry run (no actual changes made)
|
|
48
|
-
* `
|
|
42
|
+
* `errored_files` (int64): Number of files that errored
|
|
49
43
|
* `estimated_bytes_count` (int64): Estimated bytes count for this run
|
|
50
|
-
* `
|
|
44
|
+
* `event_errors` (array(string)): Array of errors encountered during the run
|
|
45
|
+
* `log_url` (string): Link to external log file.
|
|
46
|
+
* `runtime` (double): Total runtime in seconds
|
|
47
|
+
* `site_id` (int64): Site ID
|
|
48
|
+
* `src_remote_server_type` (string): Source remote server type, if any
|
|
49
|
+
* `status` (string): Status of the sync run (success, failure, partial_failure, in_progress, skipped)
|
|
50
|
+
* `successful_files` (int64): Number of files successfully synced
|
|
51
|
+
* `sync_id` (int64): ID of the Sync this run belongs to
|
|
52
|
+
* `sync_name` (string): Name of the Sync this run belongs to
|
|
51
53
|
* `updated_at` (date-time): When this run was last updated
|
|
52
54
|
|
|
53
55
|
---
|
package/docs/models/User.md
CHANGED
|
@@ -68,6 +68,7 @@
|
|
|
68
68
|
"sso_strategy_id": 1,
|
|
69
69
|
"subscribe_to_newsletter": true,
|
|
70
70
|
"externally_managed": true,
|
|
71
|
+
"tags": "example",
|
|
71
72
|
"time_zone": "Pacific Time (US & Canada)",
|
|
72
73
|
"type_of_2fa": "yubi",
|
|
73
74
|
"type_of_2fa_for_display": "yubi",
|
|
@@ -140,6 +141,7 @@
|
|
|
140
141
|
* `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
|
|
141
142
|
* `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
|
|
142
143
|
* `externally_managed` (boolean): Is this user managed by a SsoStrategy?
|
|
144
|
+
* `tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
143
145
|
* `time_zone` (string): User time zone
|
|
144
146
|
* `type_of_2fa` (string): Type(s) of 2FA methods in use, for programmatic use. Will be either `sms`, `totp`, `webauthn`, `yubi`, `email`, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
|
|
145
147
|
* `type_of_2fa_for_display` (string): Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike `type_of_2fa`, this value will make clear when a user has more than 1 of the same type of method.
|
|
@@ -175,7 +177,7 @@ await User.list({
|
|
|
175
177
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
176
178
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
177
179
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `name`, `company`, `password_validity_days`, `ssl_required`, `username`, `site_admin` or `disabled`.
|
|
178
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin` or `
|
|
180
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled` or `partner_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]` or `[ company, name ]`.
|
|
179
181
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
|
|
180
182
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
|
|
181
183
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ company, name ]`.
|
|
@@ -243,6 +245,7 @@ await User.create({
|
|
|
243
245
|
'sso_strategy_id': 1,
|
|
244
246
|
'subscribe_to_newsletter': true,
|
|
245
247
|
'require_2fa': "always_require",
|
|
248
|
+
'tags': "example",
|
|
246
249
|
'time_zone': "Pacific Time (US & Canada)",
|
|
247
250
|
'user_root': "example",
|
|
248
251
|
'user_home': "example",
|
|
@@ -299,6 +302,7 @@ await User.create({
|
|
|
299
302
|
* `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
|
|
300
303
|
* `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
|
|
301
304
|
* `require_2fa` (string): 2FA required setting
|
|
305
|
+
* `tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
302
306
|
* `time_zone` (string): User time zone
|
|
303
307
|
* `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.
|
|
304
308
|
* `user_home` (string): Home folder for FTP/SFTP. Note that this is not used for API, Desktop, or Web interface.
|
|
@@ -396,6 +400,7 @@ await user.update({
|
|
|
396
400
|
'sso_strategy_id': 1,
|
|
397
401
|
'subscribe_to_newsletter': true,
|
|
398
402
|
'require_2fa': "always_require",
|
|
403
|
+
'tags': "example",
|
|
399
404
|
'time_zone': "Pacific Time (US & Canada)",
|
|
400
405
|
'user_root': "example",
|
|
401
406
|
'user_home': "example",
|
|
@@ -453,6 +458,7 @@ await user.update({
|
|
|
453
458
|
* `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
|
|
454
459
|
* `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
|
|
455
460
|
* `require_2fa` (string): 2FA required setting
|
|
461
|
+
* `tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
456
462
|
* `time_zone` (string): User time zone
|
|
457
463
|
* `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.
|
|
458
464
|
* `user_home` (string): Home folder for FTP/SFTP. Note that this is not used for API, Desktop, or Web interface.
|
|
@@ -527,6 +533,7 @@ await user.update({
|
|
|
527
533
|
"sso_strategy_id": 1,
|
|
528
534
|
"subscribe_to_newsletter": true,
|
|
529
535
|
"externally_managed": true,
|
|
536
|
+
"tags": "example",
|
|
530
537
|
"time_zone": "Pacific Time (US & Canada)",
|
|
531
538
|
"type_of_2fa": "yubi",
|
|
532
539
|
"type_of_2fa_for_display": "yubi",
|
|
@@ -11,26 +11,30 @@
|
|
|
11
11
|
2,
|
|
12
12
|
3
|
|
13
13
|
],
|
|
14
|
+
"action": "disable",
|
|
14
15
|
"inactivity_days": 12,
|
|
15
16
|
"include_folder_admins": true,
|
|
16
17
|
"include_site_admins": true,
|
|
17
|
-
"action": "disable",
|
|
18
|
-
"user_state": "inactive",
|
|
19
18
|
"name": "password specific rules",
|
|
20
|
-
"
|
|
19
|
+
"partner_tag": "guest",
|
|
20
|
+
"site_id": 1,
|
|
21
|
+
"user_state": "inactive",
|
|
22
|
+
"user_tag": "guest"
|
|
21
23
|
}
|
|
22
24
|
```
|
|
23
25
|
|
|
24
26
|
* `id` (int64): User Lifecycle Rule ID
|
|
25
|
-
* `authentication_method` (string): User authentication method for the rule
|
|
27
|
+
* `authentication_method` (string): User authentication method for which the rule will apply.
|
|
26
28
|
* `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
|
|
27
|
-
* `inactivity_days` (int64): Number of days of inactivity before the rule applies
|
|
28
|
-
* `include_folder_admins` (boolean): Include folder admins in the rule
|
|
29
|
-
* `include_site_admins` (boolean): Include site admins in the rule
|
|
30
29
|
* `action` (string): Action to take on inactive users (disable or delete)
|
|
31
|
-
* `
|
|
30
|
+
* `inactivity_days` (int64): Number of days of inactivity before the rule applies
|
|
31
|
+
* `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
|
|
32
|
+
* `include_site_admins` (boolean): If true, the rule will apply to site admins.
|
|
32
33
|
* `name` (string): User Lifecycle Rule name
|
|
34
|
+
* `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
33
35
|
* `site_id` (int64): Site ID
|
|
36
|
+
* `user_state` (string): State of the users to apply the rule to (inactive or disabled)
|
|
37
|
+
* `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
34
38
|
|
|
35
39
|
---
|
|
36
40
|
|
|
@@ -45,6 +49,7 @@ await UserLifecycleRule.list
|
|
|
45
49
|
|
|
46
50
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
47
51
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
52
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`.
|
|
48
53
|
|
|
49
54
|
---
|
|
50
55
|
|
|
@@ -70,8 +75,10 @@ await UserLifecycleRule.create({
|
|
|
70
75
|
'inactivity_days': 12,
|
|
71
76
|
'include_site_admins': true,
|
|
72
77
|
'include_folder_admins': true,
|
|
73
|
-
'user_state': "inactive",
|
|
74
78
|
'name': "password specific rules",
|
|
79
|
+
'partner_tag': "guest",
|
|
80
|
+
'user_state': "inactive",
|
|
81
|
+
'user_tag': "guest",
|
|
75
82
|
})
|
|
76
83
|
```
|
|
77
84
|
|
|
@@ -79,13 +86,15 @@ await UserLifecycleRule.create({
|
|
|
79
86
|
### Parameters
|
|
80
87
|
|
|
81
88
|
* `action` (string): Action to take on inactive users (disable or delete)
|
|
82
|
-
* `authentication_method` (string): User authentication method for the rule
|
|
89
|
+
* `authentication_method` (string): User authentication method for which the rule will apply.
|
|
83
90
|
* `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
|
|
84
91
|
* `inactivity_days` (int64): Number of days of inactivity before the rule applies
|
|
85
|
-
* `include_site_admins` (boolean):
|
|
86
|
-
* `include_folder_admins` (boolean):
|
|
87
|
-
* `user_state` (string): State of the users to apply the rule to (inactive or disabled)
|
|
92
|
+
* `include_site_admins` (boolean): If true, the rule will apply to site admins.
|
|
93
|
+
* `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
|
|
88
94
|
* `name` (string): User Lifecycle Rule name
|
|
95
|
+
* `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
96
|
+
* `user_state` (string): State of the users to apply the rule to (inactive or disabled)
|
|
97
|
+
* `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
89
98
|
|
|
90
99
|
---
|
|
91
100
|
|
|
@@ -100,8 +109,10 @@ await user_lifecycle_rule.update({
|
|
|
100
109
|
'inactivity_days': 12,
|
|
101
110
|
'include_site_admins': true,
|
|
102
111
|
'include_folder_admins': true,
|
|
103
|
-
'user_state': "inactive",
|
|
104
112
|
'name': "password specific rules",
|
|
113
|
+
'partner_tag': "guest",
|
|
114
|
+
'user_state': "inactive",
|
|
115
|
+
'user_tag': "guest",
|
|
105
116
|
})
|
|
106
117
|
```
|
|
107
118
|
|
|
@@ -109,13 +120,15 @@ await user_lifecycle_rule.update({
|
|
|
109
120
|
|
|
110
121
|
* `id` (int64): Required - User Lifecycle Rule ID.
|
|
111
122
|
* `action` (string): Action to take on inactive users (disable or delete)
|
|
112
|
-
* `authentication_method` (string): User authentication method for the rule
|
|
123
|
+
* `authentication_method` (string): User authentication method for which the rule will apply.
|
|
113
124
|
* `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
|
|
114
125
|
* `inactivity_days` (int64): Number of days of inactivity before the rule applies
|
|
115
|
-
* `include_site_admins` (boolean):
|
|
116
|
-
* `include_folder_admins` (boolean):
|
|
117
|
-
* `user_state` (string): State of the users to apply the rule to (inactive or disabled)
|
|
126
|
+
* `include_site_admins` (boolean): If true, the rule will apply to site admins.
|
|
127
|
+
* `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
|
|
118
128
|
* `name` (string): User Lifecycle Rule name
|
|
129
|
+
* `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
130
|
+
* `user_state` (string): State of the users to apply the rule to (inactive or disabled)
|
|
131
|
+
* `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
|
|
119
132
|
|
|
120
133
|
### Example Response
|
|
121
134
|
|
|
@@ -128,13 +141,15 @@ await user_lifecycle_rule.update({
|
|
|
128
141
|
2,
|
|
129
142
|
3
|
|
130
143
|
],
|
|
144
|
+
"action": "disable",
|
|
131
145
|
"inactivity_days": 12,
|
|
132
146
|
"include_folder_admins": true,
|
|
133
147
|
"include_site_admins": true,
|
|
134
|
-
"action": "disable",
|
|
135
|
-
"user_state": "inactive",
|
|
136
148
|
"name": "password specific rules",
|
|
137
|
-
"
|
|
149
|
+
"partner_tag": "guest",
|
|
150
|
+
"site_id": 1,
|
|
151
|
+
"user_state": "inactive",
|
|
152
|
+
"user_tag": "guest"
|
|
138
153
|
}
|
|
139
154
|
```
|
|
140
155
|
|
package/lib/Files.js
CHANGED
|
@@ -12,7 +12,7 @@ var apiKey;
|
|
|
12
12
|
var baseUrl = 'https://app.files.com';
|
|
13
13
|
var sessionId = null;
|
|
14
14
|
var language = null;
|
|
15
|
-
var version = '1.2.
|
|
15
|
+
var version = '1.2.323';
|
|
16
16
|
var userAgent = "Files.com JavaScript SDK v".concat(version);
|
|
17
17
|
var logLevel = _Logger.LogLevel.INFO;
|
|
18
18
|
var debugRequest = false;
|