-
Notifications
You must be signed in to change notification settings - Fork 93
/
events__get_events.yml
255 lines (238 loc) · 8.34 KB
/
events__get_events.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
---
operationId: get_events
summary: 'List user and enterprise events'
tags:
- Events
x-box-tag: events
description: |-
Returns up to a year of past events for a given user
or for the entire enterprise.
By default this returns events for the authenticated user. To retrieve events
for the entire enterprise, set the `stream_type` to `admin_logs_streaming`
for live monitoring of new events, or `admin_logs` for querying across
historical events. The user making the API call will
need to have admin privileges, and the application will need to have the
scope `manage enterprise properties` checked.
parameters:
- name: stream_type
description: |-
Defines the type of events that are returned
* `all` returns everything for a user and is the default
* `changes` returns events that may cause file tree changes
such as file updates or collaborations.
* `sync` is similar to `changes` but only applies to synced folders
* `admin_logs` returns all events for an entire enterprise and
requires the user making the API call to have admin permissions. This
stream type is for programmatically pulling from a 1 year history of
events across all users within the enterprise and within a
`created_after` and `created_before` time frame. The complete history
of events will be returned in chronological order based on the event
time, but latency will be much higher than `admin_logs_streaming`.
* `admin_logs_streaming` returns all events for an entire enterprise and
requires the user making the API call to have admin permissions. This
stream type is for polling for recent events across all users within
the enterprise. Latency will be much lower than `admin_logs`, but
events will not be returned in chronological order and may
contain duplicates.
in: query
example: all
schema:
type: string
default: all
enum:
- all
- changes
- sync
- admin_logs
- admin_logs_streaming
- name: stream_position
description: |-
The location in the event stream to start receiving events from.
* `now` will return an empty list events and
the latest stream position for initialization.
* `0` or `null` will return all events.
example: "1348790499819"
in: query
schema:
type: string
- name: limit
description: |-
Limits the number of events returned
Note: Sometimes, the events less than the limit requested can be returned
even when there may be more events remaining. This is primarily done in
the case where a number of events have already been retrieved and these
retrieved events are returned rather than delaying for an unknown amount
of time to see if there are any more results.
in: query
example: 50
schema:
type: integer
format: int64
default: 100
maximum: 500
- name: event_type
description: |-
A comma-separated list of events to filter by. This can only be used when
requesting the events with a `stream_type` of `admin_logs` or
`adming_logs_streaming`. For any other `stream_type` this value will be
ignored.
in: query
explode: false
example:
- ACCESS_GRANTED
schema:
type: array
items:
type: string
description: |-
An event type that can be filtered by
enum:
- ACCESS_GRANTED
- ACCESS_REVOKED
- ADD_DEVICE_ASSOCIATION
- ADD_LOGIN_ACTIVITY_DEVICE
- ADMIN_LOGIN
- APPLICATION_CREATED
- APPLICATION_PUBLIC_KEY_ADDED
- APPLICATION_PUBLIC_KEY_DELETED
- CHANGE_ADMIN_ROLE
- CHANGE_FOLDER_PERMISSION
- COLLABORATION_ACCEPT
- COLLABORATION_EXPIRATION
- COLLABORATION_INVITE
- COLLABORATION_REMOVE
- COLLABORATION_ROLE_CHANGE
- COMMENT_CREATE
- COMMENT_DELETE
- CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY
- CONTENT_WORKFLOW_AUTOMATION_ADD
- CONTENT_WORKFLOW_AUTOMATION_DELETE
- CONTENT_WORKFLOW_POLICY_ADD
- CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION
- CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION
- COPY
- DATA_RETENTION_CREATE_RETENTION
- DATA_RETENTION_REMOVE_RETENTION
- DELETE
- DELETE_USER
- DEVICE_TRUST_CHECK_FAILED
- DOWNLOAD
- EDIT
- EDIT_USER
- EMAIL_ALIAS_CONFIRM
- EMAIL_ALIAS_REMOVE
- ENTERPRISE_APP_AUTHORIZATION_UPDATE
- EXTERNAL_COLLAB_SECURITY_SETTINGS
- FAILED_LOGIN
- FILE_MARKED_MALICIOUS
- FILE_WATERMARKED_DOWNLOAD
- GROUP_ADD_ITEM
- GROUP_ADD_USER
- GROUP_CREATION
- GROUP_DELETION
- GROUP_EDITED
- GROUP_REMOVE_ITEM
- GROUP_REMOVE_USER
- ITEM_MODIFY
- ITEM_OPEN
- ITEM_SHARED_UPDATE
- ITEM_SYNC
- ITEM_UNSYNC
- LEGAL_HOLD_ASSIGNMENT_CREATE
- LEGAL_HOLD_ASSIGNMENT_DELETE
- LEGAL_HOLD_POLICY_CREATE
- LEGAL_HOLD_POLICY_DELETE
- LEGAL_HOLD_POLICY_UPDATE
- LOCK
- LOGIN
- METADATA_INSTANCE_CREATE
- METADATA_INSTANCE_DELETE
- METADATA_INSTANCE_UPDATE
- METADATA_TEMPLATE_CREATE
- METADATA_TEMPLATE_DELETE
- METADATA_TEMPLATE_UPDATE
- MOVE
- NEW_USER
- OAUTH2_ACCESS_TOKEN_REVOKE
- PREVIEW
- REMOVE_DEVICE_ASSOCIATION
- REMOVE_LOGIN_ACTIVITY_DEVICE
- RENAME
- RETENTION_POLICY_ASSIGNMENT_ADD
- SHARE
- SHARE_EXPIRATION
- SHIELD_ALERT
- SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED
- SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION
- SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED
- SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION
- SHIELD_JUSTIFICATION_APPROVAL
- SIGN_DOCUMENT_ASSIGNED
- SIGN_DOCUMENT_CANCELLED
- SIGN_DOCUMENT_COMPLETED
- SIGN_DOCUMENT_CONVERTED
- SIGN_DOCUMENT_CREATED
- SIGN_DOCUMENT_DECLINED
- SIGN_DOCUMENT_EXPIRED
- SIGN_DOCUMENT_SIGNED
- SIGN_DOCUMENT_VIEWED_BY_SIGNED
- SIGNER_DOWNLOADED
- SIGNER_FORWARDED
- STORAGE_EXPIRATION
- TASK_ASSIGNMENT_CREATE
- TASK_ASSIGNMENT_DELETE
- TASK_ASSIGNMENT_UPDATE
- TASK_CREATE
- TASK_UPDATE
- TERMS_OF_SERVICE_ACCEPT
- TERMS_OF_SERVICE_REJECT
- UNDELETE
- UNLOCK
- UNSHARE
- UPDATE_COLLABORATION_EXPIRATION
- UPDATE_SHARE_EXPIRATION
- UPLOAD
- USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE
- WATERMARK_LABEL_CREATE
- WATERMARK_LABEL_DELETE
- name: created_after
description: |-
The lower bound date and time to return events for. This can only be used
when requesting the events with a `stream_type` of `admin_logs`. For any
other `stream_type` this value will be ignored.
in: query
example: "2012-12-12T10:53:43-08:00"
schema:
type: string
format: date-time
- name: created_before
description: |-
The upper bound date and time to return events for. This can only be used
when requesting the events with a `stream_type` of `admin_logs`. For any
other `stream_type` this value will be ignored.
in: query
required: false
example: "2013-12-12T10:53:43-08:00"
schema:
type: string
format: date-time
responses:
200:
description: |-
Returns a list of event objects.
Events objects are returned in pages, with each page (chunk)
including a list of event objects. The response includes a
`chunk_size` parameter indicating how many events were returned in this
chunk, as well as the next `stream_position` that can be
queried.
content:
application/json:
schema:
$ref: '#/components/schemas/Events'
default:
description: |-
An unexpected client error.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'