files.com 1.1.620 → 1.1.622
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/event_channel.md +147 -0
- data/docs/event_delivery_attempt.md +68 -0
- data/docs/event_record.md +77 -0
- data/docs/event_subscription.md +188 -0
- data/docs/event_target.md +171 -0
- data/docs/external_event.md +3 -19
- data/docs/partner.md +24 -0
- data/docs/pending_work_event.md +60 -0
- data/docs/siem_http_destination_event.md +60 -0
- data/docs/site.md +8 -0
- data/docs/sso_event.md +73 -0
- data/docs/user.md +68 -4
- data/docs/user_lifecycle_rule.md +8 -0
- data/docs/user_security_event.md +58 -0
- data/lib/files.com/models/event_channel.rb +192 -0
- data/lib/files.com/models/event_delivery_attempt.rb +123 -0
- data/lib/files.com/models/event_record.rb +133 -0
- data/lib/files.com/models/event_subscription.rb +265 -0
- data/lib/files.com/models/event_target.rb +237 -0
- data/lib/files.com/models/external_event.rb +2 -74
- data/lib/files.com/models/partner.rb +42 -0
- data/lib/files.com/models/pending_work_event.rb +96 -0
- data/lib/files.com/models/siem_http_destination_event.rb +96 -0
- data/lib/files.com/models/sso_event.rb +128 -0
- data/lib/files.com/models/user.rb +100 -4
- data/lib/files.com/models/user_lifecycle_rule.rb +12 -0
- data/lib/files.com/models/user_security_event.rb +91 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +9 -0
- metadata +20 -2
data/docs/external_event.md
CHANGED
|
@@ -9,15 +9,7 @@
|
|
|
9
9
|
"status": "example",
|
|
10
10
|
"body": "example",
|
|
11
11
|
"created_at": "2000-01-01T01:00:00Z",
|
|
12
|
-
"body_url": "example"
|
|
13
|
-
"folder_behavior_id": 1,
|
|
14
|
-
"siem_http_destination_id": 1,
|
|
15
|
-
"successful_files": 1,
|
|
16
|
-
"errored_files": 1,
|
|
17
|
-
"bytes_synced": 1,
|
|
18
|
-
"compared_files": 1,
|
|
19
|
-
"compared_folders": 1,
|
|
20
|
-
"remote_server_type": "example"
|
|
12
|
+
"body_url": "example"
|
|
21
13
|
}
|
|
22
14
|
```
|
|
23
15
|
|
|
@@ -27,14 +19,6 @@
|
|
|
27
19
|
* `body` (string): Event body
|
|
28
20
|
* `created_at` (date-time): External event create date/time
|
|
29
21
|
* `body_url` (string): Link to log file.
|
|
30
|
-
* `folder_behavior_id` (int64): Folder Behavior ID
|
|
31
|
-
* `siem_http_destination_id` (int64): SIEM HTTP Destination ID.
|
|
32
|
-
* `successful_files` (int64): For sync events, the number of files handled successfully.
|
|
33
|
-
* `errored_files` (int64): For sync events, the number of files that encountered errors.
|
|
34
|
-
* `bytes_synced` (int64): For sync events, the total number of bytes synced.
|
|
35
|
-
* `compared_files` (int64): For sync events, the number of files considered for the sync.
|
|
36
|
-
* `compared_folders` (int64): For sync events, the number of folders listed and considered for the sync.
|
|
37
|
-
* `remote_server_type` (string): Associated Remote Server type, if any
|
|
38
22
|
|
|
39
23
|
|
|
40
24
|
---
|
|
@@ -49,8 +33,8 @@ Files::ExternalEvent.list
|
|
|
49
33
|
|
|
50
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.
|
|
51
35
|
* `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 `
|
|
53
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at
|
|
36
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status` or `event_type`.
|
|
37
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at` and `status`. Valid field combinations are `[ status, created_at ]`.
|
|
54
38
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
55
39
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
56
40
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
data/docs/partner.md
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
"allow_credential_changes": true,
|
|
10
10
|
"allow_providing_gpg_keys": true,
|
|
11
11
|
"allow_user_creation": true,
|
|
12
|
+
"cc_emails_to_responsible_party": true,
|
|
12
13
|
"id": 1,
|
|
13
14
|
"workspace_id": 1,
|
|
14
15
|
"name": "Acme Corp",
|
|
@@ -18,6 +19,8 @@
|
|
|
18
19
|
2,
|
|
19
20
|
3
|
|
20
21
|
],
|
|
22
|
+
"responsible_group_id": 1,
|
|
23
|
+
"responsible_user_id": 1,
|
|
21
24
|
"root_folder": "/AcmeCorp",
|
|
22
25
|
"tags": "example",
|
|
23
26
|
"user_ids": [
|
|
@@ -33,11 +36,14 @@
|
|
|
33
36
|
* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
34
37
|
* `allow_providing_gpg_keys` (boolean): Allow Partner Admins to provide GPG keys.
|
|
35
38
|
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
39
|
+
* `cc_emails_to_responsible_party` (boolean): When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
36
40
|
* `id` (int64): The unique ID of the Partner.
|
|
37
41
|
* `workspace_id` (int64): ID of the Workspace associated with this Partner.
|
|
38
42
|
* `name` (string): The name of the Partner.
|
|
39
43
|
* `notes` (string): Notes about this Partner.
|
|
40
44
|
* `partner_admin_ids` (array(int64)): Array of User IDs that are Partner Admins for this Partner.
|
|
45
|
+
* `responsible_group_id` (int64): ID of the Group responsible for this Partner.
|
|
46
|
+
* `responsible_user_id` (int64): ID of the User responsible for this Partner.
|
|
41
47
|
* `root_folder` (string): The root folder path for this Partner.
|
|
42
48
|
* `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.
|
|
43
49
|
* `user_ids` (array(int64)): Array of User IDs that belong to this Partner.
|
|
@@ -83,7 +89,10 @@ Files::Partner.create(
|
|
|
83
89
|
allow_credential_changes: false,
|
|
84
90
|
allow_providing_gpg_keys: false,
|
|
85
91
|
allow_user_creation: false,
|
|
92
|
+
cc_emails_to_responsible_party: false,
|
|
86
93
|
notes: "This is a note about the partner.",
|
|
94
|
+
responsible_group_id: 1,
|
|
95
|
+
responsible_user_id: 1,
|
|
87
96
|
tags: "example",
|
|
88
97
|
name: "Acme Corp",
|
|
89
98
|
root_folder: "/AcmeCorp",
|
|
@@ -98,7 +107,10 @@ Files::Partner.create(
|
|
|
98
107
|
* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
99
108
|
* `allow_providing_gpg_keys` (boolean): Allow Partner Admins to provide GPG keys.
|
|
100
109
|
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
110
|
+
* `cc_emails_to_responsible_party` (boolean): When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
101
111
|
* `notes` (string): Notes about this Partner.
|
|
112
|
+
* `responsible_group_id` (int64): ID of the Group responsible for this Partner.
|
|
113
|
+
* `responsible_user_id` (int64): ID of the User responsible for this Partner.
|
|
102
114
|
* `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.
|
|
103
115
|
* `name` (string): Required - The name of the Partner.
|
|
104
116
|
* `root_folder` (string): Required - The root folder path for this Partner.
|
|
@@ -116,7 +128,10 @@ Files::Partner.update(id,
|
|
|
116
128
|
allow_credential_changes: false,
|
|
117
129
|
allow_providing_gpg_keys: false,
|
|
118
130
|
allow_user_creation: false,
|
|
131
|
+
cc_emails_to_responsible_party: false,
|
|
119
132
|
notes: "This is a note about the partner.",
|
|
133
|
+
responsible_group_id: 1,
|
|
134
|
+
responsible_user_id: 1,
|
|
120
135
|
tags: "example",
|
|
121
136
|
name: "Acme Corp",
|
|
122
137
|
root_folder: "/AcmeCorp"
|
|
@@ -131,7 +146,10 @@ Files::Partner.update(id,
|
|
|
131
146
|
* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
132
147
|
* `allow_providing_gpg_keys` (boolean): Allow Partner Admins to provide GPG keys.
|
|
133
148
|
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
149
|
+
* `cc_emails_to_responsible_party` (boolean): When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
134
150
|
* `notes` (string): Notes about this Partner.
|
|
151
|
+
* `responsible_group_id` (int64): ID of the Group responsible for this Partner.
|
|
152
|
+
* `responsible_user_id` (int64): ID of the User responsible for this Partner.
|
|
135
153
|
* `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.
|
|
136
154
|
* `name` (string): The name of the Partner.
|
|
137
155
|
* `root_folder` (string): The root folder path for this Partner.
|
|
@@ -163,7 +181,10 @@ partner.update(
|
|
|
163
181
|
allow_credential_changes: false,
|
|
164
182
|
allow_providing_gpg_keys: false,
|
|
165
183
|
allow_user_creation: false,
|
|
184
|
+
cc_emails_to_responsible_party: false,
|
|
166
185
|
notes: "This is a note about the partner.",
|
|
186
|
+
responsible_group_id: 1,
|
|
187
|
+
responsible_user_id: 1,
|
|
167
188
|
tags: "example",
|
|
168
189
|
name: "Acme Corp",
|
|
169
190
|
root_folder: "/AcmeCorp"
|
|
@@ -178,7 +199,10 @@ partner.update(
|
|
|
178
199
|
* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
179
200
|
* `allow_providing_gpg_keys` (boolean): Allow Partner Admins to provide GPG keys.
|
|
180
201
|
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
202
|
+
* `cc_emails_to_responsible_party` (boolean): When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
181
203
|
* `notes` (string): Notes about this Partner.
|
|
204
|
+
* `responsible_group_id` (int64): ID of the Group responsible for this Partner.
|
|
205
|
+
* `responsible_user_id` (int64): ID of the User responsible for this Partner.
|
|
182
206
|
* `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.
|
|
183
207
|
* `name` (string): The name of the Partner.
|
|
184
208
|
* `root_folder` (string): The root folder path for this Partner.
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# PendingWorkEvent
|
|
2
|
+
|
|
3
|
+
## Example PendingWorkEvent Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"event_type": "example",
|
|
9
|
+
"status": "example",
|
|
10
|
+
"body": "example",
|
|
11
|
+
"event_errors": [
|
|
12
|
+
"example"
|
|
13
|
+
],
|
|
14
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
15
|
+
"body_url": "example",
|
|
16
|
+
"folder_behavior_id": 1
|
|
17
|
+
}
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
* `id` (int64): Event ID
|
|
21
|
+
* `event_type` (string): Type of pending work event being recorded.
|
|
22
|
+
* `status` (string): Status of event.
|
|
23
|
+
* `body` (string): Event body.
|
|
24
|
+
* `event_errors` (array(string)): Event errors.
|
|
25
|
+
* `created_at` (date-time): Event create date/time.
|
|
26
|
+
* `body_url` (string): Link to log file.
|
|
27
|
+
* `folder_behavior_id` (int64): Folder Behavior ID.
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## List Pending Work Events
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
Files::PendingWorkEvent.list
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
* `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.
|
|
41
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
42
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status` or `folder_behavior_id`.
|
|
43
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `folder_behavior_id` or `status`. Valid field combinations are `[ folder_behavior_id, created_at ]`, `[ status, created_at ]`, `[ folder_behavior_id, status ]` or `[ folder_behavior_id, status, created_at ]`.
|
|
44
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
45
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
46
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
47
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Show Pending Work Event
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
Files::PendingWorkEvent.find(id)
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Parameters
|
|
59
|
+
|
|
60
|
+
* `id` (int64): Required - Pending Work Event ID.
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# SiemHttpDestinationEvent
|
|
2
|
+
|
|
3
|
+
## Example SiemHttpDestinationEvent Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"event_type": "example",
|
|
9
|
+
"status": "example",
|
|
10
|
+
"body": "example",
|
|
11
|
+
"event_errors": [
|
|
12
|
+
"example"
|
|
13
|
+
],
|
|
14
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
15
|
+
"body_url": "example",
|
|
16
|
+
"siem_http_destination_id": 1
|
|
17
|
+
}
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
* `id` (int64): Event ID
|
|
21
|
+
* `event_type` (string): Type of SIEM event being recorded.
|
|
22
|
+
* `status` (string): Status of event.
|
|
23
|
+
* `body` (string): Event body.
|
|
24
|
+
* `event_errors` (array(string)): Event errors.
|
|
25
|
+
* `created_at` (date-time): Event create date/time.
|
|
26
|
+
* `body_url` (string): Link to log file.
|
|
27
|
+
* `siem_http_destination_id` (int64): SIEM ID.
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## List SIEM HTTP Destination Events
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
Files::SiemHttpDestinationEvent.list
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
* `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.
|
|
41
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
42
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status` or `siem_http_destination_id`.
|
|
43
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `siem_http_destination_id` or `status`. Valid field combinations are `[ siem_http_destination_id, created_at ]`, `[ status, created_at ]`, `[ siem_http_destination_id, status ]` or `[ siem_http_destination_id, status, created_at ]`.
|
|
44
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
45
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
46
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
47
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Show SIEM HTTP Destination Event
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
Files::SiemHttpDestinationEvent.find(id)
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Parameters
|
|
59
|
+
|
|
60
|
+
* `id` (int64): Required - Siem Http Destination Event ID.
|
data/docs/site.md
CHANGED
|
@@ -280,6 +280,14 @@
|
|
|
280
280
|
"primary_group_id": 1,
|
|
281
281
|
"public_keys_count": 1,
|
|
282
282
|
"receive_admin_alerts": true,
|
|
283
|
+
"notify_on_all_site_warnings": true,
|
|
284
|
+
"notify_on_all_sso_failures": true,
|
|
285
|
+
"notify_on_all_user_security_events": true,
|
|
286
|
+
"notify_on_all_pending_work_failures": true,
|
|
287
|
+
"notify_on_all_siem_http_destination_failures": true,
|
|
288
|
+
"notify_on_all_sync_failures": true,
|
|
289
|
+
"notify_on_all_automation_failures": true,
|
|
290
|
+
"notify_on_all_expectation_failures": true,
|
|
283
291
|
"require_2fa": "always_require",
|
|
284
292
|
"require_login_by": "2000-01-01T01:00:00Z",
|
|
285
293
|
"active_2fa": true,
|
data/docs/sso_event.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# SsoEvent
|
|
2
|
+
|
|
3
|
+
## Example SsoEvent Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"event_type": "example",
|
|
9
|
+
"status": "example",
|
|
10
|
+
"body": "example",
|
|
11
|
+
"event_errors": [
|
|
12
|
+
"example"
|
|
13
|
+
],
|
|
14
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
15
|
+
"body_url": "example",
|
|
16
|
+
"user_id": 1,
|
|
17
|
+
"username": "example",
|
|
18
|
+
"idp_uid": "example",
|
|
19
|
+
"provider": "example",
|
|
20
|
+
"provider_label": "example",
|
|
21
|
+
"ip": "example",
|
|
22
|
+
"region": "example"
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
* `id` (int64): Event ID
|
|
27
|
+
* `event_type` (string): Type of SSO event being recorded.
|
|
28
|
+
* `status` (string): Status of event.
|
|
29
|
+
* `body` (string): Event body.
|
|
30
|
+
* `event_errors` (array(string)): Event errors.
|
|
31
|
+
* `created_at` (date-time): Event create date/time.
|
|
32
|
+
* `body_url` (string): Link to log file.
|
|
33
|
+
* `user_id` (int64): User ID.
|
|
34
|
+
* `username` (string): Username on Files.com for the SSO login attempt.
|
|
35
|
+
* `idp_uid` (string): Identity Provider UID for the SSO login attempt.
|
|
36
|
+
* `provider` (string): SSO provider for the SSO login attempt.
|
|
37
|
+
* `provider_label` (string): SSO provider label for the SSO login attempt.
|
|
38
|
+
* `ip` (string): IP address for the SSO login attempt.
|
|
39
|
+
* `region` (string): Region for the SSO login attempt.
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## List SSO Events
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
Files::SsoEvent.list
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Parameters
|
|
51
|
+
|
|
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
|
+
* `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 `created_at`, `event_type`, `status` or `user_id`.
|
|
55
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `idp_uid`, `ip`, `provider`, `status`, `user_id` or `username`. Valid field combinations are `[ event_type, created_at ]`, `[ idp_uid, created_at ]`, `[ ip, created_at ]`, `[ provider, created_at ]`, `[ status, created_at ]`, `[ user_id, created_at ]`, `[ username, created_at ]`, `[ event_type, status ]`, `[ idp_uid, status ]`, `[ ip, status ]`, `[ provider, status ]`, `[ user_id, status ]`, `[ username, status ]`, `[ event_type, status, created_at ]`, `[ idp_uid, status, created_at ]`, `[ ip, status, created_at ]`, `[ provider, status, created_at ]`, `[ user_id, status, created_at ]` or `[ username, status, created_at ]`.
|
|
56
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
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`.
|
|
58
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `idp_uid`, `ip`, `provider` or `username`.
|
|
59
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
60
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Show SSO Event
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
Files::SsoEvent.find(id)
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Parameters
|
|
72
|
+
|
|
73
|
+
* `id` (int64): Required - Sso Event ID.
|
data/docs/user.md
CHANGED
|
@@ -55,6 +55,14 @@
|
|
|
55
55
|
"primary_group_id": 1,
|
|
56
56
|
"public_keys_count": 1,
|
|
57
57
|
"receive_admin_alerts": true,
|
|
58
|
+
"notify_on_all_site_warnings": true,
|
|
59
|
+
"notify_on_all_sso_failures": true,
|
|
60
|
+
"notify_on_all_user_security_events": true,
|
|
61
|
+
"notify_on_all_pending_work_failures": true,
|
|
62
|
+
"notify_on_all_siem_http_destination_failures": true,
|
|
63
|
+
"notify_on_all_sync_failures": true,
|
|
64
|
+
"notify_on_all_automation_failures": true,
|
|
65
|
+
"notify_on_all_expectation_failures": true,
|
|
58
66
|
"require_2fa": "always_require",
|
|
59
67
|
"require_login_by": "2000-01-01T01:00:00Z",
|
|
60
68
|
"active_2fa": true,
|
|
@@ -132,7 +140,15 @@
|
|
|
132
140
|
* `password_validity_days` (int64): Number of days to allow user to use the same password
|
|
133
141
|
* `primary_group_id` (int64): Primary group ID for Group Admin scoping
|
|
134
142
|
* `public_keys_count` (int64): Number of public keys associated with this user
|
|
135
|
-
* `receive_admin_alerts` (boolean):
|
|
143
|
+
* `receive_admin_alerts` (boolean): Deprecated. Use notify_on_all_site_warnings and granular failure notification preferences instead.
|
|
144
|
+
* `notify_on_all_site_warnings` (boolean): Should the user receive site warnings via email?
|
|
145
|
+
* `notify_on_all_sso_failures` (boolean): Should the user receive sso/scim/ldap configuration/sync failures via email?
|
|
146
|
+
* `notify_on_all_user_security_events` (boolean): Should the user receive user security events via email?
|
|
147
|
+
* `notify_on_all_pending_work_failures` (boolean): Should the user receive pending work failures via email?
|
|
148
|
+
* `notify_on_all_siem_http_destination_failures` (boolean): Should the user receive siem failures via email?
|
|
149
|
+
* `notify_on_all_sync_failures` (boolean): Should the user receive sync failures via email?
|
|
150
|
+
* `notify_on_all_automation_failures` (boolean): Should the user receive automation failures via email?
|
|
151
|
+
* `notify_on_all_expectation_failures` (boolean): Should the user receive expectation failures and misses via email?
|
|
136
152
|
* `require_2fa` (string): 2FA required setting
|
|
137
153
|
* `require_login_by` (date-time): Require user to login by specified date otherwise it will be disabled.
|
|
138
154
|
* `active_2fa` (boolean): Is 2fa active for the user?
|
|
@@ -248,6 +264,14 @@ Files::User.create(
|
|
|
248
264
|
primary_group_id: 1,
|
|
249
265
|
readonly_site_admin: true,
|
|
250
266
|
receive_admin_alerts: true,
|
|
267
|
+
notify_on_all_site_warnings: true,
|
|
268
|
+
notify_on_all_sso_failures: true,
|
|
269
|
+
notify_on_all_user_security_events: true,
|
|
270
|
+
notify_on_all_pending_work_failures: true,
|
|
271
|
+
notify_on_all_siem_http_destination_failures: true,
|
|
272
|
+
notify_on_all_sync_failures: true,
|
|
273
|
+
notify_on_all_automation_failures: true,
|
|
274
|
+
notify_on_all_expectation_failures: true,
|
|
251
275
|
require_login_by: "2000-01-01T01:00:00Z",
|
|
252
276
|
require_password_change: true,
|
|
253
277
|
restapi_permission: true,
|
|
@@ -307,7 +331,15 @@ Files::User.create(
|
|
|
307
331
|
* `password_validity_days` (int64): Number of days to allow user to use the same password
|
|
308
332
|
* `primary_group_id` (int64): Primary group ID for Group Admin scoping
|
|
309
333
|
* `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
310
|
-
* `receive_admin_alerts` (boolean):
|
|
334
|
+
* `receive_admin_alerts` (boolean): Deprecated. Use notify_on_all_site_warnings and granular failure notification preferences instead.
|
|
335
|
+
* `notify_on_all_site_warnings` (boolean): Should the user receive site warnings via email?
|
|
336
|
+
* `notify_on_all_sso_failures` (boolean): Should the user receive sso/scim/ldap configuration/sync failures via email?
|
|
337
|
+
* `notify_on_all_user_security_events` (boolean): Should the user receive user security events via email?
|
|
338
|
+
* `notify_on_all_pending_work_failures` (boolean): Should the user receive pending work failures via email?
|
|
339
|
+
* `notify_on_all_siem_http_destination_failures` (boolean): Should the user receive siem failures via email?
|
|
340
|
+
* `notify_on_all_sync_failures` (boolean): Should the user receive sync failures via email?
|
|
341
|
+
* `notify_on_all_automation_failures` (boolean): Should the user receive automation failures via email?
|
|
342
|
+
* `notify_on_all_expectation_failures` (boolean): Should the user receive expectation failures and misses via email?
|
|
311
343
|
* `require_login_by` (string): Require user to login by specified date otherwise it will be disabled.
|
|
312
344
|
* `require_password_change` (boolean): Is a password change required upon next user login?
|
|
313
345
|
* `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.)
|
|
@@ -403,6 +435,14 @@ Files::User.update(id,
|
|
|
403
435
|
primary_group_id: 1,
|
|
404
436
|
readonly_site_admin: true,
|
|
405
437
|
receive_admin_alerts: true,
|
|
438
|
+
notify_on_all_site_warnings: true,
|
|
439
|
+
notify_on_all_sso_failures: true,
|
|
440
|
+
notify_on_all_user_security_events: true,
|
|
441
|
+
notify_on_all_pending_work_failures: true,
|
|
442
|
+
notify_on_all_siem_http_destination_failures: true,
|
|
443
|
+
notify_on_all_sync_failures: true,
|
|
444
|
+
notify_on_all_automation_failures: true,
|
|
445
|
+
notify_on_all_expectation_failures: true,
|
|
406
446
|
require_login_by: "2000-01-01T01:00:00Z",
|
|
407
447
|
require_password_change: true,
|
|
408
448
|
restapi_permission: true,
|
|
@@ -464,7 +504,15 @@ Files::User.update(id,
|
|
|
464
504
|
* `password_validity_days` (int64): Number of days to allow user to use the same password
|
|
465
505
|
* `primary_group_id` (int64): Primary group ID for Group Admin scoping
|
|
466
506
|
* `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
467
|
-
* `receive_admin_alerts` (boolean):
|
|
507
|
+
* `receive_admin_alerts` (boolean): Deprecated. Use notify_on_all_site_warnings and granular failure notification preferences instead.
|
|
508
|
+
* `notify_on_all_site_warnings` (boolean): Should the user receive site warnings via email?
|
|
509
|
+
* `notify_on_all_sso_failures` (boolean): Should the user receive sso/scim/ldap configuration/sync failures via email?
|
|
510
|
+
* `notify_on_all_user_security_events` (boolean): Should the user receive user security events via email?
|
|
511
|
+
* `notify_on_all_pending_work_failures` (boolean): Should the user receive pending work failures via email?
|
|
512
|
+
* `notify_on_all_siem_http_destination_failures` (boolean): Should the user receive siem failures via email?
|
|
513
|
+
* `notify_on_all_sync_failures` (boolean): Should the user receive sync failures via email?
|
|
514
|
+
* `notify_on_all_automation_failures` (boolean): Should the user receive automation failures via email?
|
|
515
|
+
* `notify_on_all_expectation_failures` (boolean): Should the user receive expectation failures and misses via email?
|
|
468
516
|
* `require_login_by` (string): Require user to login by specified date otherwise it will be disabled.
|
|
469
517
|
* `require_password_change` (boolean): Is a password change required upon next user login?
|
|
470
518
|
* `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.)
|
|
@@ -585,6 +633,14 @@ user.update(
|
|
|
585
633
|
primary_group_id: 1,
|
|
586
634
|
readonly_site_admin: true,
|
|
587
635
|
receive_admin_alerts: true,
|
|
636
|
+
notify_on_all_site_warnings: true,
|
|
637
|
+
notify_on_all_sso_failures: true,
|
|
638
|
+
notify_on_all_user_security_events: true,
|
|
639
|
+
notify_on_all_pending_work_failures: true,
|
|
640
|
+
notify_on_all_siem_http_destination_failures: true,
|
|
641
|
+
notify_on_all_sync_failures: true,
|
|
642
|
+
notify_on_all_automation_failures: true,
|
|
643
|
+
notify_on_all_expectation_failures: true,
|
|
588
644
|
require_login_by: "2000-01-01T01:00:00Z",
|
|
589
645
|
require_password_change: true,
|
|
590
646
|
restapi_permission: true,
|
|
@@ -646,7 +702,15 @@ user.update(
|
|
|
646
702
|
* `password_validity_days` (int64): Number of days to allow user to use the same password
|
|
647
703
|
* `primary_group_id` (int64): Primary group ID for Group Admin scoping
|
|
648
704
|
* `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
649
|
-
* `receive_admin_alerts` (boolean):
|
|
705
|
+
* `receive_admin_alerts` (boolean): Deprecated. Use notify_on_all_site_warnings and granular failure notification preferences instead.
|
|
706
|
+
* `notify_on_all_site_warnings` (boolean): Should the user receive site warnings via email?
|
|
707
|
+
* `notify_on_all_sso_failures` (boolean): Should the user receive sso/scim/ldap configuration/sync failures via email?
|
|
708
|
+
* `notify_on_all_user_security_events` (boolean): Should the user receive user security events via email?
|
|
709
|
+
* `notify_on_all_pending_work_failures` (boolean): Should the user receive pending work failures via email?
|
|
710
|
+
* `notify_on_all_siem_http_destination_failures` (boolean): Should the user receive siem failures via email?
|
|
711
|
+
* `notify_on_all_sync_failures` (boolean): Should the user receive sync failures via email?
|
|
712
|
+
* `notify_on_all_automation_failures` (boolean): Should the user receive automation failures via email?
|
|
713
|
+
* `notify_on_all_expectation_failures` (boolean): Should the user receive expectation failures and misses via email?
|
|
650
714
|
* `require_login_by` (string): Require user to login by specified date otherwise it will be disabled.
|
|
651
715
|
* `require_password_change` (boolean): Is a password change required upon next user login?
|
|
652
716
|
* `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.)
|
data/docs/user_lifecycle_rule.md
CHANGED
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
"include_site_admins": true,
|
|
18
18
|
"apply_to_all_workspaces": true,
|
|
19
19
|
"name": "password specific rules",
|
|
20
|
+
"notify_users": true,
|
|
20
21
|
"partner_tag": "guest",
|
|
21
22
|
"site_id": 1,
|
|
22
23
|
"workspace_id": 12,
|
|
@@ -34,6 +35,7 @@
|
|
|
34
35
|
* `include_site_admins` (boolean): If true, the rule will apply to site admins.
|
|
35
36
|
* `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to users in all workspaces.
|
|
36
37
|
* `name` (string): User Lifecycle Rule name
|
|
38
|
+
* `notify_users` (boolean): If true, users will be emailed before the rule disables or deletes them.
|
|
37
39
|
* `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.
|
|
38
40
|
* `site_id` (int64): Site ID
|
|
39
41
|
* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
|
|
@@ -83,6 +85,7 @@ Files::UserLifecycleRule.create(
|
|
|
83
85
|
include_site_admins: true,
|
|
84
86
|
include_folder_admins: true,
|
|
85
87
|
name: "password specific rules",
|
|
88
|
+
notify_users: true,
|
|
86
89
|
partner_tag: "guest",
|
|
87
90
|
user_state: "inactive",
|
|
88
91
|
user_tag: "guest",
|
|
@@ -100,6 +103,7 @@ Files::UserLifecycleRule.create(
|
|
|
100
103
|
* `include_site_admins` (boolean): If true, the rule will apply to site admins.
|
|
101
104
|
* `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
|
|
102
105
|
* `name` (string): User Lifecycle Rule name
|
|
106
|
+
* `notify_users` (boolean): If true, users will be emailed before the rule disables or deletes them.
|
|
103
107
|
* `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.
|
|
104
108
|
* `user_state` (string): State of the users to apply the rule to (inactive or disabled)
|
|
105
109
|
* `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,6 +123,7 @@ Files::UserLifecycleRule.update(id,
|
|
|
119
123
|
include_site_admins: true,
|
|
120
124
|
include_folder_admins: true,
|
|
121
125
|
name: "password specific rules",
|
|
126
|
+
notify_users: true,
|
|
122
127
|
partner_tag: "guest",
|
|
123
128
|
user_state: "inactive",
|
|
124
129
|
user_tag: "guest",
|
|
@@ -137,6 +142,7 @@ Files::UserLifecycleRule.update(id,
|
|
|
137
142
|
* `include_site_admins` (boolean): If true, the rule will apply to site admins.
|
|
138
143
|
* `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
|
|
139
144
|
* `name` (string): User Lifecycle Rule name
|
|
145
|
+
* `notify_users` (boolean): If true, users will be emailed before the rule disables or deletes them.
|
|
140
146
|
* `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.
|
|
141
147
|
* `user_state` (string): State of the users to apply the rule to (inactive or disabled)
|
|
142
148
|
* `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.
|
|
@@ -171,6 +177,7 @@ user_lifecycle_rule.update(
|
|
|
171
177
|
include_site_admins: true,
|
|
172
178
|
include_folder_admins: true,
|
|
173
179
|
name: "password specific rules",
|
|
180
|
+
notify_users: true,
|
|
174
181
|
partner_tag: "guest",
|
|
175
182
|
user_state: "inactive",
|
|
176
183
|
user_tag: "guest",
|
|
@@ -189,6 +196,7 @@ user_lifecycle_rule.update(
|
|
|
189
196
|
* `include_site_admins` (boolean): If true, the rule will apply to site admins.
|
|
190
197
|
* `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
|
|
191
198
|
* `name` (string): User Lifecycle Rule name
|
|
199
|
+
* `notify_users` (boolean): If true, users will be emailed before the rule disables or deletes them.
|
|
192
200
|
* `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.
|
|
193
201
|
* `user_state` (string): State of the users to apply the rule to (inactive or disabled)
|
|
194
202
|
* `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.
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# UserSecurityEvent
|
|
2
|
+
|
|
3
|
+
## Example UserSecurityEvent Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"event_type": "example",
|
|
9
|
+
"body": "example",
|
|
10
|
+
"event_errors": [
|
|
11
|
+
"example"
|
|
12
|
+
],
|
|
13
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
14
|
+
"body_url": "example",
|
|
15
|
+
"user_id": 1
|
|
16
|
+
}
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
* `id` (int64): Event ID
|
|
20
|
+
* `event_type` (string): Type of user security event being recorded.
|
|
21
|
+
* `body` (string): Event body.
|
|
22
|
+
* `event_errors` (array(string)): Event errors.
|
|
23
|
+
* `created_at` (date-time): Event create date/time.
|
|
24
|
+
* `body_url` (string): Link to log file.
|
|
25
|
+
* `user_id` (int64): User ID.
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## List User Security Events
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
Files::UserSecurityEvent.list
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
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
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
40
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at` and `user_id`.
|
|
41
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at` and `user_id`. Valid field combinations are `[ user_id, created_at ]`.
|
|
42
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
43
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
44
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
45
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## Show User Security Event
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
Files::UserSecurityEvent.find(id)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Parameters
|
|
57
|
+
|
|
58
|
+
* `id` (int64): Required - User Security Event ID.
|