-
Notifications
You must be signed in to change notification settings - Fork 149
/
scim2.yaml
3663 lines (3516 loc) · 99.6 KB
/
scim2.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:
version: "1.0.0"
title: SCIM 2.0 Endpoint Swagger Definition
description: |
SCIM 2.0 endpoints
It is written with [swagger 2](http://swagger.io/).
contact:
name: WSO2 Identity Server Team
url: 'http://wso2.com/products/identity-server'
email: "iam-dev@wso2.org"
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0'
# The base path of the SCIM2 API.
# If the tenant domain is carbon.super then basepath can be /scim2.
# host: localhost:9443
# basePath: /t/{tenant-domain}/scim2
schemes:
- https
produces:
- application/scim+json
# Applicable authentication mechanisms.
security:
- OAuth2: []
- BasicAuth: []
paths:
/Me:
get:
tags:
- Me Endpoint
summary: Get Me
description: |
This API returns the user details of the currently authenticated user.
<b>Permission required:</b>
* /permission/admin/login
parameters:
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
responses:
200:
description: Valid user is found
schema:
$ref: '#/definitions/UserResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
404:
description: Valid User is not found
schema:
$ref: '#/definitions/ErrorUserNotAvailable'
post:
tags:
- Me Endpoint
summary: Create Me
description: |
This API is used to register a user anonymously.
<b>Permission required:</b>
* /permission/admin/manage/identity/usermgt/create
operationId: createUserMe
consumes:
- application/scim+json
produces:
- application/scim+json
parameters:
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
- in: body
name: body
required: true
description: User details to add.
schema:
$ref: '#/definitions/UserObject'
responses:
201:
description: User is created.
schema:
$ref: '#/definitions/UserResponseObject'
400:
description: Invalid Input
schema:
$ref: '#/definitions/ErrorInvalidInput'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
404:
description: Valid User is not found
schema:
$ref: '#/definitions/ErrorUserNotAvailable'
500:
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorInternalServerError'
put:
tags:
- Me Endpoint
summary: Update Me
description: |
This API uses a PUT operation to update user details.
<b>Permission required:</b>
* /permission/admin/login
operationId: updateUserMe
consumes:
- application/scim+json
produces:
- application/scim+json
parameters:
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
- in: body
name: body
required: true
schema:
$ref: '#/definitions/UserUpdateObject'
responses:
200:
description: User is updated
schema:
$ref: '#/definitions/UserResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
404:
description: Valid user is not found
schema:
$ref: '#/definitions/ErrorUserNotAvailable'
delete:
tags:
- Me Endpoint
summary: Delete Me
description: |
This API is used to delete the currently authenticated user.
<b>Permission required:</b>
* /permission/admin/manage/identity/usermgt/delete
operationId: deleteUserMe
produces:
- application/scim+json
parameters: []
responses:
204:
description: User is deleted
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
404:
description: Valid user is not found
schema:
$ref: '#/definitions/ErrorUserNotAvailable'
501:
description: Self delete is not suported
schema:
$ref: '#/definitions/ErrorNotimplemented'
patch:
tags:
- Me Endpoint
summary: Update Me - PATCH
description: |
This API uses a PATCH operation to update user details.
<b>Permission required:</b>
* /permission/admin/login
operationId: patchUserMe
consumes:
- application/scim+json
produces:
- application/scim+json
parameters:
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/PatchOpperationInput'
responses:
200:
description: User is updated
schema:
$ref: '#/definitions/PatchOperationResponseOutput'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
404:
description: Valid user is not found
schema:
$ref: '#/definitions/ErrorUserNotAvailable'
/Groups:
get:
tags:
- Groups Endpoint
summary: Filter Groups
description: |
This API returns groups according to the specified filter, sort and pagination parameters.
<b>Permission required:</b>
* / permission/admin/manage/identity/rolemgt/view
operationId: getGroup
produces:
- application/scim+json
parameters:
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
- name: filter
in: query
description: Filter expression for filtering
required: false
type: string
- name: startIndex
in: query
description: The 1-based index of the first query result
required: false
type: integer
format: int32
- name: count
in: query
description: Specifies the desired maximum number of query results per page.
required: false
type: integer
format: int32
- name: sortBy
in: query
description: |-
Specifies the attribute whose value
SHALL be used to order the returned responses
required: false
type: string
- name: sortOder
in: query
description: The order in which the "sortBy" parameter is applied.
required: false
type: string
- name: domain
in: query
description: The name of the user store where filtering needs to be applied.
required: false
type: string
responses:
200:
description: Valid groups are found
schema:
$ref: '#/definitions/GroupsListResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: No Group found
schema:
$ref: '#/definitions/ErrorNoGroupAvailable'
post:
tags:
- Groups Endpoint
summary: Create Group
description: |
This API creates a group and returns the details of the created group including its unique ID.
<b>Permission required:</b>
* /permission/admin/manage/identity/rolemgt/create
operationId: createGroup
consumes:
- application/scim+json
produces:
- application/scim+json
parameters:
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/GroupRequestObject'
responses:
201:
description: Valid group is created
schema:
$ref: '#/definitions/GroupResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Group is not found
schema:
$ref: '#/definitions/ErrorGroupNotAvailable'
409:
description: Group already exist
schema:
$ref: '#/definitions/ErroGroupAlreadyAvailable'
/Groups/.search:
post:
tags:
- Groups Endpoint
summary: Search Groups
description: |
This API returns groups according to the specified filter, sort and pagination parameters.
<b>Permission required:</b>
* /permission/admin/manage/identity/rolemgt/create
operationId: getGroupsByPost
consumes:
- application/scim+json
produces:
- application/scim+json
parameters:
- in: body
name: body
required: false
schema:
$ref: '#/definitions/GroupSearchRequestObject'
responses:
200:
description: Valid groups are found
schema:
$ref: '#/definitions/GroupSearchResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid groups are not found
schema:
$ref: '#/definitions/GroupSearchErrorResponseObject'
'/Groups/{id}':
get:
tags:
- Groups Endpoint
summary: Get Group by ID
description: |
This API returns the group details of a particular group using its unique ID.
<b>Permission required:</b>
* /permission/admin/manage/identity/rolemgt/view
operationId: getGroup by id
produces:
- application/scim+json
parameters:
- name: id
in: path
description: Unique ID of the resource type.
required: true
type: string
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
responses:
200:
description: Valid group is found
schema:
$ref: '#/definitions/GroupResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid group is not found
schema:
$ref: '#/definitions/ErrorNoGroupAvailable'
put:
tags:
- Groups Endpoint
summary: Update Group - PUT
description: |
This API updates the group details and returns the updated group details using a PUT operation.
<b>Permission required:</b>
* /permission/admin/manage/identity/rolemgt/update
operationId: updateGroup
consumes:
- application/scim+json
produces:
- application/scim+json
parameters:
- name: id
in: path
description: Unique ID of the resource type.
required: true
type: string
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/GroupPutRequestObject'
responses:
200:
description: Group is updated
schema:
$ref: '#/definitions/GroupPutResponseObject'
400:
description: Invalid Input
schema:
$ref: '#/definitions/ErrorInvalidInput'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid group is not found
schema:
$ref: '#/definitions/ErrorNoGroupAvailable'
delete:
tags:
- Groups Endpoint
summary: Delete Group
description: |
This API deletes a particular group using its unique ID.
<b>Permission required:</b>
* /permission/admin/manage/identity/rolemgt/delete
operationId: deleteGroup
produces:
- application/scim+json
parameters:
- name: id
in: path
description: Unique ID of the resource type.
required: true
type: string
responses:
204:
description: Group is deleted
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid group is not found
schema:
$ref: '#/definitions/ErrorNoGroupAvailable'
patch:
tags:
- Groups Endpoint
summary: Update Group - PATCH
description: |
This API updates the group details and returns the updated group details using a PATCH operation.
<b>Permission required:</b>
* /permission/admin/manage/identity/rolemgt/update
operationId: patchGroup
consumes:
- application/scim+json
produces:
- application/scim+json
parameters:
- name: id
in: path
description: Unique id of the resource type.
required: true
type: string
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/PatchGroupOperationRequestObject'
responses:
200:
description: Group is updated
schema:
$ref: '#/definitions/PatchGroupOperationResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid group is not found
schema:
$ref: '#/definitions/ErrorNoGroupAvailable'
/Users:
get:
tags:
- Users Endpoint
summary: Filter Users
description: |
This API returns users according to the filter, sort and pagination parameters. Pagination is not supported across user stores and LDAP multi-attribute group filtering. However, filtering is supported across multiple user stores.
<b>Permission required:</b>
* /permission/admin/manage/identity/usermgt/view
operationId: getUser
produces:
- application/scim+json
parameters:
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
- name: filter
in: query
description: |
Filter expression for filtering. Supported filters are ‘Ew’, ‘Eq’, ‘Co’, ‘Sw’, ‘and’.
required: false
type: string
- name: startIndex
in: query
description: The 1-based index of the first query result
required: false
type: integer
format: int32
- name: count
in: query
description: Specifies the desired maximum number of query results per page.
required: false
type: integer
format: int32
- name: sortBy
in: query
description: |-
Specifies the attribute whose value
SHALL be used to order the returned responses.
required: false
type: string
- name: sortOder
in: query
description: The order in which the "sortBy" parameter is applied.
required: false
type: string
- name: domain
in: query
description: The name of the user store where filtering needs to be applied.
required: false
type: string
responses:
200:
description: Valid users are found
schema:
$ref: '#/definitions/UserObjectListResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid users are not found
schema:
$ref: '#/definitions/GroupSearchErrorResponseObject'
post:
tags:
- Users Endpoint
summary: Create User
description: |
This API creates a user and returns the user details along with the user's unique ID.
<b>Permission required:</b>
* /permission/admin/manage/identity/usermgt/view
operationId: createUser
consumes:
- application/scim+json
parameters:
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/UserObject'
responses:
201:
description: User is created.
schema:
$ref: '#/definitions/UserResponseObject'
400:
description: Invalid Input
schema:
$ref: '#/definitions/ErrorInvalidInput'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid User is not found
schema:
$ref: '#/definitions/ErrorUserNotAvailable'
500:
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorInternalServerError'
/Users/.search:
post:
tags:
- Users Endpoint
summary: Search Users
description: |
This API returns users according to the filter, sort and pagination parameters.
<b>Permission required:</b>
* /permission/admin/manage/identity/usermgt/create
operationId: getUsersByPost
consumes:
- application/scim+json
produces:
- application/scim+json
parameters:
- in: body
name: body
required: false
schema:
$ref: '#/definitions/UserSearchRequestObject'
responses:
200:
description: Valid users are found
schema:
$ref: '#/definitions/UserObjectListResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid users are not found
schema:
$ref: '#/definitions/GroupSearchErrorResponseObject'
'/Users/{id}':
get:
tags:
- Users Endpoint
summary: Get User by ID
description: |
Return user details if a user found.
<b>Permission required:</b>
* /permission/admin/manage/identity/usermgt/view
operationId: getUser by id
produces:
- application/scim+json
parameters:
- name: id
in: path
description: Unique ID of the resource type.
required: true
type: string
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
responses:
200:
description: Valid user is found
schema:
$ref: '#/definitions/UserResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid user is not found
schema:
$ref: '#/definitions/ErrorUserNotAvailable'
put:
tags:
- Users Endpoint
summary: Update User - PUT
description: |
This API updates user details and returns the updated user details using a PUT operation.
<b>Permission required:</b>
* /permission/admin/manage/identity/usermgt/update
operationId: updateUser
consumes:
- application/scim+json
produces:
- application/scim+json
parameters:
- name: id
in: path
description: Unique ID of the resource type.
required: true
type: string
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/UserUpdateObject'
responses:
200:
description: Valid user is found
schema:
$ref: '#/definitions/UserResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid user is not found
schema:
$ref: '#/definitions/ErrorUserNotAvailable'
delete:
tags:
- Users Endpoint
summary: Delete User by ID
description: |
This API deletes a user using the user's unique ID.
<b>Permission required:</b>
* /permission/admin/manage/identity/usermgt/delete
operationId: deleteUser
produces:
- application/scim+json
parameters:
- name: id
in: path
description: Unique ID of the resource type.
required: true
type: string
responses:
204:
description: User is deleted
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid user is not found
schema:
$ref: '#/definitions/ErrorUserNotAvailable'
patch:
tags:
- Users Endpoint
summary: Update User - PATCH
description: |
This API updates user details and returns the updated user details using a PATCH operation.
<b>Permission required:</b>
* /permission/admin/manage/identity/usermgt/update
<b>Supported Operations:</b>
* add
* replace
* remove
operationId: patchUser
consumes:
- application/scim+json
produces:
- application/scim+json
parameters:
- name: id
in: path
description: Unique id of the resource type.
required: true
type: string
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/PatchOpperationInput'
responses:
200:
description: Valid user is found
schema:
$ref: '#/definitions/UserResponseObject'
401:
description: Unauthorized
schema:
$ref: '#/definitions/ErrorUnauthorized'
403:
description: Forbidden
schema:
$ref: '#/definitions/ErrorForbidden'
404:
description: Valid user is not found
schema:
$ref: '#/definitions/ErrorUserNotAvailable'
/Roles:
get:
deprecated: true
tags:
- Roles Endpoint
summary: Filter Roles
description: |
This API returns roles according to the specified filter, sort and pagination parameters.
<b>Permission required:</b>
* / permission/admin/manage/identity/rolemgt/view
operationId: getRole
produces:
- application/scim+json
parameters:
- name: filter