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
|
@@ -54,6 +54,15 @@ module Files
|
|
|
54
54
|
@attributes[:allow_user_creation] = value
|
|
55
55
|
end
|
|
56
56
|
|
|
57
|
+
# boolean - When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
58
|
+
def cc_emails_to_responsible_party
|
|
59
|
+
@attributes[:cc_emails_to_responsible_party]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def cc_emails_to_responsible_party=(value)
|
|
63
|
+
@attributes[:cc_emails_to_responsible_party] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
57
66
|
# int64 - The unique ID of the Partner.
|
|
58
67
|
def id
|
|
59
68
|
@attributes[:id]
|
|
@@ -99,6 +108,24 @@ module Files
|
|
|
99
108
|
@attributes[:partner_admin_ids] = value
|
|
100
109
|
end
|
|
101
110
|
|
|
111
|
+
# int64 - ID of the Group responsible for this Partner.
|
|
112
|
+
def responsible_group_id
|
|
113
|
+
@attributes[:responsible_group_id]
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
def responsible_group_id=(value)
|
|
117
|
+
@attributes[:responsible_group_id] = value
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# int64 - ID of the User responsible for this Partner.
|
|
121
|
+
def responsible_user_id
|
|
122
|
+
@attributes[:responsible_user_id]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def responsible_user_id=(value)
|
|
126
|
+
@attributes[:responsible_user_id] = value
|
|
127
|
+
end
|
|
128
|
+
|
|
102
129
|
# string - The root folder path for this Partner.
|
|
103
130
|
def root_folder
|
|
104
131
|
@attributes[:root_folder]
|
|
@@ -132,7 +159,10 @@ module Files
|
|
|
132
159
|
# allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
133
160
|
# allow_providing_gpg_keys - boolean - Allow Partner Admins to provide GPG keys.
|
|
134
161
|
# allow_user_creation - boolean - Allow Partner Admins to create users.
|
|
162
|
+
# cc_emails_to_responsible_party - boolean - When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
135
163
|
# notes - string - Notes about this Partner.
|
|
164
|
+
# responsible_group_id - int64 - ID of the Group responsible for this Partner.
|
|
165
|
+
# responsible_user_id - int64 - ID of the User responsible for this Partner.
|
|
136
166
|
# 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.
|
|
137
167
|
# name - string - The name of the Partner.
|
|
138
168
|
# root_folder - string - The root folder path for this Partner.
|
|
@@ -143,6 +173,8 @@ module Files
|
|
|
143
173
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
144
174
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
145
175
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
176
|
+
raise InvalidParameterError.new("Bad parameter: responsible_group_id must be an Integer") if params[:responsible_group_id] and !params[:responsible_group_id].is_a?(Integer)
|
|
177
|
+
raise InvalidParameterError.new("Bad parameter: responsible_user_id must be an Integer") if params[:responsible_user_id] and !params[:responsible_user_id].is_a?(Integer)
|
|
146
178
|
raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
|
|
147
179
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
148
180
|
raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
|
|
@@ -219,7 +251,10 @@ module Files
|
|
|
219
251
|
# allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
220
252
|
# allow_providing_gpg_keys - boolean - Allow Partner Admins to provide GPG keys.
|
|
221
253
|
# allow_user_creation - boolean - Allow Partner Admins to create users.
|
|
254
|
+
# cc_emails_to_responsible_party - boolean - When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
222
255
|
# notes - string - Notes about this Partner.
|
|
256
|
+
# responsible_group_id - int64 - ID of the Group responsible for this Partner.
|
|
257
|
+
# responsible_user_id - int64 - ID of the User responsible for this Partner.
|
|
223
258
|
# 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.
|
|
224
259
|
# name (required) - string - The name of the Partner.
|
|
225
260
|
# root_folder (required) - string - The root folder path for this Partner.
|
|
@@ -227,6 +262,8 @@ module Files
|
|
|
227
262
|
def self.create(params = {}, options = {})
|
|
228
263
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
229
264
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
265
|
+
raise InvalidParameterError.new("Bad parameter: responsible_group_id must be an Integer") if params[:responsible_group_id] and !params[:responsible_group_id].is_a?(Integer)
|
|
266
|
+
raise InvalidParameterError.new("Bad parameter: responsible_user_id must be an Integer") if params[:responsible_user_id] and !params[:responsible_user_id].is_a?(Integer)
|
|
230
267
|
raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
|
|
231
268
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
232
269
|
raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
|
|
@@ -244,7 +281,10 @@ module Files
|
|
|
244
281
|
# allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
245
282
|
# allow_providing_gpg_keys - boolean - Allow Partner Admins to provide GPG keys.
|
|
246
283
|
# allow_user_creation - boolean - Allow Partner Admins to create users.
|
|
284
|
+
# cc_emails_to_responsible_party - boolean - When `true`, emails sent to Partner users are copied to the responsible User or Group.
|
|
247
285
|
# notes - string - Notes about this Partner.
|
|
286
|
+
# responsible_group_id - int64 - ID of the Group responsible for this Partner.
|
|
287
|
+
# responsible_user_id - int64 - ID of the User responsible for this Partner.
|
|
248
288
|
# 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.
|
|
249
289
|
# name - string - The name of the Partner.
|
|
250
290
|
# root_folder - string - The root folder path for this Partner.
|
|
@@ -254,6 +294,8 @@ module Files
|
|
|
254
294
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
255
295
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
256
296
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
297
|
+
raise InvalidParameterError.new("Bad parameter: responsible_group_id must be an Integer") if params[:responsible_group_id] and !params[:responsible_group_id].is_a?(Integer)
|
|
298
|
+
raise InvalidParameterError.new("Bad parameter: responsible_user_id must be an Integer") if params[:responsible_user_id] and !params[:responsible_user_id].is_a?(Integer)
|
|
257
299
|
raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
|
|
258
300
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
259
301
|
raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class PendingWorkEvent
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# int64 - Event ID
|
|
13
|
+
def id
|
|
14
|
+
@attributes[:id]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# string - Type of pending work event being recorded.
|
|
18
|
+
def event_type
|
|
19
|
+
@attributes[:event_type]
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# string - Status of event.
|
|
23
|
+
def status
|
|
24
|
+
@attributes[:status]
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# string - Event body.
|
|
28
|
+
def body
|
|
29
|
+
@attributes[:body]
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# array(string) - Event errors.
|
|
33
|
+
def event_errors
|
|
34
|
+
@attributes[:event_errors]
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# date-time - Event create date/time.
|
|
38
|
+
def created_at
|
|
39
|
+
@attributes[:created_at]
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# string - Link to log file.
|
|
43
|
+
def body_url
|
|
44
|
+
@attributes[:body_url]
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# int64 - Folder Behavior ID.
|
|
48
|
+
def folder_behavior_id
|
|
49
|
+
@attributes[:folder_behavior_id]
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# Parameters:
|
|
53
|
+
# 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.
|
|
54
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
55
|
+
# 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`.
|
|
56
|
+
# 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 ]`.
|
|
57
|
+
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
58
|
+
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
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
|
+
def self.list(params = {}, options = {})
|
|
62
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
63
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
64
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
65
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
66
|
+
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
|
|
67
|
+
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
|
|
68
|
+
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
|
|
69
|
+
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
|
|
70
|
+
|
|
71
|
+
List.new(PendingWorkEvent, params) do
|
|
72
|
+
Api.send_request("/pending_work_events", :get, params, options)
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
def self.all(params = {}, options = {})
|
|
77
|
+
list(params, options)
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Parameters:
|
|
81
|
+
# id (required) - int64 - Pending Work Event ID.
|
|
82
|
+
def self.find(id, params = {}, options = {})
|
|
83
|
+
params ||= {}
|
|
84
|
+
params[:id] = id
|
|
85
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
86
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
87
|
+
|
|
88
|
+
response, options = Api.send_request("/pending_work_events/#{params[:id]}", :get, params, options)
|
|
89
|
+
PendingWorkEvent.new(response.data, options)
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
def self.get(id, params = {}, options = {})
|
|
93
|
+
find(id, params, options)
|
|
94
|
+
end
|
|
95
|
+
end
|
|
96
|
+
end
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class SiemHttpDestinationEvent
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# int64 - Event ID
|
|
13
|
+
def id
|
|
14
|
+
@attributes[:id]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# string - Type of SIEM event being recorded.
|
|
18
|
+
def event_type
|
|
19
|
+
@attributes[:event_type]
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# string - Status of event.
|
|
23
|
+
def status
|
|
24
|
+
@attributes[:status]
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# string - Event body.
|
|
28
|
+
def body
|
|
29
|
+
@attributes[:body]
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# array(string) - Event errors.
|
|
33
|
+
def event_errors
|
|
34
|
+
@attributes[:event_errors]
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# date-time - Event create date/time.
|
|
38
|
+
def created_at
|
|
39
|
+
@attributes[:created_at]
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# string - Link to log file.
|
|
43
|
+
def body_url
|
|
44
|
+
@attributes[:body_url]
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# int64 - SIEM ID.
|
|
48
|
+
def siem_http_destination_id
|
|
49
|
+
@attributes[:siem_http_destination_id]
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# Parameters:
|
|
53
|
+
# 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.
|
|
54
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
55
|
+
# 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`.
|
|
56
|
+
# 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 ]`.
|
|
57
|
+
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
58
|
+
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
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
|
+
def self.list(params = {}, options = {})
|
|
62
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
63
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
64
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
65
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
66
|
+
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
|
|
67
|
+
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
|
|
68
|
+
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
|
|
69
|
+
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
|
|
70
|
+
|
|
71
|
+
List.new(SiemHttpDestinationEvent, params) do
|
|
72
|
+
Api.send_request("/siem_http_destination_events", :get, params, options)
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
def self.all(params = {}, options = {})
|
|
77
|
+
list(params, options)
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Parameters:
|
|
81
|
+
# id (required) - int64 - Siem Http Destination Event ID.
|
|
82
|
+
def self.find(id, params = {}, options = {})
|
|
83
|
+
params ||= {}
|
|
84
|
+
params[:id] = id
|
|
85
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
86
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
87
|
+
|
|
88
|
+
response, options = Api.send_request("/siem_http_destination_events/#{params[:id]}", :get, params, options)
|
|
89
|
+
SiemHttpDestinationEvent.new(response.data, options)
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
def self.get(id, params = {}, options = {})
|
|
93
|
+
find(id, params, options)
|
|
94
|
+
end
|
|
95
|
+
end
|
|
96
|
+
end
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class SsoEvent
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# int64 - Event ID
|
|
13
|
+
def id
|
|
14
|
+
@attributes[:id]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# string - Type of SSO event being recorded.
|
|
18
|
+
def event_type
|
|
19
|
+
@attributes[:event_type]
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# string - Status of event.
|
|
23
|
+
def status
|
|
24
|
+
@attributes[:status]
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# string - Event body.
|
|
28
|
+
def body
|
|
29
|
+
@attributes[:body]
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# array(string) - Event errors.
|
|
33
|
+
def event_errors
|
|
34
|
+
@attributes[:event_errors]
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# date-time - Event create date/time.
|
|
38
|
+
def created_at
|
|
39
|
+
@attributes[:created_at]
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# string - Link to log file.
|
|
43
|
+
def body_url
|
|
44
|
+
@attributes[:body_url]
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# int64 - User ID.
|
|
48
|
+
def user_id
|
|
49
|
+
@attributes[:user_id]
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# string - Username on Files.com for the SSO login attempt.
|
|
53
|
+
def username
|
|
54
|
+
@attributes[:username]
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# string - Identity Provider UID for the SSO login attempt.
|
|
58
|
+
def idp_uid
|
|
59
|
+
@attributes[:idp_uid]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# string - SSO provider for the SSO login attempt.
|
|
63
|
+
def provider
|
|
64
|
+
@attributes[:provider]
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# string - SSO provider label for the SSO login attempt.
|
|
68
|
+
def provider_label
|
|
69
|
+
@attributes[:provider_label]
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# string - IP address for the SSO login attempt.
|
|
73
|
+
def ip
|
|
74
|
+
@attributes[:ip]
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
# string - Region for the SSO login attempt.
|
|
78
|
+
def region
|
|
79
|
+
@attributes[:region]
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# Parameters:
|
|
83
|
+
# 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.
|
|
84
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
85
|
+
# 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`.
|
|
86
|
+
# 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 ]`.
|
|
87
|
+
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
88
|
+
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
89
|
+
# 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`.
|
|
90
|
+
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
91
|
+
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
92
|
+
def self.list(params = {}, options = {})
|
|
93
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
94
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
95
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
96
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
97
|
+
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
|
|
98
|
+
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
|
|
99
|
+
raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
|
|
100
|
+
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
|
|
101
|
+
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
|
|
102
|
+
|
|
103
|
+
List.new(SsoEvent, params) do
|
|
104
|
+
Api.send_request("/sso_events", :get, params, options)
|
|
105
|
+
end
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
def self.all(params = {}, options = {})
|
|
109
|
+
list(params, options)
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
# Parameters:
|
|
113
|
+
# id (required) - int64 - Sso Event ID.
|
|
114
|
+
def self.find(id, params = {}, options = {})
|
|
115
|
+
params ||= {}
|
|
116
|
+
params[:id] = id
|
|
117
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
118
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
119
|
+
|
|
120
|
+
response, options = Api.send_request("/sso_events/#{params[:id]}", :get, params, options)
|
|
121
|
+
SsoEvent.new(response.data, options)
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
def self.get(id, params = {}, options = {})
|
|
125
|
+
find(id, params, options)
|
|
126
|
+
end
|
|
127
|
+
end
|
|
128
|
+
end
|
|
@@ -437,7 +437,7 @@ module Files
|
|
|
437
437
|
@attributes[:public_keys_count] = value
|
|
438
438
|
end
|
|
439
439
|
|
|
440
|
-
# boolean -
|
|
440
|
+
# boolean - Deprecated. Use notify_on_all_site_warnings and granular failure notification preferences instead.
|
|
441
441
|
def receive_admin_alerts
|
|
442
442
|
@attributes[:receive_admin_alerts]
|
|
443
443
|
end
|
|
@@ -446,6 +446,78 @@ module Files
|
|
|
446
446
|
@attributes[:receive_admin_alerts] = value
|
|
447
447
|
end
|
|
448
448
|
|
|
449
|
+
# boolean - Should the user receive site warnings via email?
|
|
450
|
+
def notify_on_all_site_warnings
|
|
451
|
+
@attributes[:notify_on_all_site_warnings]
|
|
452
|
+
end
|
|
453
|
+
|
|
454
|
+
def notify_on_all_site_warnings=(value)
|
|
455
|
+
@attributes[:notify_on_all_site_warnings] = value
|
|
456
|
+
end
|
|
457
|
+
|
|
458
|
+
# boolean - Should the user receive sso/scim/ldap configuration/sync failures via email?
|
|
459
|
+
def notify_on_all_sso_failures
|
|
460
|
+
@attributes[:notify_on_all_sso_failures]
|
|
461
|
+
end
|
|
462
|
+
|
|
463
|
+
def notify_on_all_sso_failures=(value)
|
|
464
|
+
@attributes[:notify_on_all_sso_failures] = value
|
|
465
|
+
end
|
|
466
|
+
|
|
467
|
+
# boolean - Should the user receive user security events via email?
|
|
468
|
+
def notify_on_all_user_security_events
|
|
469
|
+
@attributes[:notify_on_all_user_security_events]
|
|
470
|
+
end
|
|
471
|
+
|
|
472
|
+
def notify_on_all_user_security_events=(value)
|
|
473
|
+
@attributes[:notify_on_all_user_security_events] = value
|
|
474
|
+
end
|
|
475
|
+
|
|
476
|
+
# boolean - Should the user receive pending work failures via email?
|
|
477
|
+
def notify_on_all_pending_work_failures
|
|
478
|
+
@attributes[:notify_on_all_pending_work_failures]
|
|
479
|
+
end
|
|
480
|
+
|
|
481
|
+
def notify_on_all_pending_work_failures=(value)
|
|
482
|
+
@attributes[:notify_on_all_pending_work_failures] = value
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
# boolean - Should the user receive siem failures via email?
|
|
486
|
+
def notify_on_all_siem_http_destination_failures
|
|
487
|
+
@attributes[:notify_on_all_siem_http_destination_failures]
|
|
488
|
+
end
|
|
489
|
+
|
|
490
|
+
def notify_on_all_siem_http_destination_failures=(value)
|
|
491
|
+
@attributes[:notify_on_all_siem_http_destination_failures] = value
|
|
492
|
+
end
|
|
493
|
+
|
|
494
|
+
# boolean - Should the user receive sync failures via email?
|
|
495
|
+
def notify_on_all_sync_failures
|
|
496
|
+
@attributes[:notify_on_all_sync_failures]
|
|
497
|
+
end
|
|
498
|
+
|
|
499
|
+
def notify_on_all_sync_failures=(value)
|
|
500
|
+
@attributes[:notify_on_all_sync_failures] = value
|
|
501
|
+
end
|
|
502
|
+
|
|
503
|
+
# boolean - Should the user receive automation failures via email?
|
|
504
|
+
def notify_on_all_automation_failures
|
|
505
|
+
@attributes[:notify_on_all_automation_failures]
|
|
506
|
+
end
|
|
507
|
+
|
|
508
|
+
def notify_on_all_automation_failures=(value)
|
|
509
|
+
@attributes[:notify_on_all_automation_failures] = value
|
|
510
|
+
end
|
|
511
|
+
|
|
512
|
+
# boolean - Should the user receive expectation failures and misses via email?
|
|
513
|
+
def notify_on_all_expectation_failures
|
|
514
|
+
@attributes[:notify_on_all_expectation_failures]
|
|
515
|
+
end
|
|
516
|
+
|
|
517
|
+
def notify_on_all_expectation_failures=(value)
|
|
518
|
+
@attributes[:notify_on_all_expectation_failures] = value
|
|
519
|
+
end
|
|
520
|
+
|
|
449
521
|
# string - 2FA required setting
|
|
450
522
|
def require_2fa
|
|
451
523
|
@attributes[:require_2fa]
|
|
@@ -858,7 +930,15 @@ module Files
|
|
|
858
930
|
# password_validity_days - int64 - Number of days to allow user to use the same password
|
|
859
931
|
# primary_group_id - int64 - Primary group ID for Group Admin scoping
|
|
860
932
|
# readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
861
|
-
# receive_admin_alerts - boolean -
|
|
933
|
+
# receive_admin_alerts - boolean - Deprecated. Use notify_on_all_site_warnings and granular failure notification preferences instead.
|
|
934
|
+
# notify_on_all_site_warnings - boolean - Should the user receive site warnings via email?
|
|
935
|
+
# notify_on_all_sso_failures - boolean - Should the user receive sso/scim/ldap configuration/sync failures via email?
|
|
936
|
+
# notify_on_all_user_security_events - boolean - Should the user receive user security events via email?
|
|
937
|
+
# notify_on_all_pending_work_failures - boolean - Should the user receive pending work failures via email?
|
|
938
|
+
# notify_on_all_siem_http_destination_failures - boolean - Should the user receive siem failures via email?
|
|
939
|
+
# notify_on_all_sync_failures - boolean - Should the user receive sync failures via email?
|
|
940
|
+
# notify_on_all_automation_failures - boolean - Should the user receive automation failures via email?
|
|
941
|
+
# notify_on_all_expectation_failures - boolean - Should the user receive expectation failures and misses via email?
|
|
862
942
|
# require_login_by - string - Require user to login by specified date otherwise it will be disabled.
|
|
863
943
|
# require_password_change - boolean - Is a password change required upon next user login?
|
|
864
944
|
# 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.)
|
|
@@ -1037,7 +1117,15 @@ module Files
|
|
|
1037
1117
|
# password_validity_days - int64 - Number of days to allow user to use the same password
|
|
1038
1118
|
# primary_group_id - int64 - Primary group ID for Group Admin scoping
|
|
1039
1119
|
# readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
1040
|
-
# receive_admin_alerts - boolean -
|
|
1120
|
+
# receive_admin_alerts - boolean - Deprecated. Use notify_on_all_site_warnings and granular failure notification preferences instead.
|
|
1121
|
+
# notify_on_all_site_warnings - boolean - Should the user receive site warnings via email?
|
|
1122
|
+
# notify_on_all_sso_failures - boolean - Should the user receive sso/scim/ldap configuration/sync failures via email?
|
|
1123
|
+
# notify_on_all_user_security_events - boolean - Should the user receive user security events via email?
|
|
1124
|
+
# notify_on_all_pending_work_failures - boolean - Should the user receive pending work failures via email?
|
|
1125
|
+
# notify_on_all_siem_http_destination_failures - boolean - Should the user receive siem failures via email?
|
|
1126
|
+
# notify_on_all_sync_failures - boolean - Should the user receive sync failures via email?
|
|
1127
|
+
# notify_on_all_automation_failures - boolean - Should the user receive automation failures via email?
|
|
1128
|
+
# notify_on_all_expectation_failures - boolean - Should the user receive expectation failures and misses via email?
|
|
1041
1129
|
# require_login_by - string - Require user to login by specified date otherwise it will be disabled.
|
|
1042
1130
|
# require_password_change - boolean - Is a password change required upon next user login?
|
|
1043
1131
|
# 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.)
|
|
@@ -1166,7 +1254,15 @@ module Files
|
|
|
1166
1254
|
# password_validity_days - int64 - Number of days to allow user to use the same password
|
|
1167
1255
|
# primary_group_id - int64 - Primary group ID for Group Admin scoping
|
|
1168
1256
|
# readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
1169
|
-
# receive_admin_alerts - boolean -
|
|
1257
|
+
# receive_admin_alerts - boolean - Deprecated. Use notify_on_all_site_warnings and granular failure notification preferences instead.
|
|
1258
|
+
# notify_on_all_site_warnings - boolean - Should the user receive site warnings via email?
|
|
1259
|
+
# notify_on_all_sso_failures - boolean - Should the user receive sso/scim/ldap configuration/sync failures via email?
|
|
1260
|
+
# notify_on_all_user_security_events - boolean - Should the user receive user security events via email?
|
|
1261
|
+
# notify_on_all_pending_work_failures - boolean - Should the user receive pending work failures via email?
|
|
1262
|
+
# notify_on_all_siem_http_destination_failures - boolean - Should the user receive siem failures via email?
|
|
1263
|
+
# notify_on_all_sync_failures - boolean - Should the user receive sync failures via email?
|
|
1264
|
+
# notify_on_all_automation_failures - boolean - Should the user receive automation failures via email?
|
|
1265
|
+
# notify_on_all_expectation_failures - boolean - Should the user receive expectation failures and misses via email?
|
|
1170
1266
|
# require_login_by - string - Require user to login by specified date otherwise it will be disabled.
|
|
1171
1267
|
# require_password_change - boolean - Is a password change required upon next user login?
|
|
1172
1268
|
# 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.)
|
|
@@ -90,6 +90,15 @@ module Files
|
|
|
90
90
|
@attributes[:name] = value
|
|
91
91
|
end
|
|
92
92
|
|
|
93
|
+
# boolean - If true, users will be emailed before the rule disables or deletes them.
|
|
94
|
+
def notify_users
|
|
95
|
+
@attributes[:notify_users]
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
def notify_users=(value)
|
|
99
|
+
@attributes[:notify_users] = value
|
|
100
|
+
end
|
|
101
|
+
|
|
93
102
|
# 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.
|
|
94
103
|
def partner_tag
|
|
95
104
|
@attributes[:partner_tag]
|
|
@@ -144,6 +153,7 @@ module Files
|
|
|
144
153
|
# include_site_admins - boolean - If true, the rule will apply to site admins.
|
|
145
154
|
# include_folder_admins - boolean - If true, the rule will apply to folder admins.
|
|
146
155
|
# name - string - User Lifecycle Rule name
|
|
156
|
+
# notify_users - boolean - If true, users will be emailed before the rule disables or deletes them.
|
|
147
157
|
# 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.
|
|
148
158
|
# user_state - string - State of the users to apply the rule to (inactive or disabled)
|
|
149
159
|
# 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.
|
|
@@ -238,6 +248,7 @@ module Files
|
|
|
238
248
|
# include_site_admins - boolean - If true, the rule will apply to site admins.
|
|
239
249
|
# include_folder_admins - boolean - If true, the rule will apply to folder admins.
|
|
240
250
|
# name - string - User Lifecycle Rule name
|
|
251
|
+
# notify_users - boolean - If true, users will be emailed before the rule disables or deletes them.
|
|
241
252
|
# 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.
|
|
242
253
|
# user_state - string - State of the users to apply the rule to (inactive or disabled)
|
|
243
254
|
# 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.
|
|
@@ -266,6 +277,7 @@ module Files
|
|
|
266
277
|
# include_site_admins - boolean - If true, the rule will apply to site admins.
|
|
267
278
|
# include_folder_admins - boolean - If true, the rule will apply to folder admins.
|
|
268
279
|
# name - string - User Lifecycle Rule name
|
|
280
|
+
# notify_users - boolean - If true, users will be emailed before the rule disables or deletes them.
|
|
269
281
|
# 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.
|
|
270
282
|
# user_state - string - State of the users to apply the rule to (inactive or disabled)
|
|
271
283
|
# 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.
|