-
Notifications
You must be signed in to change notification settings - Fork 45
/
community-connect-public-api.yaml
611 lines (608 loc) · 17.3 KB
/
community-connect-public-api.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
openapi: 3.0.1
info:
title: Community Connect API
description: 'Community Connect public API'
version: 1.3.0
tags:
- name: channelco
description: Public API for channelco
paths:
/v1/onboarding/tenant:
get:
tags:
- channelco
security:
- ApiKeyAuth: [ ]
summary: Get user's pod and availability for onboarding
operationId: getUserOnboardingAvailability
parameters:
- name: email
in: query
schema:
type: string
required: true
description: The user email
example: [email protected]
responses:
400:
description: Something was wrong about the request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
401:
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UserOnboardingAvaibilityResponse'
example: "Company is already on Symphony but user needs access"
/v1/channelco/user:
get:
tags:
- channelco
security:
- JwtAuth: [ ]
summary: Search channelco user
operationId: searchUser
parameters:
- name: email
in: query
schema:
type: string
required: true
description: user's email
example: [email protected]
responses:
200:
description: body
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelCoUserAndCompany'
404:
description: The user do not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
400:
description: Something was wrong about the request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
401:
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
post:
tags:
- channelco
security:
- JwtAuth: []
summary: Create channelco user
operationId: createUser
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelCoUsersListRequest'
responses:
201:
description: body
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelCoUsersListResponse'
400:
description: Something was wrong about the request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
401:
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v1/channelco/company/{companyId}/user/{userId}/roles/add:
post:
tags:
- channelco
security:
- JwtAuth: [ ]
summary: Adds a role to a channelco user's account
operationId: addRole
parameters:
- name: userId
in: path
schema:
type: integer
format: int64
required: true
description: symphony user id
example: 123456789
- name: companyId
in: path
schema:
type: string
required: true
description: company Id of the user
example: "10"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
responses:
200:
description: body
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInfo'
400:
description: Something was wrong about the request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
401:
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
404:
description: The user do not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v1/channelco/company/{companyId}/user/{userId}:
get:
tags:
- channelco
security:
- JwtAuth: [ ]
summary: Get channelco user by companyId and userId
operationId: getUser
parameters:
- name: userId
in: path
schema:
type: integer
format: int64
required: true
description: symphony user id
example: 123456789
- name: companyId
in: path
schema:
type: string
required: true
description: company Id of the user
example: "10"
responses:
200:
description: body
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelCoUserAndCompany'
404:
description: The user do not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
400:
description: Something was wrong about the request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
401:
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
put:
tags:
- channelco
security:
- JwtAuth: [ ]
summary: Update channelco user
operationId: updateUser
parameters:
- name: userId
in: path
schema:
type: integer
format: int64
required: true
description: symphony user id
example: 123456789
- name: companyId
in: path
schema:
type: string
required: true
description: company Id of the user
example: "10"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateChannelCoUserRequest'
responses:
200:
description: body
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelCoUser'
404:
description: The user do not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
400:
description: Something was wrong about the request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
401:
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
delete:
tags:
- channelco
security:
- JwtAuth: [ ]
summary: Disable channelco user
operationId: disableUser
parameters:
- name: userId
in: path
schema:
type: integer
format: int64
required: true
description: symphony user id
example: 123456789
- name: companyId
in: path
schema:
type: string
required: true
description: company Id of the user
example: "10"
responses:
204:
description: The user was disabled successfully.
404:
description: The user do not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
400:
description: Something was wrong about the request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
401:
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
components:
schemas:
ApiError:
type: object
properties:
code:
type: string
description: error code
message:
type: string
description: Human readable details about the error
details:
description: Full details about error, usefull for 400
type: object
ApiInfo:
type: object
properties:
code:
type: string
description: info code
message:
type: string
description: Human readable details about the information the api is returning
details:
description: Full details about info
type: object
Config:
type: object
properties:
id:
type: string
description: config key
value:
type: string
description: config value
required:
- id
ChannelCoPartner:
type: object
properties:
id:
type: string
description: partner id
name:
type: string
description: partner name
appName:
type: string
description: app name (visible in user invitation email)
supportSso:
type: boolean
description: support sso or not
ssoUrl:
type: string
description: if support sso enabled, the sso url
ssoType:
type: string
enum: [SAML, OAUTH]
defaultEmailLanguage:
type: string
description: Invitation email language used. It will work only if the template for the specified language is configured, if no custom language are configured, leave it empty
idp:
type: string
description: identity provider for partner
required:
- id
- name
- idp
UserOnboardingAvaibilityResponse:
allOf:
- $ref: '#/components/schemas/ApiInfo'
- type: object
properties:
podUrl:
type: string
example: ces4-dev.symphony.com
ChannelCoUserRequest:
type: object
description: payload to onboard a channelco user account
properties:
email:
type: string
format: email
example: [email protected]
firstName:
type: string
example: Paul
maxLength: 64
lastName:
type: string
example: Smith
maxLength: 64
displayName:
type: string
example: Paul Smith
maxLength: 128
description: if omitted, it will be generated with the pattern <firstName lastName>
phoneNumber:
type: string
example: +33612345678
department:
type: string
example: Product Engineering
maxLength: 256
title:
type: string
example: Engineering manager
maxLength: 256
location:
type: string
description: country
required:
- email
- firstName
- lastName
ChannelCoUsersListRequest:
type: object
description: payload to onboard channelco users
properties:
companyName:
type: string
description: This field is mandatory only if a company with same domain (taken from email) does not exist yet
example: Symphony
maxLength: 64
users:
type: array
items:
$ref: '#/components/schemas/ChannelCoUserRequest'
required:
- companyName
- users
UpdateChannelCoUserRequest:
type: object
description: payload to update a channelco user account
properties:
email:
type: string
format: email
example: [email protected]
firstName:
type: string
example: Paul
maxLength: 64
lastName:
type: string
example: Smith
maxLength: 64
displayName:
type: string
example: Paul Smith
phoneNumber:
type: string
example: +33612345678
department:
type: string
example: Product Engineering
maxLength: 256
title:
type: string
example: Engineering manager
maxLength: 256
location:
type: string
description: country
ChannelCoUser:
allOf:
- $ref: '#/components/schemas/ChannelCoUserRequest'
- type: object
properties:
userId:
type: integer
format: int64
description: Member's user id
username:
type: string
description: Member's username generated by API. If there is no naming conflict it is <firstName.lastName> (in lower case)
ChannelCoUserAndCompany:
allOf:
- $ref: '#/components/schemas/ChannelCoUser'
- type: object
properties:
companyId:
type: string
description: company Id of the user
example: "10"
companyName:
type: string
description: company name of the user
example: Symphony
maxLength: 64
ChannelCoUserResponse:
allOf:
- $ref: '#/components/schemas/ChannelCoUserRequest'
- type: object
properties:
userId:
type: integer
format: int64
description: Member's user id
username:
type: string
description: Member's username generated by API. It is expected to be the same as email
code:
type: string
description: info code
example:
newCompany:
value: USER_ADDED_NEW_COMPANY
description: new company created and user added into it
existingCompany:
value: USER_ADDED_EXISTING_COMPANY
description: company already exists, user added into it
mismatchCompany:
value: USER_ADDED_TO_DIFFERENT_COMPANY_NAME
description: company already exists (lookup by domain name), but the name is different. User is added in the existing one
message:
type: string
description: Human readable details about the information the api is returning
ChannelCoUserErrorResponse:
allOf:
- $ref: '#/components/schemas/ChannelCoUserRequest'
- type: object
properties:
code:
type: string
description: error code
example:
alreadyExisting:
value: USER_ALREADY_EXISTS
description: user already existing belong a pod (error message will provide detail about pod url)
existingCompany:
value: COMPANY_ALREADY_EXISTS_USER_NEEDS_ACCESS
description: company already exists and the user need access (error message will provide detail about pod url)
existingComCoCompany:
value: COMCO_COMPANY_ALREADY_EXISTS_USER_NEED_ACCESS
description: comco company already exists and the user need access
mismatchCompany:
value: UNEXPECTED_ERROR
message:
type: string
description: Human readable details about the information the api is returning
ChannelCoUsersListResponse:
type: object
properties:
companyId:
type: string
description: company Id of the users
example: "10"
companyName:
type: string
description: company name of the users
example: Symphony
maxLength: 64
success:
type: array
items:
$ref: '#/components/schemas/ChannelCoUserResponse'
errors:
type: array
items:
$ref: '#/components/schemas/ChannelCoUserErrorResponse'
Role:
type: object
properties:
id:
type: string
description: role Id
example: COMPLIANCE_OFFICER
required:
- id
securitySchemes:
JwtAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: ExtApp JWT
ApiKeyAuth:
type: apiKey
in: query
name: token
CommonJwtAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Common JWT
security:
- JwtAuth: []
- ApiKeyAuth: []