You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/models/KeyLifecycleRule.md
+18-4Lines changed: 18 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,18 @@
7
7
"id": 1,
8
8
"key_type": "gpg",
9
9
"inactivity_days": 12,
10
-
"name": "inactive gpg keys"
10
+
"apply_to_all_workspaces": true,
11
+
"name": "inactive gpg keys",
12
+
"workspace_id": 12
11
13
}
12
14
```
13
15
14
16
*`id` (int64): Key Lifecycle Rule ID
15
17
*`key_type` (string): Key type for which the rule will apply (gpg or ssh).
16
18
*`inactivity_days` (int64): Number of days of inactivity before the rule applies.
19
+
*`apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to keys in all workspaces.
17
20
*`name` (string): Key Lifecycle Rule name
21
+
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
18
22
19
23
---
20
24
@@ -29,8 +33,8 @@ await KeyLifecycleRule.list
29
33
30
34
*`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.
31
35
*`per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
32
-
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `key_type`.
33
-
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `key_type`.
36
+
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `key_type`.
37
+
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
Copy file name to clipboardExpand all lines: docs/models/Restore.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,7 @@
24
24
"two_factor_authentication_methods_restored": 1,
25
25
"status": "pending",
26
26
"update_timestamps": true,
27
+
"workspace_id": 12,
27
28
"error_messages": [
28
29
"example"
29
30
]
@@ -50,6 +51,7 @@
50
51
*`two_factor_authentication_methods_restored` (int64): Number of two factor authentication methods restored (only present for `restoration_type=users`).
51
52
*`status` (string): Status of the restoration process.
52
53
*`update_timestamps` (boolean): If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
54
+
*`workspace_id` (int64): Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
53
55
*`error_messages` (array(string)): Error messages received while restoring files and/or directories. Only present if there were errors.
54
56
55
57
---
@@ -65,7 +67,7 @@ await Restore.list
65
67
66
68
*`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.
67
69
*`per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
68
-
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
70
+
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
69
71
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `restoration_type`.
70
72
71
73
---
@@ -80,6 +82,7 @@ await Restore.create({
80
82
'restore_deleted_permissions': true,
81
83
'restore_in_place': true,
82
84
'update_timestamps': true,
85
+
'workspace_id': 12,
83
86
})
84
87
```
85
88
@@ -92,3 +95,4 @@ await Restore.create({
92
95
*`restore_deleted_permissions` (boolean): If true, we will also restore any Permissions that match the same path prefix from the same dates.
93
96
*`restore_in_place` (boolean): If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
94
97
*`update_timestamps` (boolean): If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
98
+
*`workspace_id` (int64): Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
Copy file name to clipboardExpand all lines: docs/models/UserLifecycleRule.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,11 @@
15
15
"inactivity_days": 12,
16
16
"include_folder_admins": true,
17
17
"include_site_admins": true,
18
+
"apply_to_all_workspaces": true,
18
19
"name": "password specific rules",
19
20
"partner_tag": "guest",
20
21
"site_id": 1,
22
+
"workspace_id": 12,
21
23
"user_state": "inactive",
22
24
"user_tag": "guest"
23
25
}
@@ -30,9 +32,11 @@
30
32
*`inactivity_days` (int64): Number of days of inactivity before the rule applies
31
33
*`include_folder_admins` (boolean): If true, the rule will apply to folder admins.
32
34
*`include_site_admins` (boolean): If true, the rule will apply to site admins.
35
+
*`apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to users in all workspaces.
33
36
*`name` (string): User Lifecycle Rule name
34
37
*`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.
35
38
*`site_id` (int64): Site ID
39
+
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
36
40
*`user_state` (string): State of the users to apply the rule to (inactive or disabled)
37
41
*`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.
38
42
@@ -49,7 +53,8 @@ await UserLifecycleRule.list
49
53
50
54
*`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.
51
55
*`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`.
56
+
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id` and `workspace_id`.
57
+
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
*`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
104
*`user_state` (string): State of the users to apply the rule to (inactive or disabled)
97
105
*`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.
106
+
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
*`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
142
*`user_state` (string): State of the users to apply the rule to (inactive or disabled)
131
143
*`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.
144
+
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
// 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.
233
255
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
234
-
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `key_type`.
235
-
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `key_type`.
256
+
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `key_type`.
257
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
0 commit comments