-
Notifications
You must be signed in to change notification settings - Fork 853
Expand file tree
/
Copy pathclient.html
More file actions
721 lines (685 loc) · 36.9 KB
/
client.html
File metadata and controls
721 lines (685 loc) · 36.9 KB
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.6">
<title>slack_sdk.audit_logs.v1.client API documentation</title>
<meta name="description" content="Audit Logs API is a set of APIs for monitoring what’s happening in your Enterprise Grid organization …">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>slack_sdk.audit_logs.v1.client</code></h1>
</header>
<section id="section-intro">
<p>Audit Logs API is a set of APIs for monitoring what’s happening in your Enterprise Grid organization.</p>
<p>Refer to <a href="https://docs.slack.dev/tools/python-slack-sdk/audit-logs">https://docs.slack.dev/tools/python-slack-sdk/audit-logs</a> for details.</p>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient"><code class="flex name class">
<span>class <span class="ident">AuditLogsClient</span></span>
<span>(</span><span>token: str,<br>timeout: int = 30,<br>ssl: ssl.SSLContext | None = None,<br>proxy: str | None = None,<br>base_url: str = 'https://api.slack.com/audit/v1/',<br>default_headers: Dict[str, str] | None = None,<br>user_agent_prefix: str | None = None,<br>user_agent_suffix: str | None = None,<br>logger: logging.Logger | None = None,<br>retry_handlers: List[<a title="slack_sdk.http_retry.handler.RetryHandler" href="../../http_retry/handler.html#slack_sdk.http_retry.handler.RetryHandler">RetryHandler</a>] | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class AuditLogsClient:
BASE_URL = "https://api.slack.com/audit/v1/"
token: str
timeout: int
ssl: Optional[SSLContext]
proxy: Optional[str]
base_url: str
default_headers: Dict[str, str]
logger: logging.Logger
retry_handlers: List[RetryHandler]
def __init__(
self,
token: str,
timeout: int = 30,
ssl: Optional[SSLContext] = None,
proxy: Optional[str] = None,
base_url: str = BASE_URL,
default_headers: Optional[Dict[str, str]] = None,
user_agent_prefix: Optional[str] = None,
user_agent_suffix: Optional[str] = None,
logger: Optional[logging.Logger] = None,
retry_handlers: Optional[List[RetryHandler]] = None,
):
"""API client for Audit Logs API
See https://docs.slack.dev/admins/audit-logs-api/ for more details
Args:
token: An admin user's token, which starts with `xoxp-`
timeout: Request timeout (in seconds)
ssl: `ssl.SSLContext` to use for requests
proxy: Proxy URL (e.g., `localhost:9000`, `http://localhost:9000`)
base_url: The base URL for API calls
default_headers: Request headers to add to all requests
user_agent_prefix: Prefix for User-Agent header value
user_agent_suffix: Suffix for User-Agent header value
logger: Custom logger
retry_handlers: Retry handlers
"""
self.token = token
self.timeout = timeout
self.ssl = ssl
self.proxy = proxy
self.base_url = base_url
self.default_headers = default_headers if default_headers else {}
self.default_headers["User-Agent"] = get_user_agent(user_agent_prefix, user_agent_suffix)
self.logger = logger if logger is not None else logging.getLogger(__name__)
self.retry_handlers = retry_handlers if retry_handlers is not None else default_retry_handlers()
if self.proxy is None or len(self.proxy.strip()) == 0:
env_variable = load_http_proxy_from_env(self.logger)
if env_variable is not None:
self.proxy = env_variable
def schemas(
self,
*,
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""Returns information about the kind of objects which the Audit Logs API
returns as a list of all objects and a short description.
Authentication not required.
Args:
query_params: Set any values if you want to add query params
headers: Additional request headers
Returns:
API response
"""
return self.api_call(
path="schemas",
query_params=query_params,
headers=headers,
)
def actions(
self,
*,
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""Returns information about the kind of actions that the Audit Logs API
returns as a list of all actions and a short description of each.
Authentication not required.
Args:
query_params: Set any values if you want to add query params
headers: Additional request headers
Returns:
API response
"""
return self.api_call(
path="actions",
query_params=query_params,
headers=headers,
)
def logs(
self,
*,
latest: Optional[int] = None,
oldest: Optional[int] = None,
limit: Optional[int] = None,
action: Optional[str] = None,
actor: Optional[str] = None,
entity: Optional[str] = None,
cursor: Optional[str] = None,
additional_query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""This is the primary endpoint for retrieving actual audit events from your organization.
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
The following filters can be applied in order to narrow the range of actions returned.
Filters are added as query string parameters and can be combined together.
Multiple filter parameters are additive (a boolean AND) and are separated
with an ampersand (&) in the query string. Filtering is entirely optional.
Args:
latest: Unix timestamp of the most recent audit event to include (inclusive).
oldest: Unix timestamp of the least recent audit event to include (inclusive).
Data is not available prior to March 2018.
limit: Number of results to optimistically return, maximum 9999.
action: Name of the action.
actor: User ID who initiated the action.
entity: ID of the target entity of the action (such as a channel, workspace, organization, file).
cursor: The next page cursor of pagination
additional_query_params: Add anything else if you need to use the ones this library does not support
headers: Additional request headers
Returns:
API response
"""
query_params = {
"latest": latest,
"oldest": oldest,
"limit": limit,
"action": action,
"actor": actor,
"entity": entity,
"cursor": cursor,
}
if additional_query_params is not None:
query_params.update(additional_query_params)
query_params = {k: v for k, v in query_params.items() if v is not None}
return self.api_call(
path="logs",
query_params=query_params,
headers=headers,
)
def api_call(
self,
*,
http_verb: str = "GET",
path: str,
query_params: Optional[Dict[str, Any]] = None,
body_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""Performs a Slack API request and returns the result."""
url = f"{self.base_url}{path}"
query = _build_query(query_params)
if len(query) > 0:
url += f"?{query}"
return self._perform_http_request(
http_verb=http_verb,
url=url,
body=body_params,
headers=_build_request_headers(
token=self.token,
default_headers=self.default_headers,
additional_headers=headers,
),
)
def _perform_http_request(
self,
*,
http_verb: str = "GET",
url: str,
body: Optional[Dict[str, Any]] = None,
headers: Dict[str, str],
) -> AuditLogsResponse:
if body is not None:
body = json.dumps(body) # type: ignore[assignment]
headers["Content-Type"] = "application/json;charset=utf-8"
if self.logger.level <= logging.DEBUG:
headers_for_logging = {k: "(redacted)" if k.lower() == "authorization" else v for k, v in headers.items()}
self.logger.debug(f"Sending a request - url: {url}, body: {body}, headers: {headers_for_logging}")
# NOTE: Intentionally ignore the `http_verb` here
# Slack APIs accepts any API method requests with POST methods
req = Request(
method=http_verb,
url=url,
data=body.encode("utf-8") if body is not None else None, # type: ignore[attr-defined]
headers=headers,
)
resp = None
last_error = None
retry_state = RetryState()
counter_for_safety = 0
while counter_for_safety < 100:
counter_for_safety += 1
# If this is a retry, the next try started here. We can reset the flag.
retry_state.next_attempt_requested = False
try:
resp = self._perform_http_request_internal(url, req)
# The resp is a 200 OK response
return resp
except HTTPError as e:
# read the response body here
charset = e.headers.get_content_charset() or "utf-8"
response_body: str = e.read().decode(charset)
# As adding new values to HTTPError#headers can be ignored, building a new dict object here
response_headers = dict(e.headers.items())
resp = AuditLogsResponse(
url=url,
status_code=e.code,
raw_body=response_body,
headers=response_headers,
)
if e.code == 429:
# for backward-compatibility with WebClient (v.2.5.0 or older)
if "retry-after" not in resp.headers and "Retry-After" in resp.headers:
resp.headers["retry-after"] = resp.headers["Retry-After"]
if "Retry-After" not in resp.headers and "retry-after" in resp.headers:
resp.headers["Retry-After"] = resp.headers["retry-after"]
_debug_log_response(self.logger, resp)
# Try to find a retry handler for this error
retry_request = RetryHttpRequest.from_urllib_http_request(req)
retry_response = RetryHttpResponse(
status_code=e.code,
headers={k: [v] for k, v in e.headers.items()},
data=response_body.encode("utf-8") if response_body is not None else None,
)
for handler in self.retry_handlers:
if handler.can_retry(
state=retry_state,
request=retry_request,
response=retry_response,
error=e,
):
if self.logger.level <= logging.DEBUG:
self.logger.info(
f"A retry handler found: {type(handler).__name__} for {req.method} {req.full_url} - {e}"
)
handler.prepare_for_next_attempt(
state=retry_state,
request=retry_request,
response=retry_response,
error=e,
)
break
if retry_state.next_attempt_requested is False:
return resp
except Exception as err:
last_error = err
self.logger.error(f"Failed to send a request to Slack API server: {err}")
# Try to find a retry handler for this error
retry_request = RetryHttpRequest.from_urllib_http_request(req)
for handler in self.retry_handlers:
if handler.can_retry(
state=retry_state,
request=retry_request,
response=None,
error=err,
):
if self.logger.level <= logging.DEBUG:
self.logger.info(
f"A retry handler found: {type(handler).__name__} for {req.method} {req.full_url} - {err}"
)
handler.prepare_for_next_attempt(
state=retry_state,
request=retry_request,
response=None,
error=err,
)
self.logger.info(f"Going to retry the same request: {req.method} {req.full_url}")
break
if retry_state.next_attempt_requested is False:
raise err
if resp is not None:
return resp
raise last_error # type: ignore[misc]
def _perform_http_request_internal(self, url: str, req: Request) -> AuditLogsResponse:
opener: Optional[OpenerDirector] = None
# for security (BAN-B310)
if url.lower().startswith("http"):
if self.proxy is not None:
if isinstance(self.proxy, str):
opener = urllib.request.build_opener(
ProxyHandler({"http": self.proxy, "https": self.proxy}),
HTTPSHandler(context=self.ssl),
)
else:
raise SlackRequestError(f"Invalid proxy detected: {self.proxy} must be a str value")
else:
raise SlackRequestError(f"Invalid URL detected: {url}")
http_resp: HTTPResponse
if opener:
http_resp = opener.open(req, timeout=self.timeout)
else:
http_resp = urlopen(req, context=self.ssl, timeout=self.timeout)
charset: str = http_resp.headers.get_content_charset() or "utf-8"
response_body: str = http_resp.read().decode(charset)
resp = AuditLogsResponse(
url=url,
status_code=http_resp.status,
raw_body=response_body,
headers=http_resp.headers, # type: ignore[arg-type]
)
_debug_log_response(self.logger, resp)
return resp</code></pre>
</details>
<div class="desc"><p>API client for Audit Logs API
See <a href="https://docs.slack.dev/admins/audit-logs-api/">https://docs.slack.dev/admins/audit-logs-api/</a> for more details</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>token</code></strong></dt>
<dd>An admin user's token, which starts with <code>xoxp-</code></dd>
<dt><strong><code>timeout</code></strong></dt>
<dd>Request timeout (in seconds)</dd>
<dt><strong><code>ssl</code></strong></dt>
<dd><code>ssl.SSLContext</code> to use for requests</dd>
<dt><strong><code>proxy</code></strong></dt>
<dd>Proxy URL (e.g., <code>localhost:9000</code>, <code>http://localhost:9000</code>)</dd>
<dt><strong><code>base_url</code></strong></dt>
<dd>The base URL for API calls</dd>
<dt><strong><code>default_headers</code></strong></dt>
<dd>Request headers to add to all requests</dd>
<dt><strong><code>user_agent_prefix</code></strong></dt>
<dd>Prefix for User-Agent header value</dd>
<dt><strong><code>user_agent_suffix</code></strong></dt>
<dd>Suffix for User-Agent header value</dd>
<dt><strong><code>logger</code></strong></dt>
<dd>Custom logger</dd>
<dt><strong><code>retry_handlers</code></strong></dt>
<dd>Retry handlers</dd>
</dl></div>
<h3>Class variables</h3>
<dl>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.BASE_URL"><code class="name">var <span class="ident">BASE_URL</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.base_url"><code class="name">var <span class="ident">base_url</span> : str</code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.default_headers"><code class="name">var <span class="ident">default_headers</span> : Dict[str, str]</code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.logger"><code class="name">var <span class="ident">logger</span> : logging.Logger</code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.proxy"><code class="name">var <span class="ident">proxy</span> : str | None</code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.retry_handlers"><code class="name">var <span class="ident">retry_handlers</span> : List[<a title="slack_sdk.http_retry.handler.RetryHandler" href="../../http_retry/handler.html#slack_sdk.http_retry.handler.RetryHandler">RetryHandler</a>]</code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.ssl"><code class="name">var <span class="ident">ssl</span> : ssl.SSLContext | None</code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.timeout"><code class="name">var <span class="ident">timeout</span> : int</code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.token"><code class="name">var <span class="ident">token</span> : str</code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.actions"><code class="name flex">
<span>def <span class="ident">actions</span></span>(<span>self,<br>*,<br>query_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def actions(
self,
*,
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""Returns information about the kind of actions that the Audit Logs API
returns as a list of all actions and a short description of each.
Authentication not required.
Args:
query_params: Set any values if you want to add query params
headers: Additional request headers
Returns:
API response
"""
return self.api_call(
path="actions",
query_params=query_params,
headers=headers,
)</code></pre>
</details>
<div class="desc"><p>Returns information about the kind of actions that the Audit Logs API
returns as a list of all actions and a short description of each.
Authentication not required.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>query_params</code></strong></dt>
<dd>Set any values if you want to add query params</dd>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.api_call"><code class="name flex">
<span>def <span class="ident">api_call</span></span>(<span>self,<br>*,<br>http_verb: str = 'GET',<br>path: str,<br>query_params: Dict[str, Any] | None = None,<br>body_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def api_call(
self,
*,
http_verb: str = "GET",
path: str,
query_params: Optional[Dict[str, Any]] = None,
body_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""Performs a Slack API request and returns the result."""
url = f"{self.base_url}{path}"
query = _build_query(query_params)
if len(query) > 0:
url += f"?{query}"
return self._perform_http_request(
http_verb=http_verb,
url=url,
body=body_params,
headers=_build_request_headers(
token=self.token,
default_headers=self.default_headers,
additional_headers=headers,
),
)</code></pre>
</details>
<div class="desc"><p>Performs a Slack API request and returns the result.</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.logs"><code class="name flex">
<span>def <span class="ident">logs</span></span>(<span>self,<br>*,<br>latest: int | None = None,<br>oldest: int | None = None,<br>limit: int | None = None,<br>action: str | None = None,<br>actor: str | None = None,<br>entity: str | None = None,<br>cursor: str | None = None,<br>additional_query_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def logs(
self,
*,
latest: Optional[int] = None,
oldest: Optional[int] = None,
limit: Optional[int] = None,
action: Optional[str] = None,
actor: Optional[str] = None,
entity: Optional[str] = None,
cursor: Optional[str] = None,
additional_query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""This is the primary endpoint for retrieving actual audit events from your organization.
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
The following filters can be applied in order to narrow the range of actions returned.
Filters are added as query string parameters and can be combined together.
Multiple filter parameters are additive (a boolean AND) and are separated
with an ampersand (&) in the query string. Filtering is entirely optional.
Args:
latest: Unix timestamp of the most recent audit event to include (inclusive).
oldest: Unix timestamp of the least recent audit event to include (inclusive).
Data is not available prior to March 2018.
limit: Number of results to optimistically return, maximum 9999.
action: Name of the action.
actor: User ID who initiated the action.
entity: ID of the target entity of the action (such as a channel, workspace, organization, file).
cursor: The next page cursor of pagination
additional_query_params: Add anything else if you need to use the ones this library does not support
headers: Additional request headers
Returns:
API response
"""
query_params = {
"latest": latest,
"oldest": oldest,
"limit": limit,
"action": action,
"actor": actor,
"entity": entity,
"cursor": cursor,
}
if additional_query_params is not None:
query_params.update(additional_query_params)
query_params = {k: v for k, v in query_params.items() if v is not None}
return self.api_call(
path="logs",
query_params=query_params,
headers=headers,
)</code></pre>
</details>
<div class="desc"><p>This is the primary endpoint for retrieving actual audit events from your organization.
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.</p>
<p>The following filters can be applied in order to narrow the range of actions returned.
Filters are added as query string parameters and can be combined together.
Multiple filter parameters are additive (a boolean AND) and are separated
with an ampersand (&) in the query string. Filtering is entirely optional.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>latest</code></strong></dt>
<dd>Unix timestamp of the most recent audit event to include (inclusive).</dd>
<dt><strong><code>oldest</code></strong></dt>
<dd>Unix timestamp of the least recent audit event to include (inclusive).
Data is not available prior to March 2018.</dd>
<dt><strong><code>limit</code></strong></dt>
<dd>Number of results to optimistically return, maximum 9999.</dd>
<dt><strong><code>action</code></strong></dt>
<dd>Name of the action.</dd>
<dt><strong><code>actor</code></strong></dt>
<dd>User ID who initiated the action.</dd>
<dt><strong><code>entity</code></strong></dt>
<dd>ID of the target entity of the action (such as a channel, workspace, organization, file).</dd>
<dt><strong><code>cursor</code></strong></dt>
<dd>The next page cursor of pagination</dd>
<dt><strong><code>additional_query_params</code></strong></dt>
<dd>Add anything else if you need to use the ones this library does not support</dd>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.schemas"><code class="name flex">
<span>def <span class="ident">schemas</span></span>(<span>self,<br>*,<br>query_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def schemas(
self,
*,
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""Returns information about the kind of objects which the Audit Logs API
returns as a list of all objects and a short description.
Authentication not required.
Args:
query_params: Set any values if you want to add query params
headers: Additional request headers
Returns:
API response
"""
return self.api_call(
path="schemas",
query_params=query_params,
headers=headers,
)</code></pre>
</details>
<div class="desc"><p>Returns information about the kind of objects which the Audit Logs API
returns as a list of all objects and a short description.
Authentication not required.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>query_params</code></strong></dt>
<dd>Set any values if you want to add query params</dd>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="slack_sdk.audit_logs.v1" href="index.html">slack_sdk.audit_logs.v1</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient">AuditLogsClient</a></code></h4>
<ul class="two-column">
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.BASE_URL" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.BASE_URL">BASE_URL</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.actions" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.actions">actions</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.api_call" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.api_call">api_call</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.base_url" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.base_url">base_url</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.default_headers" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.default_headers">default_headers</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.logger" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.logger">logger</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.logs" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.logs">logs</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.proxy" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.proxy">proxy</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.retry_handlers" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.retry_handlers">retry_handlers</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.schemas" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.schemas">schemas</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.ssl" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.ssl">ssl</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.timeout" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.timeout">timeout</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.client.AuditLogsClient.token" href="#slack_sdk.audit_logs.v1.client.AuditLogsClient.token">token</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
</footer>
</body>
</html>