-
Notifications
You must be signed in to change notification settings - Fork 48
/
Copy pathprofile-manager-api.yaml
1081 lines (1035 loc) · 34.9 KB
/
profile-manager-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
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.0
info:
version: 1.0.0
title: Symphony Profile Manager
description: Profile Manager is a microservice to manage users profile and groups
servers:
- url: /profile-manager
paths:
/v1/groups/{groupId}/member:
post:
summary: Add a new user to a an existing group
parameters:
- in: header
name: X-Symphony-Host
schema:
type: string
description: headers to indentify the origin
nullable: false
minLength: 1
example: localhost.symphony.com
required: true
- in: path
name: groupId
schema:
type: string
nullable: false
description: Group id
example: WzEwMF1bU0RMXVtUZXN0IEdyb3VwXQ
required: true
description: Add a new user to a an existing group
operationId: addMemberToGroup
tags:
- group
requestBody:
$ref: '#/components/requestBodies/AddMemberRequestBody'
responses:
'200':
description: Successful response. Returns the group with the new add user as a member
headers:
Etag:
schema:
type: string
example: e3a52e72-0854-4401-8c24-e0b17c0ca304
content:
application/json:
schema:
$ref: '#/components/schemas/ReadGroup'
'400':
description: Returned if missing required parameters or wrong parameters
$ref: './symphony-common-definitions.yaml#/components/responses/BadRequest'
'401':
description: Returned if wrong or missing JWT token
$ref: './symphony-common-definitions.yaml#/components/responses/Unauthorized'
'403':
description: Returned if JWT token missing the required entitlement
$ref: './symphony-common-definitions.yaml#/components/responses/Forbidden'
'429':
description: Returned if the backend is overloaded
$ref: '#/components/responses/TooManyRequests'
'452':
description: Returned if there is a violation in info barrier rules. This error is not relevant in case of a Company group
$ref: '#/components/responses/InfoBarrierViolation'
/v1/groups:
post:
summary: Insert a new group
parameters:
- in: header
name: X-Symphony-Host
schema:
type: string
description: headers to indentify the originator
nullable: false
minLength: 1
example: localhost.symphony.com
required: true
description: Insert a new group into database
operationId: insertGroup
tags:
- group
requestBody:
$ref: '#/components/requestBodies/CreateGroupBody'
responses:
'201':
description: Successful response. Returns the group just created with the new added member
headers:
Etag:
schema:
type: string
example: e3a52e72-0854-4401-8c24-e0b17c0ca304
content:
application/json:
schema:
$ref: '#/components/schemas/ReadGroup'
'400':
description: Returned if missing required parameters, Trying to add a member which is already existing within the group list of members,
or the requested user member is already a part of company group in case of a company group type
$ref: './symphony-common-definitions.yaml#/components/responses/BadRequest'
'401':
description: Returned if wrong or missing JWT token
$ref: './symphony-common-definitions.yaml#/components/responses/Unauthorized'
'403':
description: Returned if JWT token missing the required entitlement
$ref: './symphony-common-definitions.yaml#/components/responses/Forbidden'
'429':
description: Returned if the backend is overloaded
$ref: '#/components/responses/TooManyRequests'
'452':
description: Returned if there is a violation in info barrier rules. This error is not relevant in case of a Company group
$ref: '#/components/responses/InfoBarrierViolation'
/v1/groups/{groupId}:
get:
summary: Retrieve a group
parameters:
- in: header
name: X-Symphony-Host
schema:
type: string
description: headers to indentify the originator
nullable: false
minLength: 1
example: localhost.symphony.com
required: true
- in: path
name: groupId
schema:
type: string
required: true
description: Group id
example: WzEwMF1bU0RMXVtUZXN0IEdyb3VwXQ
description: Retrieve a group
operationId: getGroup
tags:
- group
responses:
'200':
description: Successful response. Returns the group
headers:
Etag:
schema:
type: string
example: e3a52e72-0854-4401-8c24-e0b17c0ca304
content:
application/json:
schema:
$ref: '#/components/schemas/ReadGroup'
'400':
description: Returned if missing required parameters or wrong parameters
$ref: './symphony-common-definitions.yaml#/components/responses/BadRequest'
'401':
description: Returned if wrong or missing JWT token
$ref: './symphony-common-definitions.yaml#/components/responses/Unauthorized'
'403':
description: Returned if JWT token missing the required entitlement
$ref: './symphony-common-definitions.yaml#/components/responses/Forbidden'
'404':
description: Returned if groupId is not found
$ref: './symphony-common-definitions.yaml#/components/responses/NotFound'
'429':
description: Returned if the backend is overloaded
$ref: '#/components/responses/TooManyRequests'
put:
summary: Update a group
parameters:
- in: header
name: X-Symphony-Host
schema:
type: string
description: headers to indentify the originator
nullable: false
minLength: 1
example: localhost.symphony.com
required: true
- in: header
name: If-Match
schema:
type: string
description: ETag of group to be updated
example: e3a52e72-0854-4401-8c24-e0b17c0ca304
required: true
- in: path
name: groupId
schema:
type: string
required: true
description: Group id
example: 60af77fd294165466ccdf510
description: Update an existing group
operationId: updateGroup
tags:
- group
requestBody:
$ref: '#/components/requestBodies/UpdateGroupBody'
responses:
'200':
description: Successful response. Returns the group just updated
headers:
Etag:
schema:
type: string
example: e3a52e72-0854-4401-8c24-e0b17c0ca304
content:
application/json:
schema:
$ref: '#/components/schemas/ReadGroup'
'400':
description: Returned if missing required parameters or wrong parameters
$ref: './symphony-common-definitions.yaml#/components/responses/BadRequest'
'401':
description: Returned if wrong or missing JWT token
$ref: './symphony-common-definitions.yaml#/components/responses/Unauthorized'
'403':
description: Returned if JWT token missing the required entitlement
$ref: './symphony-common-definitions.yaml#/components/responses/Forbidden'
'404':
description: Returned if groupId is not found
$ref: './symphony-common-definitions.yaml#/components/responses/NotFound'
'412':
description: The update is rejected because concurrent update
$ref: './symphony-common-definitions.yaml#/components/responses/PreconditionFailed'
'429':
description: Returned if the backend is overloaded
$ref: '#/components/responses/TooManyRequests'
'452':
description: Returned if there is a violation in info barrier rules. This error is not relevant in case of a Company group
$ref: '#/components/responses/InfoBarrierViolation'
/v1/groups/type/{typeId}:
get:
summary: List all groups of specified type
parameters:
- in: header
name: X-Symphony-Host
schema:
type: string
description: headers to indentify the originator
nullable: false
minLength: 1
example: localhost.symphony.com
required: true
- in: path
name: typeId
schema:
type: string
required: true
description: Group type id
example: SDL
- in: query
name: status
schema:
$ref: '#/components/schemas/Status'
required: false
description: filter by status, active or deleted. If not specified both are returned
example: ACTIVE
- in: query
name: before
schema:
type: string
required: false
description: NOT SUPPORTED YET, currently ignored. Cursor that points to the start of the current page of data. If not present, the current page is the first page
- in: query
name: after
schema:
type: string
required: false
description: cursor that points to the end of the current page of data. If not present, the current page is the last page
- in: query
name: limit
schema:
type: integer
required: false
description: numbers of items to return
example: 100
- in: query
name: sortOrder
schema:
$ref: '#/components/schemas/SortOrder'
required: false
description: items sorting direction (ordered by createdDate)
example: ASC
operationId: listGroups
tags:
- group
responses:
'200':
description: Successful response. Returns the list of all groups
content:
application/json:
schema:
$ref: '#/components/schemas/GroupList'
'400':
description: Returned if missing required parameters or wrong parameters
$ref: './symphony-common-definitions.yaml#/components/responses/BadRequest'
'401':
description: Returned if wrong or missing JWT token
$ref: './symphony-common-definitions.yaml#/components/responses/Unauthorized'
'403':
description: Returned if JWT token missing the required entitlement
$ref: './symphony-common-definitions.yaml#/components/responses/Forbidden'
'404':
description: Returned if typeId is not found
$ref: './symphony-common-definitions.yaml#/components/responses/NotFound'
'429':
description: Returned if the backend is overloaded
$ref: '#/components/responses/TooManyRequests'
/v1/groups/{groupId}/avatar:
post:
summary: Update the group avatar
parameters:
- in: header
name: X-Symphony-Host
schema:
type: string
description: headers to indentify the originator
nullable: false
minLength: 1
example: localhost.symphony.com
required: true
- in: path
name: groupId
schema:
type: string
required: true
description: Group id
example: 60af77fd294165466ccdf510
description: Update the group account avatar
operationId: updateAvatar
tags:
- group
requestBody:
$ref: '#/components/requestBodies/UpdateAvatar'
responses:
'200':
description: Successful response. Returns the group with the avatar updated
headers:
Etag:
schema:
type: string
example: e3a52e72-0854-4401-8c24-e0b17c0ca304
content:
application/json:
schema:
$ref: '#/components/schemas/ReadGroup'
'400':
description: Returned if missing required parameters or wrong parameters
$ref: './symphony-common-definitions.yaml#/components/responses/BadRequest'
'401':
description: Returned if wrong or missing JWT token
$ref: './symphony-common-definitions.yaml#/components/responses/Unauthorized'
'403':
description: Returned if JWT token missing the required entitlement
$ref: './symphony-common-definitions.yaml#/components/responses/Forbidden'
'404':
description: Returned if groupId is not found
$ref: './symphony-common-definitions.yaml#/components/responses/NotFound'
'429':
description: Returned if the backend is overloaded
$ref: '#/components/responses/TooManyRequests'
/v1/groups/deleteAll:
delete:
summary: Delete all data related to the current pod (extracted from JWT). This endpoint is for maintenance/test and it is usually disabled or restricted
parameters:
- in: header
name: X-Symphony-Host
schema:
type: string
description: headers to indentify the originator
nullable: false
minLength: 1
example: localhost.symphony.com
required: true
operationId: deleteAllGroups
tags:
- group
responses:
'200':
description: Successful response. Returns the list of all groups (it should be empty)
content:
application/json:
schema:
$ref: '#/components/schemas/GroupList'
'400':
description: Returned if missing required parameters or wrong parameters
$ref: './symphony-common-definitions.yaml#/components/responses/BadRequest'
'401':
description: Returned if wrong or missing JWT token
$ref: './symphony-common-definitions.yaml#/components/responses/Unauthorized'
'403':
description: Returned if JWT token missing the required entitlement
$ref: './symphony-common-definitions.yaml#/components/responses/Forbidden'
'429':
description: Returned if the backend is overloaded
$ref: '#/components/responses/TooManyRequests'
/v1/types:
get:
summary: List all types
parameters:
- in: header
name: X-Symphony-Host
schema:
type: string
description: headers to indentify the originator
nullable: false
minLength: 1
example: localhost.symphony.com
required: true
- in: query
name: status
schema:
$ref: '#/components/schemas/Status'
required: false
example: ACTIVE
- in: query
name: before
schema:
type: string
required: false
description: NOT SUPPORTED YET, currently ignored. Cursor that points to the start of the current page of data. If not present, the current page is the first page
- in: query
name: after
schema:
type: string
required: false
description: cursor that points to the end of the current page of data. If not present, the current page is the last page
- in: query
name: limit
schema:
type: integer
required: false
description: numbers of items to return
example: 100
- in: query
name: sortOrder
schema:
$ref: '#/components/schemas/SortOrder'
required: false
description: items sorting direction (ordered by createdDate)
example: ASC
operationId: listTypes
tags:
- type
responses:
'200':
description: Successful response. Returns the list of all types
content:
application/json:
schema:
$ref: '#/components/schemas/TypeList'
'401':
description: Returned if wrong or missing JWT token
$ref: './symphony-common-definitions.yaml#/components/responses/Unauthorized'
'403':
description: Returned if JWT token missing the required entitlement
$ref: './symphony-common-definitions.yaml#/components/responses/Forbidden'
'429':
description: Returned if the backend is overloaded
$ref: '#/components/responses/TooManyRequests'
/v1/types/{typeId}:
get:
summary: Retrieve a type
parameters:
- in: header
name: X-Symphony-Host
schema:
type: string
description: headers to indentify the originator
nullable: false
minLength: 1
example: localhost.symphony.com
required: true
- in: path
name: typeId
schema:
type: string
required: true
description: Type id
example: SDL
description: Retrieve a type
operationId: getType
tags:
- type
responses:
'200':
description: Successful response. Returns the type
content:
application/json:
schema:
$ref: '#/components/schemas/Type'
'400':
description: Returned if missing required parameters or wrong parameters
$ref: './symphony-common-definitions.yaml#/components/responses/BadRequest'
'401':
description: Returned if wrong or missing JWT token
$ref: './symphony-common-definitions.yaml#/components/responses/Unauthorized'
'403':
description: Returned if JWT token missing the required entitlement
$ref: './symphony-common-definitions.yaml#/components/responses/Forbidden'
'404':
description: Returned if type id is not found
$ref: './symphony-common-definitions.yaml#/components/responses/NotFound'
'429':
description: Returned if the backend is overloaded
$ref: '#/components/responses/TooManyRequests'
components:
schemas:
BaseGroup:
description: >-
A reduced set Group object, for retrieving list of group purpose
properties:
type:
type: string
nullable: false
minLength: 1
description: Group type identifier
example: SDL
ownerType:
$ref: '#/components/schemas/Owner'
nullable: false
ownerId:
type: integer
format: int64
description: Owner id if the owner type is tenant (podId) or user (userId), otherwise null
example: 100
name:
type: string
nullable: false
minLength: 1
description: Group's name
example: Test Group
required:
- type
- ownerType
- ownerId
- name
ReadGroup:
allOf:
- $ref: '#/components/schemas/BaseGroup'
- type: object
required:
- rootCause
properties:
id:
type: string
description: Group's unique identifier
# Metadata fields required by
# https://perzoinc.atlassian.net/wiki/spaces/SysArch/pages/408977427/API+2.0+Standards#API2.0Standards-MetadataFields
# eTag is on ReadGroup, to avoid allow update a group when only partial group information has been retrieved
createdDate:
type: string
format: date-time
createdBy:
type: string
updatedDate:
type: string
format: date-time
updatedBy:
type: string
status:
$ref: '#/components/schemas/Status'
# End metadata fields
eTag:
type: string
example: e3a52e72-0854-4401-8c24-e0b17c0ca304
subType:
type: string
enum: [ COMMUNITY, CHANNEL ]
description: The type of the company group, This field is mandatory in case of a company group type, but not applicable for Symphony Distribution List
example: COMMUNITY
referrer:
type: string
description: The referring company name. This field is mandatory in case of a company group type, but not applicable for Symphony Distribution List
example: Symphony, referring company name, referring channel partner name
members:
type: array
items:
$ref: '#/components/schemas/ReadMember'
profile:
$ref: '#/components/schemas/Profile'
description: The profile is not supported for company group, but only works with SDL as group type
visibilityRestriction:
$ref: '#/components/schemas/GroupVisibilityRestriction'
implicitConnection:
$ref: '#/components/schemas/GroupImplicitConnection'
interactionTransfer:
$ref: '#/components/schemas/GroupInteractionTransfer'
CreateGroup:
allOf:
- $ref: '#/components/schemas/BaseGroup'
- type: object
required:
- rootCause
properties:
subType:
type: string
enum: [ COMMUNITY, CHANNEL]
description: The type of the company group, This field is mandatory in case of a company group type, but not applicable for Symphony Distribution List
example: COMMUNITY
referrer:
type: string
description: The referring company name. This field is mandatory in case of a company group type, but not applicable for Symphony Distribution List
example: Symphony, referring company name, referring channel partner name
members:
type: array
items:
$ref: '#/components/schemas/Member'
profile:
$ref: '#/components/schemas/BaseProfile'
description: The profile is not supported for company group, but only works with SDL as group type
required: true
visibilityRestriction:
$ref: '#/components/schemas/GroupVisibilityRestriction'
implicitConnection:
$ref: '#/components/schemas/GroupImplicitConnection'
interactionTransfer:
$ref: '#/components/schemas/GroupInteractionTransfer'
UpdateGroup:
allOf:
- $ref: '#/components/schemas/CreateGroup'
- type: object
required:
- rootCause
properties:
id:
type: string
description: Group's unique identifier
nullable: false
minLength: 1
example: 60af77fd294165466ccdf510
status:
$ref: '#/components/schemas/Status'
eTag:
type: string
example: e3a52e72-0854-4401-8c24-e0b17c0ca304
nullable: false
minLength: 1
Member:
description: >-
A Group member.
properties:
memberTenant:
type: integer
description: Member's tenant id
nullable: false
example: 100
memberId:
type: integer
format: int64
description: Member's user id
nullable: false
example: 12345678900000
ReadMember:
allOf:
- $ref: '#/components/schemas/Member'
- type: object
required:
- rootCause
properties:
addedDate:
description: Date/time when the member has been added in the group in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sZ)
type: string
format: 'date-time'
status:
description: Some group types (e.g. COMPANY) keep disabled users, flagging them as DISABLED. However, this attribute is not relevant for group types (e.g. SDL) that remove (instead of flag) disabled user from group
type: string
enum: [ ENABLED, DISABLED ]
example: ENABLED
GroupVisibilityRestriction:
description: >-
Group visibility restriction.
properties:
restrictedTenantsList:
type: array
items:
type: integer
example: [100]
restrictedUsersList:
type: array
items:
type: integer
format: int64
example: [12345678900000]
GroupImplicitConnection:
description: >-
Group implicit connections.
properties:
connectedTenantsList:
type: array
items:
type: integer
example: [100]
connectedUsersList:
type: array
items:
type: integer
format: int64
example: [12345678900000]
GroupInteractionTransfer:
description: >-
Group interaction transfer.
properties:
restrictedTenantsList:
type: array
items:
type: integer
example: [100]
restrictedUsersList:
type: array
items:
type: integer
format: int64
example: [12345678900000]
BaseProfile:
description: The group's profile. Please note that in case of a company group type, the profile shouldn't be provided when creating a new company and do not exist in case of an existing company group
properties:
displayName:
type: string
description: >-
The display name in Directory, it is expected to be the same as group name
nullable: false
minLength: 1
example: Test Group
companyName:
type: string
description: >-
The company name is expected to be the same as group company owner
example: Acme Corporation
email:
type: string
example: testgroup@acme.com
mobile:
type: string
example: +33(0)600000000
jobTitle:
type: string
jobRole:
type: string
example: Director
jobDepartment:
type: string
jobDivision:
type: string
jobPhone:
type: string
jobCity:
type: string
industryOfInterest:
type: array
items:
type: string
example: ["Services"]
assetClassesOfInterest:
type: array
items:
type: string
example: ["Equities"]
marketCoverage:
type: array
uniqueItems: true
items:
type: string
example: ["EMEA"]
responsibility:
type: array
uniqueItems: true
items:
type: string
example: ["Escalation"]
function:
type: array
uniqueItems: true
items:
type: string
example: ["Collateral"]
instrument:
type: array
uniqueItems: true
items:
type: string
example: ["Equities"]
Profile:
allOf:
- $ref: '#/components/schemas/BaseProfile'
- type: object
required:
- rootCause
properties:
id:
type: string
description: Profile unique identifier
avatars:
type: array
items:
$ref: '#/components/schemas/Avatar'
Avatar:
properties:
size:
type: string
url:
type: string
BaseType:
description: >-
A reduced set Type object, for retrieving list of types purpose
properties:
id:
type: string
description: Type identifier
example: SDL
ownerType:
$ref: '#/components/schemas/Owner'
example: TENANT
name:
type: string
description: Type's name
example: Symphony Distribution List
status:
$ref: '#/components/schemas/Status'
Type:
allOf:
- $ref: '#/components/schemas/BaseType'
- type: object
required:
- rootCause
properties:
profileControl:
$ref: '#/components/schemas/ProfileControl'
membershipControl:
$ref: '#/components/schemas/MembershipControl'
interactionControl:
$ref: '#/components/schemas/InteractionControl'
ProfileControl:
properties:
visibilityRestriction:
$ref: '#/components/schemas/VisibilityRestriction'
implicitConnection:
$ref: '#/components/schemas/ImplicitConnection'
wallSupport:
type: boolean
description: Not supported yet
profileFields:
type: array
uniqueItems: true
items:
type: string
searchFields:
type: array
uniqueItems: true
items:
type: string
canHavePublicProfile:
type: boolean
description: For the SDL groupe type this flag is true, for the company groupe type it is false
default: true
MembershipControl:
properties:
entitlements:
type: array
uniqueItems: true
items:
type: string
manualMembership:
type: boolean
ruleMembership:
type: boolean
description: Not supported yet
updateMembershipOnRuleUpdate:
type: boolean
description: Not supported yet
notifyMembersOnUpdate:
type: boolean
canBelongToMultipleGroup:
type: boolean
description: For the SDL groupe type this flag is true, for the company groupe type it is false
default: true
InteractionControl:
properties:
allowIMs:
type: boolean
allowRooms:
type: boolean
interactionTransfer:
$ref: '#/components/schemas/InteractionTransfer'
tagStream:
type: string
canHaveInteraction:
type: boolean
description: For the SDL groupe type this flag is true, for the company groupe type it is false
default: true
VisibilityRestriction:
properties:
visible:
type: boolean
restrictToTenants:
type: boolean
description: Not supported yet
restrictToUsers:
type: boolean
description: Not supported yet
ImplicitConnection:
properties:
all:
type: boolean
connectToTenants:
type: boolean
description: Not supported yet
connectToUsers:
type: boolean
description: Not supported yet
InteractionTransfer:
properties:
target:
type: string
enum: [TO_USER, TO_MEMBERS, NONE]
description: Only TO_MEMBERS supported now
example: TO_MEMBERS
updateInteractionOngroupUpdate:
type: boolean
systemMessageOnInteraction:
type: boolean
description: Not supported yet
transferView:
$ref: '#/components/schemas/TransferView'
auditTransfer:
type: boolean
TransferView:
properties:
visible:
type: boolean
restrictToTenants:
type: boolean
restrictToUsers:
type: boolean
description: Not supported yet
GroupList:
properties:
pagination:
$ref: './symphony-common-definitions.yaml#/components/schemas/Pagination'
data:
type: array
items:
$ref: '#/components/schemas/ReadGroup'
TypeList:
properties:
pagination:
$ref: './symphony-common-definitions.yaml#/components/schemas/Pagination'
data:
type: array
items:
$ref: '#/components/schemas/BaseType'
Owner:
type: string
enum:
- PLATFORM
- TENANT
- USER
description: Owner type. Ony TENANT supported now
example: TENANT
Status:
type: string
enum:
- ACTIVE
- DELETED
description: Status flag to distinguish between active and deleted objects
example: ACTIVE
SortOrder:
type: string
enum:
- ASC