forked from shatsar/api-rest-meetings
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
executable file
·8664 lines (8653 loc) · 269 KB
/
swagger.yaml
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
swagger: "2.0"
info:
title: BlueJeans Meetings REST API
description: >
## Video That Works Where You Do.
<p>This site provides developers access to APIs from BlueJean's Meetings meeting service. From here you can see and try actual API calls to manage User Accounts, Meetings, and Recordings, pull Analytical Data and Current State information.</p>
<nosdk>
<hr>
<div>
<div class="key">
<a href="./basics.html" target="_"><img class="keyimg" src="./img/bjnmeeting.png"/></a>
</div>
<div class="keybox">
Basic instructions about What is a BlueJeans Meeting, and Getting Started Using API's, are <a href="./basics.html" target="_blank">available here <i class="glyphicon glyphicon-new-window"></i></a>.
</div>
</div>
<hr>
<div class="changelog-date">3/25/2020</div> Clarify authentication APIs, update contact<br/>
<div class="changelog-date">2/06/2020</div> Update POST to scheduled_meeting API, specify personal meeting via Query Parameter<br/>
<div class="changelog-date">2/21/2019</div> Change response of Change layout and Endpoint API's to 204<br/>
<div class="changelog-date">12/03/2018</div> Add API for setting user profile photograph.<br/>
<div class="changelog-date">10/17/2018</div> Updated API field definitions for time variables to be 64-bit .<br/>
<div class="changelog-date">7/23/2018</div> Corrected errors in API definition file.<br/>
<div class="changelog-date">7/10/2018</div> Deprecated some Command Center API's. Exposed API's that Summarize usage.<br/>
<div class="changelog-date">7/06/2018</div> Added API for changing ownership of recordings.<br/>
<div class="changelog-date">6/28/2018</div> Restored Create Enterprise Account, added Enterprise and User Profile Tag API's.<br/>
<div class="changelog-date">6/01/2018</div> Clarified Access Token requirements for meeting endpoint API's.<br/>
<div class="changelog-date">5/21/2018</div> Corrected return model for meeting history call.<br/>
</nosdk>
<hr>
version: 1.0.44006022020
termsOfService: https://www.bluejeans.com/terms-of-service
license:
name: Commercial
url: https://www.bluejeans.com/site/terms-and-conditions
contact:
name: API Developer Support
url: https://support.bluejeans.com/s/contactsupport
host: api.bluejeans.com
tags:
- name: Authentication
description: Initiate a session with BlueJeans
- name: User
description: Manage End User Accounts
- name: Enterprise
description: Manage User Accounts in Enterprise
- name: Meeting
description: Manage Video Meetings and Endpoints
- name: History
description: Access Historical Meeting Data
- name: Recording
description: Manage Meeting Recordings
- name: Command Center v1.0 [DEPRECATING ON 31/MAY/2022]
description: For migration, refer to Command Center v2.0 APIs at https://indigo2-docs.bluejeans.com/.
- name: Application
description: OAuth 3-Legged Operations
schemes:
- https
produces:
- application/json
security:
- access_token: []
paths:
# ---- AUTHENTICATION
/oauth2/token#User:
post:
tags:
- Authentication
summary: Authenticate user using password
description: This API authenticates a user based upon a username and password. Call this API and provide a valid username and password. <br />**NOTE:** <br /> When calling this API, you must set the field, **grant_type** to equal "**password**" (string).
operationId: getTokenByPassword
consumes:
- application/json
parameters:
- in: body
name: GrantRequestPassword
description: Contains information about the type of grant you are requesting. **Remember**, the field *grant_type* must be set to *password*.
required: true
schema:
$ref: '#/definitions/GrantRequestPassword'
responses:
200:
description: The information about the grant.
schema:
$ref: '#/definitions/GrantPassword'
responseSchema:
$ref: '#/definitions/GrantPassword'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security: []
/oauth2/token#Meeting:
post:
tags:
- Authentication
summary: Authenticate meeting using meeting ID and passcode
description: This API uses an OAuth-like grant/request method similar to the Password grant type. The API returns an access token whose scope is limited to the meeting only. <br />Call this API with the meeting's numeric ID, and the meeting passcode (if one exists). <br /> If you call the API with a Moderator passcode, moderator privileges are granted. <br /> If an Attendee access code is passed, the access token will grant attendee abilities.<br />**NOTE:** <br /> When calling this API, you must set the field, **grant_type** to equal "**meeting_passcode**" (string).
operationId: getTokenByMeeting
consumes:
- application/json
parameters:
- in: body
name: GrantRequestMeeting
description: Contains information about the type of grant you are requesting. **Remember**, the field *grant_type* must be set to *meeting_passcode*.
required: true
schema:
$ref: '#/definitions/GrantRequestMeeting'
responses:
200:
description: The information about the grant.
schema:
$ref: '#/definitions/GrantMeeting'
responseSchema:
$ref: '#/definitions/GrantMeeting'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security: []
/oauth2/token#Application:
post:
tags:
- Authentication
summary: Authenticate application using client ID and secret
description: This API is typically called from an application that needs to make API requests. The values for the calling parameters, Client ID, and Secret, are provisioned within the BlueJeans Enterprise Administration console. A BlueJeans administrator must generate these parameters and provide them to the customer/developer. <br />**NOTE:** <br /> When calling this API, you must set the field, **grant_type** to equal "**client_credentials**" (string).
operationId: getTokenByClient
consumes:
- application/json
parameters:
- in: body
name: GrantRequestClient
description: Contains information about the type of grant you are requesting. **Remember**, the field *grant_type* must be set to *client_credentials*.
required: true
schema:
$ref: '#/definitions/GrantRequestClient'
responses:
200:
description: The information about the grant.
schema:
$ref: '#/definitions/GrantClient'
responseSchema:
$ref: '#/definitions/GrantClient'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security: []
/oauth2/token#Revoke:
delete:
tags:
- Authentication
summary: Revoke a user, meeting, or application token
description: Invalidate tokens generated for a user, meeting, or application. <br />**NOTE:** This does not work for 3-legged tokens - see Revoke 3-Legged below.
operationId: revokeAccessToken
consumes:
- application/json
parameters:
- in: query
name: access_token
description: The token to revoke
required: false
type: string
responses:
204:
description: The information about the grant.
400:
description: Bad request. The access_token is probably already revoked and cannot be found. Use GET /oauth2/tokenInfo to query a token's validity if needed.
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
/oauth2/token#3Legged:
post:
tags:
- Authentication
summary: Authenticate 3-legged using OAuth code
description: This API is part of the 3-legged OAuth 2.0 authorization flow. The user will be redirected here after successfully authorizing BlueJeans to grant the application access. You must pass to this API the authorization code received from BlueJeans along with the applications OAuth client_id and secret keys. Include as well a *success URL* to which the user will be redirected upon successful authentication. <br />**NOTE:** <br /> When calling this API, you must set the field, **grant_type** to equal "**authorization_code**" (string).
operationId: getTokenByCode
consumes:
- application/json
parameters:
- in: body
name: GrantRequestCode
description: Contains information about the type of grant you are requesting. **Remember**, the field *grant_type* must be set to *authorization_code*.
required: true
schema:
$ref: '#/definitions/GrantRequestCode'
responses:
200:
description: The information about the grant.
schema:
$ref: '#/definitions/GrantCode'
responseSchema:
$ref: '#/definitions/GrantCode'
401:
description: The code token is invalid or has expired. The code is only good for 30 seconds!
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security: []
/oauth2/token#Refresh_3Legged:
post:
tags:
- Authentication
summary: Refresh 3-legged using existing token
escription: This API is part of the 3-legged OAuth 2.0 authorization flow. It only works for access tokens obtained via the POST /oauth2/token#3-Legged) endpoint. It allows an application to refresh an existing access token. You must pass to this API your OAuth client and secret keys as well as the current access token being refreshed. <br />**NOTE:** <br /> When calling this API, you must set the field, **grant_type** to equal "**refresh_token**" (strin.
operationId: getTokenByRefresh
consumes:
- application/json
parameters:
- in: body
name: GrantRequestRefresh
description: Contains information about the type of grant you are requesting. **Remember**, the field *grant_type* must be set to *refresh_token*.
required: true
schema:
$ref: '#/definitions/GrantRequestRefresh'
responses:
200:
description: The information about the grant.
schema:
$ref: '#/definitions/GrantRefresh'
responseSchema:
$ref: '#/definitions/GrantRefresh'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
/oauth2/token#Revoke_3Legged:
delete:
tags:
- Authentication
summary: Revoke 3-legged token
description: This API is part of the 3-legged OAuth 2.0 authorization flow. It only works for access tokens obtained via the POST /oauth2/token#3-Legged) endpoint
operationId: revokeAccessToken
consumes:
- application/json
parameters:
- in: query
name: access_token
description: The token to revoke
required: false
type: string
- in: body
name: RevokeRequestOAuth
description: Contains information about the type of grant you are revoking.
required: true
schema:
$ref: '#/definitions/RevokeRequestOAuth'
responses:
204:
description: The information about the grant.
400:
description: Bad request. The access_token is probably already revoked and cannot be found. Use GET /oauth2/tokenInfo to query a token's validity if needed.
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
/oauth2/tokenInfo:
get:
tags:
- Authentication
summary: Validate a token
description: This endpoint will determine if a token is valid or not. It works for all kinds of tokens. If the token is valid, it returns information about the token. The information returned depends on the token type.
operationId: getTokenInfo
consumes:
- application/json
parameters:
- name: access_token
in: query
required: false
type: string
responses:
200:
description: Any information about the token.
schema:
$ref: '#/definitions/inline_response_200'
responseSchema:
type: object
properties:
user:
type: integer
description: The ID of the user who this token corresponds to.
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security: []
/oauth2/authorize:
get:
tags:
- Authentication
summary: Get Authorization Code
description: This is **not a true REST endpoint**. <br /> This URL should be used by a user's browser-client application to perform authorization. <br />This API call takes the user to a BlueJeans page that allows the user to login and approve application access.<br />Upon completion, the user will be redirected back to the client application with a code return value. <br />**Note**<ul><li>This API is activated through <b> https://bluejeans.com/oauth2/authorize </b></li><li>The API's return code has a very short valid period of <b>30 seconds</b>.</li><li>Your application must call the <b>/oauth2/token?Code</b> API as soon as possible to exchange the authorization code for an access token.</li></ul>
operationId: getAuthorizationCode
parameters:
- name: clientId
in: query
description: The 32 character client ID generated when you created the client application.
required: false
type: string
- name: redirectUri
in: query
description: The URL where the authorization code will be returned via redirect. The URL must match a URL registered with the client application.
required: false
type: string
- name: state
in: query
description: Client application specific state passed through and returned in the redirect URL. May be useful for identifying operations or users.
required: false
type: string
- name: scope
in: query
description: A comma delimited list of scopes requested. Scopes may be list_meetings, modify_meetings, user_info, meeting_history, modify_user_info. Raise a support case with us if you wish to have more scopes supported.
required: false
type: string
- name: responseType
in: query
description: The type of authorization you are peforrming. Set to "code".
required: false
type: string
default: code
- name: appName
in: query
description: The name of the client application shown to user during authorization.
required: false
type: string
- name: appLogoUrl
in: query
description: URL to an 84x84 image shown to user during authorization.
required: false
type: string
responses:
200:
description: This URL should be invoked by the user of the client application in a browser, not via API.
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security: []
# ---- USER
/v1/user/{user_id}:
get:
tags:
- User
summary: Get User Account Details
description: This endpoint retrieves the basic account details for a given user.
operationId: getUser
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
responses:
200:
description: The settings for the user
schema:
$ref: '#/definitions/User'
responseSchema:
$ref: '#/definitions/User'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
put:
tags:
- User
summary: Update User Account Details
description: This endpoint allows updating a user’s basic account details.
operationId: updateUser
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
- name: profilePictureURL
in: query
description: The profile Picture URL
required: false
type: string
- name: extraInfo
in: query
description: The extra information about the user. This is optional
required: false
type: string
- name: countryCode
in: query
description: The country code
required: false
type: string
- name: sendVerificationMail
in: query
description: flag to send verification email
required: false
type: boolean
default: false
- name: updateRoom
in: query
description: flag for Updating room name to user's name
required: false
type: boolean
default: false
- in: body
name: user
description: The user details that you wish to update.
required: true
schema:
$ref: '#/definitions/User'
responses:
200:
description: The settings for the user
schema:
$ref: '#/definitions/User'
responseSchema:
$ref: '#/definitions/User'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
/v1/user/{user_id}/granted_applications:
get:
tags:
- User
summary: Get Granted Applications
description: This endpoint retrieves the granted applications associated with the user.
operationId: getGrantedApplications
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
responses:
200:
description: The granted applications for the user.
schema:
$ref: '#/definitions/GrantedApplications'
responseSchema:
$ref: '#/definitions/GrantedApplications'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
/v1/user/{user_id}/granted_applications/{client_id}:
delete:
tags:
- User
summary: Remove Granted Application
description: This endpoint revokes the granted application associated with the user.
operationId: revokeGrantedApplication
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: string
- name: client_id
in: path
description: The ID of the granted application.
required: true
type: string
responses:
204:
description: The granted applications for the user.
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
/v1/user/{user_id}/enterprise_profile:
get:
tags:
- User
summary: Get Enterprise Profile
description: This endpoint retrieves the enterprise profile associated with the user.
operationId: getEnterpriseProfile
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
responses:
200:
description: The settings for the user's enterprise association.
schema:
$ref: '#/definitions/Enterprise'
responseSchema:
$ref: '#/definitions/Enterprise'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
/v1/user/{user_id}/groups:
get:
tags:
- User
summary: Get User Feature Groups
description: This endpoint retrieves the feature groups associated with the user.
operationId: getGroups
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
responses:
200:
description: The feature groups the user belongs to.
schema:
type: array
items:
type: string
responseSchema:
type: array
items:
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
put:
tags:
- User
summary: Set User Feature Groups
description: This endpoint sets the feature groups associated with the user.
operationId: setGroups
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
- name: enable
in: query
description: The feature groups (comma separated) you want to enable.
required: false
type: array
items:
type: string
collectionFormat: csv
enum:
- record
- extended_capacity
- lync
- jabber
- telepresence
- isdn
- facetime
- name: disableGroups
in: query
description: The feature groups (comma separated) you want to disable.
required: false
type: array
items:
type: string
collectionFormat: csv
enum:
- record
- extended_capacity
- lync
- jabber
- telepresence
- isdn
- facetime
responses:
200:
description: Empty response on success.
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
/v1/user/{user_id}/room:
get:
tags:
- User
summary: Get User’s Default Meeting Settings
description: This endpoint gets a user’s default meeting settings.
operationId: getRoom
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
responses:
200:
description: The default meeting settings.
schema:
$ref: '#/definitions/Room'
responseSchema:
$ref: '#/definitions/Room'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
post:
tags:
- User
summary: Create User’s Default Meeting Settings
description: This endpoint creates the user’s default meeting settings.
operationId: createRoom
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
- in: body
name: room
description: The user's room details
required: true
schema:
$ref: '#/definitions/Room'
responses:
200:
description: The default meeting settings.
schema:
$ref: '#/definitions/Room'
responseSchema:
$ref: '#/definitions/Room'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
put:
tags:
- User
summary: Update User’s Default Meeting Settings
description: This endpoint allows updating a user’s default meeting settings.
operationId: updateRoom
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
- in: body
name: room
description: The user's room details that you wish to update.
required: true
schema:
$ref: '#/definitions/Room'
responses:
200:
description: The default meeting settings.
schema:
$ref: '#/definitions/Room'
responseSchema:
$ref: '#/definitions/Room'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
/v1/user/{user_id}/personal_meeting:
get:
tags:
- User
summary: Get Personal Meeting
description: This endpoint gets the settings for a user's personal meeting.
operationId: getPersonalMeeting
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
responses:
200:
description: The settings for the meeting.
schema:
$ref: '#/definitions/PersonalMeetingRoom'
responseSchema:
$ref: '#/definitions/PersonalMeetingRoom'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
put:
tags:
- User
summary: Update Personal Meeting
description: This endpoint changes the settings for a user's personal meeting.
operationId: updatePeresonalMeeting
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
- in: body
name: personalMeeting
description: The user's personal meeting room details that you wish to update.
required: true
schema:
$ref: '#/definitions/PersonalMeetingRoom'
responses:
200:
description: The settings for the meeting.
schema:
$ref: '#/definitions/PersonalMeetingRoom'
responseSchema:
$ref: '#/definitions/PersonalMeetingRoom'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
/v1/user/{userId}/tags:
get:
tags:
- User
summary: List User Tags
description: This endpoint retrieves all tags associated with the specified user.
operationId: getUserTags
parameters:
- name: userId
in: path
description: The user ID for the account to retrieve tags. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
required: true
type: integer
responses:
200:
description: The list of tags
schema:
$ref: '#/definitions/tagListComp'
responseSchema:
$ref: '#/definitions/tagListComp'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
put:
tags:
- User
summary: Set User Tags
description: This endpoint modifies the list of tags associated with the specified user. <b>NOTE</b> Adding a tag that is not defined in the user's Enterprise returns a 200 (success) status code. It is recommended you validate the returned list of tags.
operationId: changeUserTags
parameters:
- name: userId
in: path
description: The user ID for the account to retrieve tags. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
required: true
type: integer
- name: action
in: query
description: Type of operation to be done
required: true
type: string
enum:
- add
- delete
- name: tag
in: query
description: The name of tags (comma separated list)
required: true
type: array
items:
type: string
collectionFormat: csv
responses:
200:
description: The list of tags
schema:
$ref: '#/definitions/tagListComp'
responseSchema:
$ref: '#/definitions/tagListComp'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
/v1/user/{user_id}/profile_picture/upload:
post:
tags:
- User
summary: Update User Account Photograph
description: This endpoint uploads a photograph to the user profile
consumes: multipart/form-data
operationId: updateUserProfilePicture
parameters:
- name: user_id
in: path
description: The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.
required: true
type: integer
- name: file
in: formData
type: file
description: The user details that you wish to update.
required: true
responses:
200:
description: The response of uploading the picture
schema:
$ref: "#/definitions/uploadPhotoResponse"
405:
description: Invalid request
500:
description: Internal Server Error
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
# ---- ENTERPRISE
/v1/enterprise/{enterpriseId}/users:
get:
tags:
- Enterprise
summary: Search for User(s)
description: This endpoint provides a search facility for the specified enterprise. <ul><li>If textSearch is provided, the results will be a partial string-match search of the given textSearch value.</li><li> Otherwise, the search will return an exact lookup by emailId.</li></ul>
operationId: searchUsers
parameters:
- name: enterpriseId
in: path
description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
required: true
type: integer
- name: fields
in: query
description: A comma-separated list one or more of these BlueJeans enteprise profile fields to include in the API responses- username, firstName, middleName, lastName, isEnterpriseAdmin, enterpriseJoinDate, email
required: false
type: string
- name: order
in: query
description: If specificed, order defines how the API sorts results- ascending or descending
required: false
type: string
enum:
- asc
- desc
- name: sortBy
in: query
description: Name of BlueJeans profile field by with API response data is sorted
required: false
type: string
- name: textSearch
in: query
description: If specified textSearch provides a string (partial or complete) by which to search the list of BlueJeans users
required: false
type: string
- name: filters
in: query
description: return the list of users with given pre-defined filters. eg. admin users, users with command center access and active users.
required: false
type: string
- name: tag
in: query
description: to get enterprise Users for specified tags
required: false
type: string
- name: emailId
in: query
description: If specified, emailId specifies performing a search for the user profile associated with this email address. Wildcards are <b>not</b> supported for the email address value.
required: false
type: string
- name: pageSize
in: query
description: Sets number of items returned per page.
required: false
type: integer
- name: pageNumber
in: query
description: Selects which page of results to return (1-based value)
required: false
type: integer
responses:
200:
description: The settings for the user
schema:
$ref: '#/definitions/EnterpriseUserSearch'
responseSchema:
$ref: '#/definitions/EnterpriseUserSearch'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
responseSchema:
$ref: '#/definitions/Error'
security:
- access_token: []
post:
tags:
- Enterprise
summary: Create an Enterprise User
description: This endpoint creates a user profile within the specified enterprise. It is the first of the 2-step process to create a BlueJeans user. It should be followed by an API call to create the user's personal meeting room.
operationId: createEnterpriseUser
parameters:
- name: enterpriseId
in: path
description: The ID of the enterprise of interest. This value is an integer which can be retrieved for the current user via the Get Enterprise Profile endpoint.
required: true
type: integer
- name: billingKey
in: query
description: What general billing group does this profile belong? (among INDIVIDUAL, ENTERPRISE, DT_GROUP_EUR, DT_GROUP_GBP)
required: false
type: string
default: ENTERPRISE
- name: countryCode
in: query
description: For Country Code
required: false
type: string
default: US
- in: body
name: EnterpriseUser
description: Basic Enterprise Account information
required: true
schema:
$ref: '#/definitions/User'
responses:
201:
description: The settings for the user
schema:
$ref: '#/definitions/UserId'
responseSchema:
$ref: '#/definitions/UserId'
default: