-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathslack_web_api.yml
More file actions
12463 lines (12463 loc) · 421 KB
/
slack_web_api.yml
File metadata and controls
12463 lines (12463 loc) · 421 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
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Slack Web API
description: One way to interact with the Slack platform is its HTTP RPC-based Web
API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace
tokens blessed with related OAuth scopes.
contact:
name: Slack developer relations
url: https://api.slack.com/support
version: 1.7.0
externalDocs:
description: Learn more about the Slack Web API
url: https://api.slack.com/web
servers:
- url: https://slack.com/api
tags: []
paths:
/admin.apps.approve:
post:
tags:
- admin.apps
- admin
description: Approve an app for installation on a workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.apps.approve
operationId: admin_apps_approve
parameters:
- name: token
in: header
description: 'Authentication token. Requires scope: `admin.apps:write`'
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
app_id:
type: string
description: The id of the app to approve.
request_id:
type: string
description: The id of the request to approve.
team_id:
type: string
application/json:
schema:
properties:
app_id:
type: string
description: The id of the app to approve.
request_id:
type: string
description: The id of the request to approve.
team_id:
type: string
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: Default success template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _OK_ response
or a verbose schema is not available for this method.
default:
description: Typical error response
content:
application/json:
schema:
title: Default error template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _not OK_ response
or a verbose schema is not available for this method.
security:
- slackAuth:
- admin.apps:write
/admin.apps.approved.list:
get:
tags:
- admin.apps.approved
- admin
description: List approved apps for an org or workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.apps.approved.list
operationId: admin_apps_approved_list
parameters:
- name: token
in: query
description: 'Authentication token. Requires scope: `admin.apps:read`'
required: true
schema:
type: string
- name: limit
in: query
description: The maximum number of items to return. Must be between 1 - 1000
both inclusive.
schema:
type: integer
- name: cursor
in: query
description: Set `cursor` to `next_cursor` returned by the previous call to
list items in the next page
schema:
type: string
- name: team_id
in: query
schema:
type: string
- name: enterprise_id
in: query
schema:
type: string
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: Default success template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _OK_ response
or a verbose schema is not available for this method.
default:
description: Typical error response
content:
application/json:
schema:
title: Default error template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _not OK_ response
or a verbose schema is not available for this method.
security:
- slackAuth:
- admin.apps:read
/admin.apps.requests.list:
get:
tags:
- admin.apps.requests
- admin
description: List app requests for a team/workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.apps.requests.list
operationId: admin_apps_requests_list
parameters:
- name: token
in: query
description: 'Authentication token. Requires scope: `admin.apps:read`'
required: true
schema:
type: string
- name: limit
in: query
description: The maximum number of items to return. Must be between 1 - 1000
both inclusive.
schema:
type: integer
- name: cursor
in: query
description: Set `cursor` to `next_cursor` returned by the previous call to
list items in the next page
schema:
type: string
- name: team_id
in: query
schema:
type: string
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: Default success template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _OK_ response
or a verbose schema is not available for this method.
default:
description: Typical error response
content:
application/json:
schema:
title: Default error template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _not OK_ response
or a verbose schema is not available for this method.
security:
- slackAuth:
- admin.apps:read
/admin.apps.restrict:
post:
tags:
- admin.apps
- admin
description: Restrict an app for installation on a workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.apps.restrict
operationId: admin_apps_restrict
parameters:
- name: token
in: header
description: 'Authentication token. Requires scope: `admin.apps:write`'
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
app_id:
type: string
description: The id of the app to restrict.
request_id:
type: string
description: The id of the request to restrict.
team_id:
type: string
application/json:
schema:
properties:
app_id:
type: string
description: The id of the app to restrict.
request_id:
type: string
description: The id of the request to restrict.
team_id:
type: string
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: Default success template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _OK_ response
or a verbose schema is not available for this method.
default:
description: Typical error response
content:
application/json:
schema:
title: Default error template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _not OK_ response
or a verbose schema is not available for this method.
security:
- slackAuth:
- admin.apps:write
/admin.apps.restricted.list:
get:
tags:
- admin.apps.restricted
- admin
description: List restricted apps for an org or workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.apps.restricted.list
operationId: admin_apps_restricted_list
parameters:
- name: token
in: query
description: 'Authentication token. Requires scope: `admin.apps:read`'
required: true
schema:
type: string
- name: limit
in: query
description: The maximum number of items to return. Must be between 1 - 1000
both inclusive.
schema:
type: integer
- name: cursor
in: query
description: Set `cursor` to `next_cursor` returned by the previous call to
list items in the next page
schema:
type: string
- name: team_id
in: query
schema:
type: string
- name: enterprise_id
in: query
schema:
type: string
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: Default success template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _OK_ response
or a verbose schema is not available for this method.
default:
description: Typical error response
content:
application/json:
schema:
title: Default error template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _not OK_ response
or a verbose schema is not available for this method.
security:
- slackAuth:
- admin.apps:read
/admin.conversations.archive:
post:
tags:
- admin.conversations
- admin
description: Archive a public or private channel.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.archive
operationId: admin_conversations_archive
parameters:
- name: token
in: header
description: 'Authentication token. Requires scope: `admin.conversations:write`'
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- channel_id
properties:
channel_id:
type: string
description: The channel to archive.
application/json:
schema:
required:
- channel_id
properties:
channel_id:
type: string
description: The channel to archive.
required: true
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: admin.conversations.archive schema
type: object
additionalProperties:
type: object
description: Schema for successful response of admin.conversations.archive
default:
description: Typical error response
content:
application/json:
schema:
title: admin.conversations.archive error schema
type: object
additionalProperties:
type: object
description: Schema for error response from admin.conversations.archive
security:
- slackAuth:
- admin.conversations:write
/admin.conversations.convertToPrivate:
post:
tags:
- admin.conversations
- admin
description: Convert a public channel to a private channel.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.convertToPrivate
operationId: admin_conversations_convertToPrivate
parameters:
- name: token
in: header
description: 'Authentication token. Requires scope: `admin.conversations:write`'
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- channel_id
properties:
channel_id:
type: string
description: The channel to convert to private.
application/json:
schema:
required:
- channel_id
properties:
channel_id:
type: string
description: The channel to convert to private.
required: true
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: admin.conversations.convertToPrivate schema
type: object
additionalProperties:
type: object
description: Schema for successful response of admin.conversations.convertToPrivate
default:
description: Typical error response
content:
application/json:
schema:
title: admin.conversations.convertToPrivate error schema
type: object
additionalProperties:
type: object
description: Schema for error response from admin.conversations.convertToPrivate
security:
- slackAuth:
- admin.conversations:write
/admin.conversations.create:
post:
tags:
- admin.conversations
- admin
description: Create a public or private channel-based conversation.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.create
operationId: admin_conversations_create
parameters:
- name: token
in: header
description: 'Authentication token. Requires scope: `admin.conversations:write`'
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- is_private
- name
properties:
name:
type: string
description: Name of the public or private channel to create.
description:
type: string
description: Description of the public or private channel to create.
is_private:
type: boolean
description: When `true`, creates a private channel instead of a
public channel
org_wide:
type: boolean
description: 'When `true`, the channel will be available org-wide.
Note: if the channel is not `org_wide=true`, you must specify
a `team_id` for this channel'
team_id:
type: string
description: 'The workspace to create the channel in. Note: this
argument is required unless you set `org_wide=true`.'
application/json:
schema:
required:
- is_private
- name
properties:
name:
type: string
description: Name of the public or private channel to create.
description:
type: string
description: Description of the public or private channel to create.
is_private:
type: boolean
description: When `true`, creates a private channel instead of a
public channel
org_wide:
type: boolean
description: 'When `true`, the channel will be available org-wide.
Note: if the channel is not `org_wide=true`, you must specify
a `team_id` for this channel'
team_id:
type: string
description: 'The workspace to create the channel in. Note: this
argument is required unless you set `org_wide=true`.'
required: true
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: admin.conversations.create schema
type: object
additionalProperties:
type: object
description: Schema for successful response of admin.conversations.create
default:
description: Typical error response
content:
application/json:
schema:
title: admin.conversations.create error schema
type: object
additionalProperties:
type: object
description: Schema for error response from admin.conversations.create
security:
- slackAuth:
- admin.conversations:write
/admin.conversations.delete:
post:
tags:
- admin.conversations
- admin
description: Delete a public or private channel.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.delete
operationId: admin_conversations_delete
parameters:
- name: token
in: header
description: 'Authentication token. Requires scope: `admin.conversations:write`'
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- channel_id
properties:
channel_id:
type: string
description: The channel to delete.
application/json:
schema:
required:
- channel_id
properties:
channel_id:
type: string
description: The channel to delete.
required: true
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: admin.conversations.delete schema
type: object
additionalProperties:
type: object
description: Schema for successful response of admin.conversations.delete
default:
description: Typical error response
content:
application/json:
schema:
title: admin.conversations.delete error schema
type: object
additionalProperties:
type: object
description: Schema for error response from admin.conversations.delete
security:
- slackAuth:
- admin.conversations:write
/admin.conversations.disconnectShared:
post:
tags:
- admin.conversations
- admin
description: Disconnect a connected channel from one or more workspaces.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.disconnectShared
operationId: admin_conversations_disconnectShared
parameters:
- name: token
in: header
description: 'Authentication token. Requires scope: `admin.conversations:write`'
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- channel_id
properties:
channel_id:
type: string
description: The channel to be disconnected from some workspaces.
leaving_team_ids:
type: string
description: The team to be removed from the channel. Currently
only a single team id can be specified.
application/json:
schema:
required:
- channel_id
properties:
channel_id:
type: string
description: The channel to be disconnected from some workspaces.
leaving_team_ids:
type: string
description: The team to be removed from the channel. Currently
only a single team id can be specified.
required: true
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: admin.conversations.rename schema
type: object
additionalProperties:
type: object
description: Schema for successful response of admin.conversations.disconnectShared
default:
description: Typical error response
content:
application/json:
schema:
title: admin.conversations.disconnectShared error schema
type: object
additionalProperties:
type: object
description: Schema for error response from admin.conversations.disconnectShared
security:
- slackAuth:
- admin.conversations:write
/admin.conversations.ekm.listOriginalConnectedChannelInfo:
get:
tags:
- admin.conversations.ekm
- admin
description: List all disconnected channels—i.e., channels that were once connected
to other workspaces and then disconnected—and the corresponding original channel
IDs for key revocation with EKM.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
operationId: admin_conversations_ekm_listOriginalConnectedChannelInfo
parameters:
- name: token
in: query
description: 'Authentication token. Requires scope: `admin.conversations:read`'
required: true
schema:
type: string
- name: channel_ids
in: query
description: A comma-separated list of channels to filter to.
schema:
type: string
- name: team_ids
in: query
description: A comma-separated list of the workspaces to which the channels
you would like returned belong.
schema:
type: string
- name: limit
in: query
description: The maximum number of items to return. Must be between 1 - 1000
both inclusive.
schema:
type: integer
- name: cursor
in: query
description: Set `cursor` to `next_cursor` returned by the previous call to
list items in the next page.
schema:
type: string
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: Default success template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _OK_ response
or a verbose schema is not available for this method.
default:
description: Typical error response
content:
application/json:
schema:
title: Default error template
type: object
additionalProperties:
type: object
description: This method either only returns a brief _not OK_ response
or a verbose schema is not available for this method.
security:
- slackAuth:
- admin.conversations:read
/admin.conversations.getConversationPrefs:
get:
tags:
- admin.conversations
- admin
description: Get conversation preferences for a public or private channel.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.getConversationPrefs
operationId: admin_conversations_getConversationPrefs
parameters:
- name: token
in: header
description: 'Authentication token. Requires scope: `admin.conversations:read`'
required: true
schema:
type: string
- name: channel_id
in: query
description: The channel to get preferences for.
required: true
schema:
type: string
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: admin.conversations.getConversationPrefs schema
type: object
additionalProperties:
type: object
description: Schema for successful response of admin.conversations.getConversationPrefs
default:
description: Typical error response
content:
application/json:
schema:
title: admin.conversations.unarchive error schema
type: object
additionalProperties:
type: object
description: Schema for error response from admin.conversations.getConversationPrefs
security:
- slackAuth:
- admin.conversations:read
/admin.conversations.getTeams:
get:
tags:
- admin.conversations
- admin
description: Get all the workspaces a given public or private channel is connected
to within this Enterprise org.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.getTeams
operationId: admin_conversations_getTeams
parameters:
- name: token
in: header
description: 'Authentication token. Requires scope: `admin.conversations:read`'
required: true
schema:
type: string
- name: channel_id
in: query
description: The channel to determine connected workspaces within the organization
for.
required: true
schema:
type: string
- name: cursor
in: query
description: Set `cursor` to `next_cursor` returned by the previous call to
list items in the next page
schema:
type: string
- name: limit
in: query
description: The maximum number of items to return. Must be between 1 - 1000
both inclusive.
schema:
type: integer
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: admin.conversations.getTeams schema
type: object
additionalProperties:
type: object
description: Schema for successful response of admin.conversations.getTeams
default:
description: Typical error response
content:
application/json:
schema:
title: admin.conversations.getTeams error schema
type: object
additionalProperties:
type: object
description: Schema for error response from admin.conversations.getTeams
security:
- slackAuth:
- admin.conversations:read
/admin.conversations.invite:
post:
tags:
- admin.conversations
- admin
description: Invite a user to a public or private channel.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.invite
operationId: admin_conversations_invite
parameters:
- name: token
in: header
description: 'Authentication token. Requires scope: `admin.conversations:write`'
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- channel_id
- user_ids
properties:
user_ids:
type: string
description: The users to invite.
channel_id:
type: string
description: The channel that the users will be invited to.
application/json:
schema:
required:
- channel_id
- user_ids
properties:
user_ids:
type: string
description: The users to invite.
channel_id:
type: string
description: The channel that the users will be invited to.
required: true
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: admin.conversations.invite schema
type: object
additionalProperties:
type: object
description: Schema for successful response of admin.conversations.invite
default:
description: Typical error response
content:
application/json:
schema:
title: admin.conversations.invite error schema
type: object
additionalProperties:
type: object
description: Schema for error response from admin.conversations.invite
security:
- slackAuth:
- admin.conversations:write
/admin.conversations.rename:
post:
tags:
- admin.conversations
- admin
description: Rename a public or private channel.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.rename
operationId: admin_conversations_rename
parameters:
- name: token
in: header
description: 'Authentication token. Requires scope: `admin.conversations:write`'
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- channel_id
- name
properties:
channel_id:
type: string
description: The channel to rename.
name:
type: string
application/json:
schema:
required:
- channel_id
- name
properties:
channel_id:
type: string
description: The channel to rename.
name:
type: string
required: true
responses:
200:
description: Typical success response
content:
application/json:
schema:
title: admin.conversations.rename schema
type: object
additionalProperties:
type: object
description: Schema for successful response of admin.conversations.rename
default:
description: Typical error response
content:
application/json:
schema:
title: admin.conversations.unarchive error schema
type: object
additionalProperties:
type: object
description: Schema for error response from admin.conversations.rename
security:
- slackAuth:
- admin.conversations:write
/admin.conversations.restrictAccess.addGroup:
post:
tags:
- admin.conversations.restrictAccess
- admin
description: Add an allowlist of IDP groups for accessing a channel
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup
operationId: admin_conversations_restrictAccess_addGroup
requestBody:
content: