@iblai/iblai-api 4.29.0-core → 4.30.0-core
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js +223 -213
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +223 -213
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +223 -213
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +11 -0
- package/dist/types/models/SCIMAddress.d.ts +33 -0
- package/dist/types/models/SCIMDepartment.d.ts +26 -0
- package/dist/types/models/SCIMEmail.d.ts +17 -0
- package/dist/types/models/SCIMEnterpriseUser.d.ts +29 -0
- package/dist/types/models/SCIMGroup.d.ts +38 -0
- package/dist/types/models/SCIMMeta.d.ts +25 -0
- package/dist/types/models/SCIMName.d.ts +17 -0
- package/dist/types/models/SCIMPhoneNumber.d.ts +13 -0
- package/dist/types/models/SCIMUserCreateRequest.d.ts +110 -0
- package/dist/types/models/SCIMUserListResponse.d.ts +17 -0
- package/dist/types/models/SCIMUserResponse.d.ts +41 -0
- package/dist/types/services/ScimService.d.ts +165 -162
- package/package.json +1 -1
- package/sdk_schema.yml +1326 -192
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +11 -0
- package/src/models/SCIMAddress.ts +38 -0
- package/src/models/SCIMDepartment.ts +31 -0
- package/src/models/SCIMEmail.ts +22 -0
- package/src/models/SCIMEnterpriseUser.ts +34 -0
- package/src/models/SCIMGroup.ts +43 -0
- package/src/models/SCIMMeta.ts +30 -0
- package/src/models/SCIMName.ts +22 -0
- package/src/models/SCIMPhoneNumber.ts +18 -0
- package/src/models/SCIMUserCreateRequest.ts +115 -0
- package/src/models/SCIMUserListResponse.ts +22 -0
- package/src/models/SCIMUserResponse.ts +46 -0
- package/src/services/ScimService.ts +270 -249
package/sdk_schema.yml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
openapi: 3.0.3
|
|
2
2
|
info:
|
|
3
3
|
title: ibl-data-manager
|
|
4
|
-
version: 4.
|
|
4
|
+
version: 4.30.0-core
|
|
5
5
|
description: API for iblai
|
|
6
6
|
paths:
|
|
7
7
|
/api/analytics/learners/:
|
|
@@ -20795,15 +20795,14 @@ paths:
|
|
|
20795
20795
|
schema:
|
|
20796
20796
|
$ref: '#/components/schemas/ErrorResponse'
|
|
20797
20797
|
description: ''
|
|
20798
|
-
/api/orgs/{
|
|
20798
|
+
/api/orgs/{platform_key}/scim/v2/DepartmentMembers/:
|
|
20799
20799
|
get:
|
|
20800
|
-
operationId:
|
|
20801
|
-
description:
|
|
20802
|
-
|
|
20803
|
-
List all department members in the system.
|
|
20800
|
+
operationId: list_department_members
|
|
20801
|
+
description: List all department members in the system for the specified platform
|
|
20802
|
+
summary: List all department members in the system
|
|
20804
20803
|
parameters:
|
|
20805
20804
|
- in: path
|
|
20806
|
-
name:
|
|
20805
|
+
name: platform_key
|
|
20807
20806
|
schema:
|
|
20808
20807
|
type: string
|
|
20809
20808
|
required: true
|
|
@@ -20813,15 +20812,32 @@ paths:
|
|
|
20813
20812
|
- PlatformApiKeyAuthentication: []
|
|
20814
20813
|
responses:
|
|
20815
20814
|
'200':
|
|
20816
|
-
|
|
20815
|
+
content:
|
|
20816
|
+
application/json:
|
|
20817
|
+
schema:
|
|
20818
|
+
type: array
|
|
20819
|
+
items:
|
|
20820
|
+
description: List of department members in SCIM format
|
|
20821
|
+
description: ''
|
|
20822
|
+
'401':
|
|
20823
|
+
content:
|
|
20824
|
+
application/json:
|
|
20825
|
+
schema:
|
|
20826
|
+
description: Unauthorized
|
|
20827
|
+
description: ''
|
|
20828
|
+
'403':
|
|
20829
|
+
content:
|
|
20830
|
+
application/json:
|
|
20831
|
+
schema:
|
|
20832
|
+
description: Forbidden
|
|
20833
|
+
description: ''
|
|
20817
20834
|
post:
|
|
20818
|
-
operationId:
|
|
20819
|
-
description:
|
|
20820
|
-
|
|
20821
|
-
Create or update a department member using core logic. SCIM format.
|
|
20835
|
+
operationId: create_department_member
|
|
20836
|
+
description: Create a new department member for the specified platform
|
|
20837
|
+
summary: Create a new department member
|
|
20822
20838
|
parameters:
|
|
20823
20839
|
- in: path
|
|
20824
|
-
name:
|
|
20840
|
+
name: platform_key
|
|
20825
20841
|
schema:
|
|
20826
20842
|
type: string
|
|
20827
20843
|
required: true
|
|
@@ -20831,13 +20847,41 @@ paths:
|
|
|
20831
20847
|
- PlatformApiKeyAuthentication: []
|
|
20832
20848
|
responses:
|
|
20833
20849
|
'201':
|
|
20834
|
-
|
|
20835
|
-
|
|
20850
|
+
content:
|
|
20851
|
+
application/json:
|
|
20852
|
+
schema:
|
|
20853
|
+
description: Department member created successfully
|
|
20854
|
+
description: ''
|
|
20855
|
+
'400':
|
|
20856
|
+
content:
|
|
20857
|
+
application/json:
|
|
20858
|
+
schema:
|
|
20859
|
+
description: Invalid request
|
|
20860
|
+
description: ''
|
|
20861
|
+
'401':
|
|
20862
|
+
content:
|
|
20863
|
+
application/json:
|
|
20864
|
+
schema:
|
|
20865
|
+
description: Unauthorized
|
|
20866
|
+
description: ''
|
|
20867
|
+
'403':
|
|
20868
|
+
content:
|
|
20869
|
+
application/json:
|
|
20870
|
+
schema:
|
|
20871
|
+
description: Forbidden
|
|
20872
|
+
description: ''
|
|
20873
|
+
'409':
|
|
20874
|
+
content:
|
|
20875
|
+
application/json:
|
|
20876
|
+
schema:
|
|
20877
|
+
description: Department member already exists
|
|
20878
|
+
description: ''
|
|
20879
|
+
/api/orgs/{platform_key}/scim/v2/DepartmentMembers/{id}/:
|
|
20836
20880
|
get:
|
|
20837
|
-
operationId:
|
|
20838
|
-
description:
|
|
20839
|
-
|
|
20840
|
-
|
|
20881
|
+
operationId: retrieve_department_members
|
|
20882
|
+
description: Get department members for a specific department (by department
|
|
20883
|
+
id) for the specified platform
|
|
20884
|
+
summary: Get department members for a specific department
|
|
20841
20885
|
parameters:
|
|
20842
20886
|
- in: path
|
|
20843
20887
|
name: id
|
|
@@ -20845,7 +20889,7 @@ paths:
|
|
|
20845
20889
|
type: string
|
|
20846
20890
|
required: true
|
|
20847
20891
|
- in: path
|
|
20848
|
-
name:
|
|
20892
|
+
name: platform_key
|
|
20849
20893
|
schema:
|
|
20850
20894
|
type: string
|
|
20851
20895
|
required: true
|
|
@@ -20855,12 +20899,34 @@ paths:
|
|
|
20855
20899
|
- PlatformApiKeyAuthentication: []
|
|
20856
20900
|
responses:
|
|
20857
20901
|
'200':
|
|
20858
|
-
|
|
20902
|
+
content:
|
|
20903
|
+
application/json:
|
|
20904
|
+
schema:
|
|
20905
|
+
description: List of department members for the department in SCIM
|
|
20906
|
+
format
|
|
20907
|
+
description: ''
|
|
20908
|
+
'401':
|
|
20909
|
+
content:
|
|
20910
|
+
application/json:
|
|
20911
|
+
schema:
|
|
20912
|
+
description: Unauthorized
|
|
20913
|
+
description: ''
|
|
20914
|
+
'403':
|
|
20915
|
+
content:
|
|
20916
|
+
application/json:
|
|
20917
|
+
schema:
|
|
20918
|
+
description: Forbidden
|
|
20919
|
+
description: ''
|
|
20920
|
+
'404':
|
|
20921
|
+
content:
|
|
20922
|
+
application/json:
|
|
20923
|
+
schema:
|
|
20924
|
+
description: Department not found
|
|
20925
|
+
description: ''
|
|
20859
20926
|
put:
|
|
20860
|
-
operationId:
|
|
20861
|
-
description:
|
|
20862
|
-
|
|
20863
|
-
Update a department member using core logic. SCIM format.
|
|
20927
|
+
operationId: update_department_member
|
|
20928
|
+
description: Update a department member for the specified platform
|
|
20929
|
+
summary: Update a department member
|
|
20864
20930
|
parameters:
|
|
20865
20931
|
- in: path
|
|
20866
20932
|
name: id
|
|
@@ -20868,7 +20934,7 @@ paths:
|
|
|
20868
20934
|
type: string
|
|
20869
20935
|
required: true
|
|
20870
20936
|
- in: path
|
|
20871
|
-
name:
|
|
20937
|
+
name: platform_key
|
|
20872
20938
|
schema:
|
|
20873
20939
|
type: string
|
|
20874
20940
|
required: true
|
|
@@ -20878,12 +20944,39 @@ paths:
|
|
|
20878
20944
|
- PlatformApiKeyAuthentication: []
|
|
20879
20945
|
responses:
|
|
20880
20946
|
'200':
|
|
20881
|
-
|
|
20947
|
+
content:
|
|
20948
|
+
application/json:
|
|
20949
|
+
schema:
|
|
20950
|
+
description: Department member updated successfully
|
|
20951
|
+
description: ''
|
|
20952
|
+
'400':
|
|
20953
|
+
content:
|
|
20954
|
+
application/json:
|
|
20955
|
+
schema:
|
|
20956
|
+
description: Invalid request
|
|
20957
|
+
description: ''
|
|
20958
|
+
'401':
|
|
20959
|
+
content:
|
|
20960
|
+
application/json:
|
|
20961
|
+
schema:
|
|
20962
|
+
description: Unauthorized
|
|
20963
|
+
description: ''
|
|
20964
|
+
'403':
|
|
20965
|
+
content:
|
|
20966
|
+
application/json:
|
|
20967
|
+
schema:
|
|
20968
|
+
description: Forbidden
|
|
20969
|
+
description: ''
|
|
20970
|
+
'404':
|
|
20971
|
+
content:
|
|
20972
|
+
application/json:
|
|
20973
|
+
schema:
|
|
20974
|
+
description: Department member not found
|
|
20975
|
+
description: ''
|
|
20882
20976
|
delete:
|
|
20883
|
-
operationId:
|
|
20884
|
-
description:
|
|
20885
|
-
|
|
20886
|
-
Delete a department member using core logic. SCIM format.
|
|
20977
|
+
operationId: delete_department_member
|
|
20978
|
+
description: Delete a department member from the system
|
|
20979
|
+
summary: Delete a department member
|
|
20887
20980
|
parameters:
|
|
20888
20981
|
- in: path
|
|
20889
20982
|
name: id
|
|
@@ -20891,7 +20984,7 @@ paths:
|
|
|
20891
20984
|
type: string
|
|
20892
20985
|
required: true
|
|
20893
20986
|
- in: path
|
|
20894
|
-
name:
|
|
20987
|
+
name: platform_key
|
|
20895
20988
|
schema:
|
|
20896
20989
|
type: string
|
|
20897
20990
|
required: true
|
|
@@ -20901,17 +20994,37 @@ paths:
|
|
|
20901
20994
|
- PlatformApiKeyAuthentication: []
|
|
20902
20995
|
responses:
|
|
20903
20996
|
'204':
|
|
20904
|
-
|
|
20905
|
-
|
|
20997
|
+
content:
|
|
20998
|
+
application/json:
|
|
20999
|
+
schema:
|
|
21000
|
+
description: Department member deleted successfully
|
|
21001
|
+
description: ''
|
|
21002
|
+
'401':
|
|
21003
|
+
content:
|
|
21004
|
+
application/json:
|
|
21005
|
+
schema:
|
|
21006
|
+
description: Unauthorized
|
|
21007
|
+
description: ''
|
|
21008
|
+
'403':
|
|
21009
|
+
content:
|
|
21010
|
+
application/json:
|
|
21011
|
+
schema:
|
|
21012
|
+
description: Forbidden
|
|
21013
|
+
description: ''
|
|
21014
|
+
'404':
|
|
21015
|
+
content:
|
|
21016
|
+
application/json:
|
|
21017
|
+
schema:
|
|
21018
|
+
description: Department member not found
|
|
21019
|
+
description: ''
|
|
21020
|
+
/api/orgs/{platform_key}/scim/v2/Departments/:
|
|
20906
21021
|
get:
|
|
20907
|
-
operationId:
|
|
20908
|
-
description:
|
|
20909
|
-
|
|
20910
|
-
|
|
20911
|
-
List departments in the system. Supports filtering and pagination.
|
|
21022
|
+
operationId: list_departments
|
|
21023
|
+
description: List departments in the system for the specified platform
|
|
21024
|
+
summary: List departments in the system
|
|
20912
21025
|
parameters:
|
|
20913
21026
|
- in: path
|
|
20914
|
-
name:
|
|
21027
|
+
name: platform_key
|
|
20915
21028
|
schema:
|
|
20916
21029
|
type: string
|
|
20917
21030
|
required: true
|
|
@@ -20921,33 +21034,87 @@ paths:
|
|
|
20921
21034
|
- PlatformApiKeyAuthentication: []
|
|
20922
21035
|
responses:
|
|
20923
21036
|
'200':
|
|
20924
|
-
|
|
21037
|
+
content:
|
|
21038
|
+
application/json:
|
|
21039
|
+
schema:
|
|
21040
|
+
type: array
|
|
21041
|
+
items:
|
|
21042
|
+
description: List of departments in SCIM format
|
|
21043
|
+
description: ''
|
|
21044
|
+
'401':
|
|
21045
|
+
content:
|
|
21046
|
+
application/json:
|
|
21047
|
+
schema:
|
|
21048
|
+
description: Unauthorized
|
|
21049
|
+
description: ''
|
|
21050
|
+
'403':
|
|
21051
|
+
content:
|
|
21052
|
+
application/json:
|
|
21053
|
+
schema:
|
|
21054
|
+
description: Forbidden
|
|
21055
|
+
description: ''
|
|
20925
21056
|
post:
|
|
20926
|
-
operationId:
|
|
20927
|
-
description:
|
|
20928
|
-
|
|
20929
|
-
|
|
20930
|
-
Create a new department in the system.
|
|
21057
|
+
operationId: create_department
|
|
21058
|
+
description: Create a new department for the specified platform
|
|
21059
|
+
summary: Create a new department
|
|
20931
21060
|
parameters:
|
|
20932
21061
|
- in: path
|
|
20933
|
-
name:
|
|
21062
|
+
name: platform_key
|
|
20934
21063
|
schema:
|
|
20935
21064
|
type: string
|
|
20936
21065
|
required: true
|
|
20937
21066
|
tags:
|
|
20938
21067
|
- scim
|
|
21068
|
+
requestBody:
|
|
21069
|
+
content:
|
|
21070
|
+
application/json:
|
|
21071
|
+
schema:
|
|
21072
|
+
$ref: '#/components/schemas/SCIMDepartment'
|
|
21073
|
+
application/x-www-form-urlencoded:
|
|
21074
|
+
schema:
|
|
21075
|
+
$ref: '#/components/schemas/SCIMDepartment'
|
|
21076
|
+
multipart/form-data:
|
|
21077
|
+
schema:
|
|
21078
|
+
$ref: '#/components/schemas/SCIMDepartment'
|
|
21079
|
+
required: true
|
|
20939
21080
|
security:
|
|
20940
21081
|
- PlatformApiKeyAuthentication: []
|
|
20941
21082
|
responses:
|
|
20942
21083
|
'201':
|
|
20943
|
-
|
|
20944
|
-
|
|
21084
|
+
content:
|
|
21085
|
+
application/json:
|
|
21086
|
+
schema:
|
|
21087
|
+
$ref: '#/components/schemas/SCIMDepartment'
|
|
21088
|
+
description: ''
|
|
21089
|
+
'400':
|
|
21090
|
+
content:
|
|
21091
|
+
application/json:
|
|
21092
|
+
schema:
|
|
21093
|
+
description: Invalid request
|
|
21094
|
+
description: ''
|
|
21095
|
+
'401':
|
|
21096
|
+
content:
|
|
21097
|
+
application/json:
|
|
21098
|
+
schema:
|
|
21099
|
+
description: Unauthorized
|
|
21100
|
+
description: ''
|
|
21101
|
+
'403':
|
|
21102
|
+
content:
|
|
21103
|
+
application/json:
|
|
21104
|
+
schema:
|
|
21105
|
+
description: Forbidden
|
|
21106
|
+
description: ''
|
|
21107
|
+
'409':
|
|
21108
|
+
content:
|
|
21109
|
+
application/json:
|
|
21110
|
+
schema:
|
|
21111
|
+
description: Department already exists
|
|
21112
|
+
description: ''
|
|
21113
|
+
/api/orgs/{platform_key}/scim/v2/Departments/{id}/:
|
|
20945
21114
|
get:
|
|
20946
|
-
operationId:
|
|
20947
|
-
description:
|
|
20948
|
-
|
|
20949
|
-
|
|
20950
|
-
Get details of a specific department.
|
|
21115
|
+
operationId: retrieve_department
|
|
21116
|
+
description: Get details of a specific department by ID for the specified platform
|
|
21117
|
+
summary: Get details of a specific department
|
|
20951
21118
|
parameters:
|
|
20952
21119
|
- in: path
|
|
20953
21120
|
name: id
|
|
@@ -20955,7 +21122,7 @@ paths:
|
|
|
20955
21122
|
type: string
|
|
20956
21123
|
required: true
|
|
20957
21124
|
- in: path
|
|
20958
|
-
name:
|
|
21125
|
+
name: platform_key
|
|
20959
21126
|
schema:
|
|
20960
21127
|
type: string
|
|
20961
21128
|
required: true
|
|
@@ -20965,13 +21132,33 @@ paths:
|
|
|
20965
21132
|
- PlatformApiKeyAuthentication: []
|
|
20966
21133
|
responses:
|
|
20967
21134
|
'200':
|
|
20968
|
-
|
|
21135
|
+
content:
|
|
21136
|
+
application/json:
|
|
21137
|
+
schema:
|
|
21138
|
+
$ref: '#/components/schemas/SCIMDepartment'
|
|
21139
|
+
description: ''
|
|
21140
|
+
'401':
|
|
21141
|
+
content:
|
|
21142
|
+
application/json:
|
|
21143
|
+
schema:
|
|
21144
|
+
description: Unauthorized
|
|
21145
|
+
description: ''
|
|
21146
|
+
'403':
|
|
21147
|
+
content:
|
|
21148
|
+
application/json:
|
|
21149
|
+
schema:
|
|
21150
|
+
description: Forbidden
|
|
21151
|
+
description: ''
|
|
21152
|
+
'404':
|
|
21153
|
+
content:
|
|
21154
|
+
application/json:
|
|
21155
|
+
schema:
|
|
21156
|
+
description: Department not found
|
|
21157
|
+
description: ''
|
|
20969
21158
|
put:
|
|
20970
|
-
operationId:
|
|
20971
|
-
description:
|
|
20972
|
-
|
|
20973
|
-
|
|
20974
|
-
Update a department's information.
|
|
21159
|
+
operationId: update_department
|
|
21160
|
+
description: Update a department for the specified platform
|
|
21161
|
+
summary: Update a department
|
|
20975
21162
|
parameters:
|
|
20976
21163
|
- in: path
|
|
20977
21164
|
name: id
|
|
@@ -20979,23 +21166,61 @@ paths:
|
|
|
20979
21166
|
type: string
|
|
20980
21167
|
required: true
|
|
20981
21168
|
- in: path
|
|
20982
|
-
name:
|
|
21169
|
+
name: platform_key
|
|
20983
21170
|
schema:
|
|
20984
21171
|
type: string
|
|
20985
21172
|
required: true
|
|
20986
21173
|
tags:
|
|
20987
21174
|
- scim
|
|
21175
|
+
requestBody:
|
|
21176
|
+
content:
|
|
21177
|
+
application/json:
|
|
21178
|
+
schema:
|
|
21179
|
+
$ref: '#/components/schemas/SCIMDepartment'
|
|
21180
|
+
application/x-www-form-urlencoded:
|
|
21181
|
+
schema:
|
|
21182
|
+
$ref: '#/components/schemas/SCIMDepartment'
|
|
21183
|
+
multipart/form-data:
|
|
21184
|
+
schema:
|
|
21185
|
+
$ref: '#/components/schemas/SCIMDepartment'
|
|
21186
|
+
required: true
|
|
20988
21187
|
security:
|
|
20989
21188
|
- PlatformApiKeyAuthentication: []
|
|
20990
21189
|
responses:
|
|
20991
21190
|
'200':
|
|
20992
|
-
|
|
21191
|
+
content:
|
|
21192
|
+
application/json:
|
|
21193
|
+
schema:
|
|
21194
|
+
$ref: '#/components/schemas/SCIMDepartment'
|
|
21195
|
+
description: ''
|
|
21196
|
+
'400':
|
|
21197
|
+
content:
|
|
21198
|
+
application/json:
|
|
21199
|
+
schema:
|
|
21200
|
+
description: Invalid request
|
|
21201
|
+
description: ''
|
|
21202
|
+
'401':
|
|
21203
|
+
content:
|
|
21204
|
+
application/json:
|
|
21205
|
+
schema:
|
|
21206
|
+
description: Unauthorized
|
|
21207
|
+
description: ''
|
|
21208
|
+
'403':
|
|
21209
|
+
content:
|
|
21210
|
+
application/json:
|
|
21211
|
+
schema:
|
|
21212
|
+
description: Forbidden
|
|
21213
|
+
description: ''
|
|
21214
|
+
'404':
|
|
21215
|
+
content:
|
|
21216
|
+
application/json:
|
|
21217
|
+
schema:
|
|
21218
|
+
description: Department not found
|
|
21219
|
+
description: ''
|
|
20993
21220
|
delete:
|
|
20994
|
-
operationId:
|
|
20995
|
-
description:
|
|
20996
|
-
|
|
20997
|
-
|
|
20998
|
-
Delete a department from the system.
|
|
21221
|
+
operationId: delete_department
|
|
21222
|
+
description: Delete a department from the system
|
|
21223
|
+
summary: Delete a department
|
|
20999
21224
|
parameters:
|
|
21000
21225
|
- in: path
|
|
21001
21226
|
name: id
|
|
@@ -21003,7 +21228,7 @@ paths:
|
|
|
21003
21228
|
type: string
|
|
21004
21229
|
required: true
|
|
21005
21230
|
- in: path
|
|
21006
|
-
name:
|
|
21231
|
+
name: platform_key
|
|
21007
21232
|
schema:
|
|
21008
21233
|
type: string
|
|
21009
21234
|
required: true
|
|
@@ -21013,14 +21238,34 @@ paths:
|
|
|
21013
21238
|
- PlatformApiKeyAuthentication: []
|
|
21014
21239
|
responses:
|
|
21015
21240
|
'204':
|
|
21016
|
-
|
|
21017
|
-
|
|
21241
|
+
content:
|
|
21242
|
+
application/json:
|
|
21243
|
+
schema:
|
|
21244
|
+
description: Department deleted successfully
|
|
21245
|
+
description: ''
|
|
21246
|
+
'401':
|
|
21247
|
+
content:
|
|
21248
|
+
application/json:
|
|
21249
|
+
schema:
|
|
21250
|
+
description: Unauthorized
|
|
21251
|
+
description: ''
|
|
21252
|
+
'403':
|
|
21253
|
+
content:
|
|
21254
|
+
application/json:
|
|
21255
|
+
schema:
|
|
21256
|
+
description: Forbidden
|
|
21257
|
+
description: ''
|
|
21258
|
+
'404':
|
|
21259
|
+
content:
|
|
21260
|
+
application/json:
|
|
21261
|
+
schema:
|
|
21262
|
+
description: Department not found
|
|
21263
|
+
description: ''
|
|
21264
|
+
/api/orgs/{platform_key}/scim/v2/Departments/{id}/add_members/:
|
|
21018
21265
|
post:
|
|
21019
|
-
operationId:
|
|
21020
|
-
description:
|
|
21021
|
-
|
|
21022
|
-
|
|
21023
|
-
Add members to a department.
|
|
21266
|
+
operationId: add_department_members
|
|
21267
|
+
description: Add members to a department using SCIM patch operations
|
|
21268
|
+
summary: Add members to a department
|
|
21024
21269
|
parameters:
|
|
21025
21270
|
- in: path
|
|
21026
21271
|
name: id
|
|
@@ -21028,7 +21273,7 @@ paths:
|
|
|
21028
21273
|
type: string
|
|
21029
21274
|
required: true
|
|
21030
21275
|
- in: path
|
|
21031
|
-
name:
|
|
21276
|
+
name: platform_key
|
|
21032
21277
|
schema:
|
|
21033
21278
|
type: string
|
|
21034
21279
|
required: true
|
|
@@ -21038,14 +21283,40 @@ paths:
|
|
|
21038
21283
|
- PlatformApiKeyAuthentication: []
|
|
21039
21284
|
responses:
|
|
21040
21285
|
'200':
|
|
21041
|
-
|
|
21042
|
-
|
|
21286
|
+
content:
|
|
21287
|
+
application/json:
|
|
21288
|
+
schema:
|
|
21289
|
+
description: Members added successfully
|
|
21290
|
+
description: ''
|
|
21291
|
+
'400':
|
|
21292
|
+
content:
|
|
21293
|
+
application/json:
|
|
21294
|
+
schema:
|
|
21295
|
+
description: Invalid request
|
|
21296
|
+
description: ''
|
|
21297
|
+
'401':
|
|
21298
|
+
content:
|
|
21299
|
+
application/json:
|
|
21300
|
+
schema:
|
|
21301
|
+
description: Unauthorized
|
|
21302
|
+
description: ''
|
|
21303
|
+
'403':
|
|
21304
|
+
content:
|
|
21305
|
+
application/json:
|
|
21306
|
+
schema:
|
|
21307
|
+
description: Forbidden
|
|
21308
|
+
description: ''
|
|
21309
|
+
'404':
|
|
21310
|
+
content:
|
|
21311
|
+
application/json:
|
|
21312
|
+
schema:
|
|
21313
|
+
description: Department not found
|
|
21314
|
+
description: ''
|
|
21315
|
+
/api/orgs/{platform_key}/scim/v2/Departments/{id}/remove_members/:
|
|
21043
21316
|
post:
|
|
21044
|
-
operationId:
|
|
21045
|
-
description:
|
|
21046
|
-
|
|
21047
|
-
|
|
21048
|
-
Remove members from a department.
|
|
21317
|
+
operationId: remove_department_members
|
|
21318
|
+
description: Remove members from a department using SCIM patch operations
|
|
21319
|
+
summary: Remove members from a department
|
|
21049
21320
|
parameters:
|
|
21050
21321
|
- in: path
|
|
21051
21322
|
name: id
|
|
@@ -21053,7 +21324,7 @@ paths:
|
|
|
21053
21324
|
type: string
|
|
21054
21325
|
required: true
|
|
21055
21326
|
- in: path
|
|
21056
|
-
name:
|
|
21327
|
+
name: platform_key
|
|
21057
21328
|
schema:
|
|
21058
21329
|
type: string
|
|
21059
21330
|
required: true
|
|
@@ -21063,14 +21334,43 @@ paths:
|
|
|
21063
21334
|
- PlatformApiKeyAuthentication: []
|
|
21064
21335
|
responses:
|
|
21065
21336
|
'200':
|
|
21066
|
-
|
|
21067
|
-
|
|
21337
|
+
content:
|
|
21338
|
+
application/json:
|
|
21339
|
+
schema:
|
|
21340
|
+
description: Members removed successfully
|
|
21341
|
+
description: ''
|
|
21342
|
+
'400':
|
|
21343
|
+
content:
|
|
21344
|
+
application/json:
|
|
21345
|
+
schema:
|
|
21346
|
+
description: Invalid request
|
|
21347
|
+
description: ''
|
|
21348
|
+
'401':
|
|
21349
|
+
content:
|
|
21350
|
+
application/json:
|
|
21351
|
+
schema:
|
|
21352
|
+
description: Unauthorized
|
|
21353
|
+
description: ''
|
|
21354
|
+
'403':
|
|
21355
|
+
content:
|
|
21356
|
+
application/json:
|
|
21357
|
+
schema:
|
|
21358
|
+
description: Forbidden
|
|
21359
|
+
description: ''
|
|
21360
|
+
'404':
|
|
21361
|
+
content:
|
|
21362
|
+
application/json:
|
|
21363
|
+
schema:
|
|
21364
|
+
description: Department not found
|
|
21365
|
+
description: ''
|
|
21366
|
+
/api/orgs/{platform_key}/scim/v2/GroupMembers/:
|
|
21068
21367
|
get:
|
|
21069
|
-
operationId:
|
|
21070
|
-
description:
|
|
21368
|
+
operationId: list_group_members
|
|
21369
|
+
description: List all group members in the system for the specified platform
|
|
21370
|
+
summary: List all group members in the system
|
|
21071
21371
|
parameters:
|
|
21072
21372
|
- in: path
|
|
21073
|
-
name:
|
|
21373
|
+
name: platform_key
|
|
21074
21374
|
schema:
|
|
21075
21375
|
type: string
|
|
21076
21376
|
required: true
|
|
@@ -21080,13 +21380,32 @@ paths:
|
|
|
21080
21380
|
- PlatformApiKeyAuthentication: []
|
|
21081
21381
|
responses:
|
|
21082
21382
|
'200':
|
|
21083
|
-
|
|
21383
|
+
content:
|
|
21384
|
+
application/json:
|
|
21385
|
+
schema:
|
|
21386
|
+
type: array
|
|
21387
|
+
items:
|
|
21388
|
+
description: List of group members in SCIM format
|
|
21389
|
+
description: ''
|
|
21390
|
+
'401':
|
|
21391
|
+
content:
|
|
21392
|
+
application/json:
|
|
21393
|
+
schema:
|
|
21394
|
+
description: Unauthorized
|
|
21395
|
+
description: ''
|
|
21396
|
+
'403':
|
|
21397
|
+
content:
|
|
21398
|
+
application/json:
|
|
21399
|
+
schema:
|
|
21400
|
+
description: Forbidden
|
|
21401
|
+
description: ''
|
|
21084
21402
|
post:
|
|
21085
|
-
operationId:
|
|
21086
|
-
description:
|
|
21403
|
+
operationId: create_group_member
|
|
21404
|
+
description: Create a new group member for the specified platform
|
|
21405
|
+
summary: Create a new group member
|
|
21087
21406
|
parameters:
|
|
21088
21407
|
- in: path
|
|
21089
|
-
name:
|
|
21408
|
+
name: platform_key
|
|
21090
21409
|
schema:
|
|
21091
21410
|
type: string
|
|
21092
21411
|
required: true
|
|
@@ -21096,11 +21415,41 @@ paths:
|
|
|
21096
21415
|
- PlatformApiKeyAuthentication: []
|
|
21097
21416
|
responses:
|
|
21098
21417
|
'201':
|
|
21099
|
-
|
|
21100
|
-
|
|
21418
|
+
content:
|
|
21419
|
+
application/json:
|
|
21420
|
+
schema:
|
|
21421
|
+
description: Group member created successfully
|
|
21422
|
+
description: ''
|
|
21423
|
+
'400':
|
|
21424
|
+
content:
|
|
21425
|
+
application/json:
|
|
21426
|
+
schema:
|
|
21427
|
+
description: Invalid request
|
|
21428
|
+
description: ''
|
|
21429
|
+
'401':
|
|
21430
|
+
content:
|
|
21431
|
+
application/json:
|
|
21432
|
+
schema:
|
|
21433
|
+
description: Unauthorized
|
|
21434
|
+
description: ''
|
|
21435
|
+
'403':
|
|
21436
|
+
content:
|
|
21437
|
+
application/json:
|
|
21438
|
+
schema:
|
|
21439
|
+
description: Forbidden
|
|
21440
|
+
description: ''
|
|
21441
|
+
'409':
|
|
21442
|
+
content:
|
|
21443
|
+
application/json:
|
|
21444
|
+
schema:
|
|
21445
|
+
description: Group member already exists
|
|
21446
|
+
description: ''
|
|
21447
|
+
/api/orgs/{platform_key}/scim/v2/GroupMembers/{id}/:
|
|
21101
21448
|
get:
|
|
21102
|
-
operationId:
|
|
21103
|
-
description:
|
|
21449
|
+
operationId: retrieve_group_member
|
|
21450
|
+
description: Get details of a specific group member by ID for the specified
|
|
21451
|
+
platform
|
|
21452
|
+
summary: Get details of a specific group member
|
|
21104
21453
|
parameters:
|
|
21105
21454
|
- in: path
|
|
21106
21455
|
name: id
|
|
@@ -21108,7 +21457,7 @@ paths:
|
|
|
21108
21457
|
type: string
|
|
21109
21458
|
required: true
|
|
21110
21459
|
- in: path
|
|
21111
|
-
name:
|
|
21460
|
+
name: platform_key
|
|
21112
21461
|
schema:
|
|
21113
21462
|
type: string
|
|
21114
21463
|
required: true
|
|
@@ -21118,10 +21467,33 @@ paths:
|
|
|
21118
21467
|
- PlatformApiKeyAuthentication: []
|
|
21119
21468
|
responses:
|
|
21120
21469
|
'200':
|
|
21121
|
-
|
|
21470
|
+
content:
|
|
21471
|
+
application/json:
|
|
21472
|
+
schema:
|
|
21473
|
+
description: Group member details in SCIM format
|
|
21474
|
+
description: ''
|
|
21475
|
+
'401':
|
|
21476
|
+
content:
|
|
21477
|
+
application/json:
|
|
21478
|
+
schema:
|
|
21479
|
+
description: Unauthorized
|
|
21480
|
+
description: ''
|
|
21481
|
+
'403':
|
|
21482
|
+
content:
|
|
21483
|
+
application/json:
|
|
21484
|
+
schema:
|
|
21485
|
+
description: Forbidden
|
|
21486
|
+
description: ''
|
|
21487
|
+
'404':
|
|
21488
|
+
content:
|
|
21489
|
+
application/json:
|
|
21490
|
+
schema:
|
|
21491
|
+
description: Group member not found
|
|
21492
|
+
description: ''
|
|
21122
21493
|
put:
|
|
21123
|
-
operationId:
|
|
21124
|
-
description:
|
|
21494
|
+
operationId: update_group_member
|
|
21495
|
+
description: Update a group member for the specified platform
|
|
21496
|
+
summary: Update a group member
|
|
21125
21497
|
parameters:
|
|
21126
21498
|
- in: path
|
|
21127
21499
|
name: id
|
|
@@ -21129,7 +21501,7 @@ paths:
|
|
|
21129
21501
|
type: string
|
|
21130
21502
|
required: true
|
|
21131
21503
|
- in: path
|
|
21132
|
-
name:
|
|
21504
|
+
name: platform_key
|
|
21133
21505
|
schema:
|
|
21134
21506
|
type: string
|
|
21135
21507
|
required: true
|
|
@@ -21139,10 +21511,39 @@ paths:
|
|
|
21139
21511
|
- PlatformApiKeyAuthentication: []
|
|
21140
21512
|
responses:
|
|
21141
21513
|
'200':
|
|
21142
|
-
|
|
21514
|
+
content:
|
|
21515
|
+
application/json:
|
|
21516
|
+
schema:
|
|
21517
|
+
description: Group member updated successfully
|
|
21518
|
+
description: ''
|
|
21519
|
+
'400':
|
|
21520
|
+
content:
|
|
21521
|
+
application/json:
|
|
21522
|
+
schema:
|
|
21523
|
+
description: Invalid request
|
|
21524
|
+
description: ''
|
|
21525
|
+
'401':
|
|
21526
|
+
content:
|
|
21527
|
+
application/json:
|
|
21528
|
+
schema:
|
|
21529
|
+
description: Unauthorized
|
|
21530
|
+
description: ''
|
|
21531
|
+
'403':
|
|
21532
|
+
content:
|
|
21533
|
+
application/json:
|
|
21534
|
+
schema:
|
|
21535
|
+
description: Forbidden
|
|
21536
|
+
description: ''
|
|
21537
|
+
'404':
|
|
21538
|
+
content:
|
|
21539
|
+
application/json:
|
|
21540
|
+
schema:
|
|
21541
|
+
description: Group member not found
|
|
21542
|
+
description: ''
|
|
21143
21543
|
delete:
|
|
21144
|
-
operationId:
|
|
21145
|
-
description:
|
|
21544
|
+
operationId: delete_group_member
|
|
21545
|
+
description: Delete a group member from the system
|
|
21546
|
+
summary: Delete a group member
|
|
21146
21547
|
parameters:
|
|
21147
21548
|
- in: path
|
|
21148
21549
|
name: id
|
|
@@ -21150,7 +21551,7 @@ paths:
|
|
|
21150
21551
|
type: string
|
|
21151
21552
|
required: true
|
|
21152
21553
|
- in: path
|
|
21153
|
-
name:
|
|
21554
|
+
name: platform_key
|
|
21154
21555
|
schema:
|
|
21155
21556
|
type: string
|
|
21156
21557
|
required: true
|
|
@@ -21160,15 +21561,37 @@ paths:
|
|
|
21160
21561
|
- PlatformApiKeyAuthentication: []
|
|
21161
21562
|
responses:
|
|
21162
21563
|
'204':
|
|
21163
|
-
|
|
21164
|
-
|
|
21564
|
+
content:
|
|
21565
|
+
application/json:
|
|
21566
|
+
schema:
|
|
21567
|
+
description: Group member deleted successfully
|
|
21568
|
+
description: ''
|
|
21569
|
+
'401':
|
|
21570
|
+
content:
|
|
21571
|
+
application/json:
|
|
21572
|
+
schema:
|
|
21573
|
+
description: Unauthorized
|
|
21574
|
+
description: ''
|
|
21575
|
+
'403':
|
|
21576
|
+
content:
|
|
21577
|
+
application/json:
|
|
21578
|
+
schema:
|
|
21579
|
+
description: Forbidden
|
|
21580
|
+
description: ''
|
|
21581
|
+
'404':
|
|
21582
|
+
content:
|
|
21583
|
+
application/json:
|
|
21584
|
+
schema:
|
|
21585
|
+
description: Group member not found
|
|
21586
|
+
description: ''
|
|
21587
|
+
/api/orgs/{platform_key}/scim/v2/Groups/:
|
|
21165
21588
|
get:
|
|
21166
|
-
operationId:
|
|
21167
|
-
description:
|
|
21168
|
-
|
|
21589
|
+
operationId: list_groups
|
|
21590
|
+
description: List user groups in the system for the specified platform
|
|
21591
|
+
summary: List user groups in the system
|
|
21169
21592
|
parameters:
|
|
21170
21593
|
- in: path
|
|
21171
|
-
name:
|
|
21594
|
+
name: platform_key
|
|
21172
21595
|
schema:
|
|
21173
21596
|
type: string
|
|
21174
21597
|
required: true
|
|
@@ -21178,31 +21601,87 @@ paths:
|
|
|
21178
21601
|
- PlatformApiKeyAuthentication: []
|
|
21179
21602
|
responses:
|
|
21180
21603
|
'200':
|
|
21181
|
-
|
|
21604
|
+
content:
|
|
21605
|
+
application/json:
|
|
21606
|
+
schema:
|
|
21607
|
+
type: array
|
|
21608
|
+
items:
|
|
21609
|
+
description: List of user groups in SCIM format
|
|
21610
|
+
description: ''
|
|
21611
|
+
'401':
|
|
21612
|
+
content:
|
|
21613
|
+
application/json:
|
|
21614
|
+
schema:
|
|
21615
|
+
description: Unauthorized
|
|
21616
|
+
description: ''
|
|
21617
|
+
'403':
|
|
21618
|
+
content:
|
|
21619
|
+
application/json:
|
|
21620
|
+
schema:
|
|
21621
|
+
description: Forbidden
|
|
21622
|
+
description: ''
|
|
21182
21623
|
post:
|
|
21183
|
-
operationId:
|
|
21184
|
-
description:
|
|
21185
|
-
|
|
21624
|
+
operationId: create_group
|
|
21625
|
+
description: Create a new user group for the specified platform
|
|
21626
|
+
summary: Create a new user group
|
|
21186
21627
|
parameters:
|
|
21187
21628
|
- in: path
|
|
21188
|
-
name:
|
|
21629
|
+
name: platform_key
|
|
21189
21630
|
schema:
|
|
21190
21631
|
type: string
|
|
21191
21632
|
required: true
|
|
21192
21633
|
tags:
|
|
21193
21634
|
- scim
|
|
21635
|
+
requestBody:
|
|
21636
|
+
content:
|
|
21637
|
+
application/json:
|
|
21638
|
+
schema:
|
|
21639
|
+
$ref: '#/components/schemas/SCIMGroup'
|
|
21640
|
+
application/x-www-form-urlencoded:
|
|
21641
|
+
schema:
|
|
21642
|
+
$ref: '#/components/schemas/SCIMGroup'
|
|
21643
|
+
multipart/form-data:
|
|
21644
|
+
schema:
|
|
21645
|
+
$ref: '#/components/schemas/SCIMGroup'
|
|
21646
|
+
required: true
|
|
21194
21647
|
security:
|
|
21195
21648
|
- PlatformApiKeyAuthentication: []
|
|
21196
21649
|
responses:
|
|
21197
21650
|
'201':
|
|
21198
|
-
|
|
21199
|
-
|
|
21651
|
+
content:
|
|
21652
|
+
application/json:
|
|
21653
|
+
schema:
|
|
21654
|
+
$ref: '#/components/schemas/SCIMGroup'
|
|
21655
|
+
description: ''
|
|
21656
|
+
'400':
|
|
21657
|
+
content:
|
|
21658
|
+
application/json:
|
|
21659
|
+
schema:
|
|
21660
|
+
description: Invalid request
|
|
21661
|
+
description: ''
|
|
21662
|
+
'401':
|
|
21663
|
+
content:
|
|
21664
|
+
application/json:
|
|
21665
|
+
schema:
|
|
21666
|
+
description: Unauthorized
|
|
21667
|
+
description: ''
|
|
21668
|
+
'403':
|
|
21669
|
+
content:
|
|
21670
|
+
application/json:
|
|
21671
|
+
schema:
|
|
21672
|
+
description: Forbidden
|
|
21673
|
+
description: ''
|
|
21674
|
+
'409':
|
|
21675
|
+
content:
|
|
21676
|
+
application/json:
|
|
21677
|
+
schema:
|
|
21678
|
+
description: Group already exists
|
|
21679
|
+
description: ''
|
|
21680
|
+
/api/orgs/{platform_key}/scim/v2/Groups/{id}/:
|
|
21200
21681
|
get:
|
|
21201
|
-
operationId:
|
|
21202
|
-
description:
|
|
21203
|
-
|
|
21204
|
-
|
|
21205
|
-
Get details of a specific user group.
|
|
21682
|
+
operationId: retrieve_group
|
|
21683
|
+
description: Get details of a specific group by ID for the specified platform
|
|
21684
|
+
summary: Get details of a specific group
|
|
21206
21685
|
parameters:
|
|
21207
21686
|
- in: path
|
|
21208
21687
|
name: id
|
|
@@ -21210,7 +21689,7 @@ paths:
|
|
|
21210
21689
|
type: string
|
|
21211
21690
|
required: true
|
|
21212
21691
|
- in: path
|
|
21213
|
-
name:
|
|
21692
|
+
name: platform_key
|
|
21214
21693
|
schema:
|
|
21215
21694
|
type: string
|
|
21216
21695
|
required: true
|
|
@@ -21220,13 +21699,33 @@ paths:
|
|
|
21220
21699
|
- PlatformApiKeyAuthentication: []
|
|
21221
21700
|
responses:
|
|
21222
21701
|
'200':
|
|
21223
|
-
|
|
21702
|
+
content:
|
|
21703
|
+
application/json:
|
|
21704
|
+
schema:
|
|
21705
|
+
$ref: '#/components/schemas/SCIMGroup'
|
|
21706
|
+
description: ''
|
|
21707
|
+
'401':
|
|
21708
|
+
content:
|
|
21709
|
+
application/json:
|
|
21710
|
+
schema:
|
|
21711
|
+
description: Unauthorized
|
|
21712
|
+
description: ''
|
|
21713
|
+
'403':
|
|
21714
|
+
content:
|
|
21715
|
+
application/json:
|
|
21716
|
+
schema:
|
|
21717
|
+
description: Forbidden
|
|
21718
|
+
description: ''
|
|
21719
|
+
'404':
|
|
21720
|
+
content:
|
|
21721
|
+
application/json:
|
|
21722
|
+
schema:
|
|
21723
|
+
description: Group not found
|
|
21724
|
+
description: ''
|
|
21224
21725
|
put:
|
|
21225
|
-
operationId:
|
|
21226
|
-
description:
|
|
21227
|
-
|
|
21228
|
-
|
|
21229
|
-
Update a user group's information.
|
|
21726
|
+
operationId: update_group
|
|
21727
|
+
description: Update a user group for the specified platform
|
|
21728
|
+
summary: Update a user group
|
|
21230
21729
|
parameters:
|
|
21231
21730
|
- in: path
|
|
21232
21731
|
name: id
|
|
@@ -21234,23 +21733,61 @@ paths:
|
|
|
21234
21733
|
type: string
|
|
21235
21734
|
required: true
|
|
21236
21735
|
- in: path
|
|
21237
|
-
name:
|
|
21736
|
+
name: platform_key
|
|
21238
21737
|
schema:
|
|
21239
21738
|
type: string
|
|
21240
21739
|
required: true
|
|
21241
21740
|
tags:
|
|
21242
21741
|
- scim
|
|
21742
|
+
requestBody:
|
|
21743
|
+
content:
|
|
21744
|
+
application/json:
|
|
21745
|
+
schema:
|
|
21746
|
+
$ref: '#/components/schemas/SCIMGroup'
|
|
21747
|
+
application/x-www-form-urlencoded:
|
|
21748
|
+
schema:
|
|
21749
|
+
$ref: '#/components/schemas/SCIMGroup'
|
|
21750
|
+
multipart/form-data:
|
|
21751
|
+
schema:
|
|
21752
|
+
$ref: '#/components/schemas/SCIMGroup'
|
|
21753
|
+
required: true
|
|
21243
21754
|
security:
|
|
21244
21755
|
- PlatformApiKeyAuthentication: []
|
|
21245
21756
|
responses:
|
|
21246
21757
|
'200':
|
|
21247
|
-
|
|
21758
|
+
content:
|
|
21759
|
+
application/json:
|
|
21760
|
+
schema:
|
|
21761
|
+
$ref: '#/components/schemas/SCIMGroup'
|
|
21762
|
+
description: ''
|
|
21763
|
+
'400':
|
|
21764
|
+
content:
|
|
21765
|
+
application/json:
|
|
21766
|
+
schema:
|
|
21767
|
+
description: Invalid request
|
|
21768
|
+
description: ''
|
|
21769
|
+
'401':
|
|
21770
|
+
content:
|
|
21771
|
+
application/json:
|
|
21772
|
+
schema:
|
|
21773
|
+
description: Unauthorized
|
|
21774
|
+
description: ''
|
|
21775
|
+
'403':
|
|
21776
|
+
content:
|
|
21777
|
+
application/json:
|
|
21778
|
+
schema:
|
|
21779
|
+
description: Forbidden
|
|
21780
|
+
description: ''
|
|
21781
|
+
'404':
|
|
21782
|
+
content:
|
|
21783
|
+
application/json:
|
|
21784
|
+
schema:
|
|
21785
|
+
description: Group not found
|
|
21786
|
+
description: ''
|
|
21248
21787
|
delete:
|
|
21249
|
-
operationId:
|
|
21250
|
-
description:
|
|
21251
|
-
|
|
21252
|
-
|
|
21253
|
-
Delete a user group from the system.
|
|
21788
|
+
operationId: delete_group
|
|
21789
|
+
description: Delete a user group from the system
|
|
21790
|
+
summary: Delete a user group
|
|
21254
21791
|
parameters:
|
|
21255
21792
|
- in: path
|
|
21256
21793
|
name: id
|
|
@@ -21258,7 +21795,7 @@ paths:
|
|
|
21258
21795
|
type: string
|
|
21259
21796
|
required: true
|
|
21260
21797
|
- in: path
|
|
21261
|
-
name:
|
|
21798
|
+
name: platform_key
|
|
21262
21799
|
schema:
|
|
21263
21800
|
type: string
|
|
21264
21801
|
required: true
|
|
@@ -21268,14 +21805,34 @@ paths:
|
|
|
21268
21805
|
- PlatformApiKeyAuthentication: []
|
|
21269
21806
|
responses:
|
|
21270
21807
|
'204':
|
|
21271
|
-
|
|
21272
|
-
|
|
21808
|
+
content:
|
|
21809
|
+
application/json:
|
|
21810
|
+
schema:
|
|
21811
|
+
description: Group deleted successfully
|
|
21812
|
+
description: ''
|
|
21813
|
+
'401':
|
|
21814
|
+
content:
|
|
21815
|
+
application/json:
|
|
21816
|
+
schema:
|
|
21817
|
+
description: Unauthorized
|
|
21818
|
+
description: ''
|
|
21819
|
+
'403':
|
|
21820
|
+
content:
|
|
21821
|
+
application/json:
|
|
21822
|
+
schema:
|
|
21823
|
+
description: Forbidden
|
|
21824
|
+
description: ''
|
|
21825
|
+
'404':
|
|
21826
|
+
content:
|
|
21827
|
+
application/json:
|
|
21828
|
+
schema:
|
|
21829
|
+
description: Group not found
|
|
21830
|
+
description: ''
|
|
21831
|
+
/api/orgs/{platform_key}/scim/v2/Groups/{id}/add_members/:
|
|
21273
21832
|
post:
|
|
21274
|
-
operationId:
|
|
21275
|
-
description:
|
|
21276
|
-
|
|
21277
|
-
|
|
21278
|
-
Add members to a user group.
|
|
21833
|
+
operationId: add_group_members
|
|
21834
|
+
description: Add members to a user group using SCIM patch operations
|
|
21835
|
+
summary: Add members to a user group
|
|
21279
21836
|
parameters:
|
|
21280
21837
|
- in: path
|
|
21281
21838
|
name: id
|
|
@@ -21283,7 +21840,7 @@ paths:
|
|
|
21283
21840
|
type: string
|
|
21284
21841
|
required: true
|
|
21285
21842
|
- in: path
|
|
21286
|
-
name:
|
|
21843
|
+
name: platform_key
|
|
21287
21844
|
schema:
|
|
21288
21845
|
type: string
|
|
21289
21846
|
required: true
|
|
@@ -21293,14 +21850,40 @@ paths:
|
|
|
21293
21850
|
- PlatformApiKeyAuthentication: []
|
|
21294
21851
|
responses:
|
|
21295
21852
|
'200':
|
|
21296
|
-
|
|
21297
|
-
|
|
21853
|
+
content:
|
|
21854
|
+
application/json:
|
|
21855
|
+
schema:
|
|
21856
|
+
description: Members added successfully
|
|
21857
|
+
description: ''
|
|
21858
|
+
'400':
|
|
21859
|
+
content:
|
|
21860
|
+
application/json:
|
|
21861
|
+
schema:
|
|
21862
|
+
description: Invalid request
|
|
21863
|
+
description: ''
|
|
21864
|
+
'401':
|
|
21865
|
+
content:
|
|
21866
|
+
application/json:
|
|
21867
|
+
schema:
|
|
21868
|
+
description: Unauthorized
|
|
21869
|
+
description: ''
|
|
21870
|
+
'403':
|
|
21871
|
+
content:
|
|
21872
|
+
application/json:
|
|
21873
|
+
schema:
|
|
21874
|
+
description: Forbidden
|
|
21875
|
+
description: ''
|
|
21876
|
+
'404':
|
|
21877
|
+
content:
|
|
21878
|
+
application/json:
|
|
21879
|
+
schema:
|
|
21880
|
+
description: Group not found
|
|
21881
|
+
description: ''
|
|
21882
|
+
/api/orgs/{platform_key}/scim/v2/Groups/{id}/remove_members/:
|
|
21298
21883
|
post:
|
|
21299
|
-
operationId:
|
|
21300
|
-
description:
|
|
21301
|
-
|
|
21302
|
-
|
|
21303
|
-
Remove members from a user group.
|
|
21884
|
+
operationId: remove_group_members
|
|
21885
|
+
description: Remove members from a user group using SCIM patch operations
|
|
21886
|
+
summary: Remove members from a user group
|
|
21304
21887
|
parameters:
|
|
21305
21888
|
- in: path
|
|
21306
21889
|
name: id
|
|
@@ -21308,7 +21891,7 @@ paths:
|
|
|
21308
21891
|
type: string
|
|
21309
21892
|
required: true
|
|
21310
21893
|
- in: path
|
|
21311
|
-
name:
|
|
21894
|
+
name: platform_key
|
|
21312
21895
|
schema:
|
|
21313
21896
|
type: string
|
|
21314
21897
|
required: true
|
|
@@ -21318,17 +21901,43 @@ paths:
|
|
|
21318
21901
|
- PlatformApiKeyAuthentication: []
|
|
21319
21902
|
responses:
|
|
21320
21903
|
'200':
|
|
21321
|
-
|
|
21322
|
-
|
|
21904
|
+
content:
|
|
21905
|
+
application/json:
|
|
21906
|
+
schema:
|
|
21907
|
+
description: Members removed successfully
|
|
21908
|
+
description: ''
|
|
21909
|
+
'400':
|
|
21910
|
+
content:
|
|
21911
|
+
application/json:
|
|
21912
|
+
schema:
|
|
21913
|
+
description: Invalid request
|
|
21914
|
+
description: ''
|
|
21915
|
+
'401':
|
|
21916
|
+
content:
|
|
21917
|
+
application/json:
|
|
21918
|
+
schema:
|
|
21919
|
+
description: Unauthorized
|
|
21920
|
+
description: ''
|
|
21921
|
+
'403':
|
|
21922
|
+
content:
|
|
21923
|
+
application/json:
|
|
21924
|
+
schema:
|
|
21925
|
+
description: Forbidden
|
|
21926
|
+
description: ''
|
|
21927
|
+
'404':
|
|
21928
|
+
content:
|
|
21929
|
+
application/json:
|
|
21930
|
+
schema:
|
|
21931
|
+
description: Group not found
|
|
21932
|
+
description: ''
|
|
21933
|
+
/api/orgs/{platform_key}/scim/v2/Users/:
|
|
21323
21934
|
get:
|
|
21324
|
-
operationId:
|
|
21325
|
-
description:
|
|
21326
|
-
|
|
21327
|
-
|
|
21328
|
-
List users in the system. Supports filtering and pagination.
|
|
21935
|
+
operationId: list_users
|
|
21936
|
+
description: List users in the system for the specified platform
|
|
21937
|
+
summary: List users in the system
|
|
21329
21938
|
parameters:
|
|
21330
21939
|
- in: path
|
|
21331
|
-
name:
|
|
21940
|
+
name: platform_key
|
|
21332
21941
|
schema:
|
|
21333
21942
|
type: string
|
|
21334
21943
|
required: true
|
|
@@ -21338,33 +21947,100 @@ paths:
|
|
|
21338
21947
|
- PlatformApiKeyAuthentication: []
|
|
21339
21948
|
responses:
|
|
21340
21949
|
'200':
|
|
21341
|
-
|
|
21950
|
+
content:
|
|
21951
|
+
application/json:
|
|
21952
|
+
schema:
|
|
21953
|
+
type: array
|
|
21954
|
+
items:
|
|
21955
|
+
$ref: '#/components/schemas/SCIMUserListResponse'
|
|
21956
|
+
description: ''
|
|
21957
|
+
'401':
|
|
21958
|
+
content:
|
|
21959
|
+
application/json:
|
|
21960
|
+
schema:
|
|
21961
|
+
description: Unauthorized - authentication required
|
|
21962
|
+
description: ''
|
|
21963
|
+
'403':
|
|
21964
|
+
content:
|
|
21965
|
+
application/json:
|
|
21966
|
+
schema:
|
|
21967
|
+
description: Forbidden - insufficient permissions
|
|
21968
|
+
description: ''
|
|
21969
|
+
'500':
|
|
21970
|
+
content:
|
|
21971
|
+
application/json:
|
|
21972
|
+
schema:
|
|
21973
|
+
description: Internal server error
|
|
21974
|
+
description: ''
|
|
21342
21975
|
post:
|
|
21343
|
-
operationId:
|
|
21344
|
-
description:
|
|
21345
|
-
|
|
21346
|
-
|
|
21347
|
-
Create a new user in the system.
|
|
21976
|
+
operationId: create_user
|
|
21977
|
+
description: Create a new user in the system for the specified platform
|
|
21978
|
+
summary: Create a new user in the system
|
|
21348
21979
|
parameters:
|
|
21349
21980
|
- in: path
|
|
21350
|
-
name:
|
|
21981
|
+
name: platform_key
|
|
21351
21982
|
schema:
|
|
21352
21983
|
type: string
|
|
21353
21984
|
required: true
|
|
21354
21985
|
tags:
|
|
21355
21986
|
- scim
|
|
21987
|
+
requestBody:
|
|
21988
|
+
content:
|
|
21989
|
+
application/json:
|
|
21990
|
+
schema:
|
|
21991
|
+
$ref: '#/components/schemas/SCIMUserCreateRequest'
|
|
21992
|
+
application/x-www-form-urlencoded:
|
|
21993
|
+
schema:
|
|
21994
|
+
$ref: '#/components/schemas/SCIMUserCreateRequest'
|
|
21995
|
+
multipart/form-data:
|
|
21996
|
+
schema:
|
|
21997
|
+
$ref: '#/components/schemas/SCIMUserCreateRequest'
|
|
21998
|
+
required: true
|
|
21356
21999
|
security:
|
|
21357
22000
|
- PlatformApiKeyAuthentication: []
|
|
21358
22001
|
responses:
|
|
21359
22002
|
'201':
|
|
21360
|
-
|
|
21361
|
-
|
|
22003
|
+
content:
|
|
22004
|
+
application/json:
|
|
22005
|
+
schema:
|
|
22006
|
+
$ref: '#/components/schemas/SCIMUserResponse'
|
|
22007
|
+
description: ''
|
|
22008
|
+
'400':
|
|
22009
|
+
content:
|
|
22010
|
+
application/json:
|
|
22011
|
+
schema:
|
|
22012
|
+
description: Invalid request - missing required fields or invalid
|
|
22013
|
+
data
|
|
22014
|
+
description: ''
|
|
22015
|
+
'401':
|
|
22016
|
+
content:
|
|
22017
|
+
application/json:
|
|
22018
|
+
schema:
|
|
22019
|
+
description: Unauthorized - authentication required
|
|
22020
|
+
description: ''
|
|
22021
|
+
'403':
|
|
22022
|
+
content:
|
|
22023
|
+
application/json:
|
|
22024
|
+
schema:
|
|
22025
|
+
description: Forbidden - insufficient permissions
|
|
22026
|
+
description: ''
|
|
22027
|
+
'409':
|
|
22028
|
+
content:
|
|
22029
|
+
application/json:
|
|
22030
|
+
schema:
|
|
22031
|
+
description: User already exists
|
|
22032
|
+
description: ''
|
|
22033
|
+
'500':
|
|
22034
|
+
content:
|
|
22035
|
+
application/json:
|
|
22036
|
+
schema:
|
|
22037
|
+
description: Internal server error
|
|
22038
|
+
description: ''
|
|
22039
|
+
/api/orgs/{platform_key}/scim/v2/Users/{id}/:
|
|
21362
22040
|
get:
|
|
21363
|
-
operationId:
|
|
21364
|
-
description:
|
|
21365
|
-
|
|
21366
|
-
|
|
21367
|
-
Get details of a specific user.
|
|
22041
|
+
operationId: retrieve_user
|
|
22042
|
+
description: Get details of a specific user by ID for the specified platform
|
|
22043
|
+
summary: Get details of a specific user
|
|
21368
22044
|
parameters:
|
|
21369
22045
|
- in: path
|
|
21370
22046
|
name: id
|
|
@@ -21372,7 +22048,7 @@ paths:
|
|
|
21372
22048
|
type: string
|
|
21373
22049
|
required: true
|
|
21374
22050
|
- in: path
|
|
21375
|
-
name:
|
|
22051
|
+
name: platform_key
|
|
21376
22052
|
schema:
|
|
21377
22053
|
type: string
|
|
21378
22054
|
required: true
|
|
@@ -21382,13 +22058,46 @@ paths:
|
|
|
21382
22058
|
- PlatformApiKeyAuthentication: []
|
|
21383
22059
|
responses:
|
|
21384
22060
|
'200':
|
|
21385
|
-
|
|
22061
|
+
content:
|
|
22062
|
+
application/json:
|
|
22063
|
+
schema:
|
|
22064
|
+
$ref: '#/components/schemas/SCIMUserResponse'
|
|
22065
|
+
description: ''
|
|
22066
|
+
'400':
|
|
22067
|
+
content:
|
|
22068
|
+
application/json:
|
|
22069
|
+
schema:
|
|
22070
|
+
description: Invalid request - missing required fields or invalid
|
|
22071
|
+
data
|
|
22072
|
+
description: ''
|
|
22073
|
+
'401':
|
|
22074
|
+
content:
|
|
22075
|
+
application/json:
|
|
22076
|
+
schema:
|
|
22077
|
+
description: Unauthorized - authentication required
|
|
22078
|
+
description: ''
|
|
22079
|
+
'403':
|
|
22080
|
+
content:
|
|
22081
|
+
application/json:
|
|
22082
|
+
schema:
|
|
22083
|
+
description: Forbidden - insufficient permissions
|
|
22084
|
+
description: ''
|
|
22085
|
+
'404':
|
|
22086
|
+
content:
|
|
22087
|
+
application/json:
|
|
22088
|
+
schema:
|
|
22089
|
+
description: User not found
|
|
22090
|
+
description: ''
|
|
22091
|
+
'500':
|
|
22092
|
+
content:
|
|
22093
|
+
application/json:
|
|
22094
|
+
schema:
|
|
22095
|
+
description: Internal server error
|
|
22096
|
+
description: ''
|
|
21386
22097
|
put:
|
|
21387
|
-
operationId:
|
|
21388
|
-
description:
|
|
21389
|
-
|
|
21390
|
-
|
|
21391
|
-
Update a user's information.
|
|
22098
|
+
operationId: update_user
|
|
22099
|
+
description: Update a user for the specified platform
|
|
22100
|
+
summary: Update a user
|
|
21392
22101
|
parameters:
|
|
21393
22102
|
- in: path
|
|
21394
22103
|
name: id
|
|
@@ -21396,20 +22105,61 @@ paths:
|
|
|
21396
22105
|
type: string
|
|
21397
22106
|
required: true
|
|
21398
22107
|
- in: path
|
|
21399
|
-
name:
|
|
22108
|
+
name: platform_key
|
|
21400
22109
|
schema:
|
|
21401
22110
|
type: string
|
|
21402
22111
|
required: true
|
|
21403
22112
|
tags:
|
|
21404
22113
|
- scim
|
|
22114
|
+
requestBody:
|
|
22115
|
+
content:
|
|
22116
|
+
application/json:
|
|
22117
|
+
schema:
|
|
22118
|
+
$ref: '#/components/schemas/SCIMUserCreateRequest'
|
|
22119
|
+
application/x-www-form-urlencoded:
|
|
22120
|
+
schema:
|
|
22121
|
+
$ref: '#/components/schemas/SCIMUserCreateRequest'
|
|
22122
|
+
multipart/form-data:
|
|
22123
|
+
schema:
|
|
22124
|
+
$ref: '#/components/schemas/SCIMUserCreateRequest'
|
|
22125
|
+
required: true
|
|
21405
22126
|
security:
|
|
21406
22127
|
- PlatformApiKeyAuthentication: []
|
|
21407
22128
|
responses:
|
|
21408
22129
|
'200':
|
|
21409
|
-
|
|
22130
|
+
content:
|
|
22131
|
+
application/json:
|
|
22132
|
+
schema:
|
|
22133
|
+
$ref: '#/components/schemas/SCIMUserResponse'
|
|
22134
|
+
description: ''
|
|
22135
|
+
'400':
|
|
22136
|
+
content:
|
|
22137
|
+
application/json:
|
|
22138
|
+
schema:
|
|
22139
|
+
description: Invalid request
|
|
22140
|
+
description: ''
|
|
22141
|
+
'401':
|
|
22142
|
+
content:
|
|
22143
|
+
application/json:
|
|
22144
|
+
schema:
|
|
22145
|
+
description: Unauthorized
|
|
22146
|
+
description: ''
|
|
22147
|
+
'403':
|
|
22148
|
+
content:
|
|
22149
|
+
application/json:
|
|
22150
|
+
schema:
|
|
22151
|
+
description: Forbidden
|
|
22152
|
+
description: ''
|
|
22153
|
+
'404':
|
|
22154
|
+
content:
|
|
22155
|
+
application/json:
|
|
22156
|
+
schema:
|
|
22157
|
+
description: User not found
|
|
22158
|
+
description: ''
|
|
21410
22159
|
delete:
|
|
21411
|
-
operationId:
|
|
21412
|
-
description:
|
|
22160
|
+
operationId: delete_user
|
|
22161
|
+
description: Delete a user for the specified platform (not supported)
|
|
22162
|
+
summary: Delete a user (not supported)
|
|
21413
22163
|
parameters:
|
|
21414
22164
|
- in: path
|
|
21415
22165
|
name: id
|
|
@@ -21417,7 +22167,7 @@ paths:
|
|
|
21417
22167
|
type: string
|
|
21418
22168
|
required: true
|
|
21419
22169
|
- in: path
|
|
21420
|
-
name:
|
|
22170
|
+
name: platform_key
|
|
21421
22171
|
schema:
|
|
21422
22172
|
type: string
|
|
21423
22173
|
required: true
|
|
@@ -21426,8 +22176,13 @@ paths:
|
|
|
21426
22176
|
security:
|
|
21427
22177
|
- PlatformApiKeyAuthentication: []
|
|
21428
22178
|
responses:
|
|
21429
|
-
'
|
|
21430
|
-
|
|
22179
|
+
'405':
|
|
22180
|
+
content:
|
|
22181
|
+
application/json:
|
|
22182
|
+
schema:
|
|
22183
|
+
description: Method not allowed - User deletion is not supported via
|
|
22184
|
+
SCIM
|
|
22185
|
+
description: ''
|
|
21431
22186
|
/api/overview/orgs/{org}/active-users:
|
|
21432
22187
|
get:
|
|
21433
22188
|
operationId: overview_orgs_active_users_retrieve
|
|
@@ -36082,6 +36837,385 @@ components:
|
|
|
36082
36837
|
description: Additional role data
|
|
36083
36838
|
required:
|
|
36084
36839
|
- name
|
|
36840
|
+
SCIMAddress:
|
|
36841
|
+
type: object
|
|
36842
|
+
description: SCIM address object serializer
|
|
36843
|
+
properties:
|
|
36844
|
+
type:
|
|
36845
|
+
type: string
|
|
36846
|
+
description: Address type (work, home, etc.)
|
|
36847
|
+
formatted:
|
|
36848
|
+
type: string
|
|
36849
|
+
description: Full formatted address
|
|
36850
|
+
streetAddress:
|
|
36851
|
+
type: string
|
|
36852
|
+
description: Street address
|
|
36853
|
+
locality:
|
|
36854
|
+
type: string
|
|
36855
|
+
description: City
|
|
36856
|
+
region:
|
|
36857
|
+
type: string
|
|
36858
|
+
description: State/region
|
|
36859
|
+
postalCode:
|
|
36860
|
+
type: string
|
|
36861
|
+
description: Postal code
|
|
36862
|
+
country:
|
|
36863
|
+
type: string
|
|
36864
|
+
description: Country
|
|
36865
|
+
required:
|
|
36866
|
+
- country
|
|
36867
|
+
- formatted
|
|
36868
|
+
- locality
|
|
36869
|
+
- postalCode
|
|
36870
|
+
- region
|
|
36871
|
+
- streetAddress
|
|
36872
|
+
- type
|
|
36873
|
+
SCIMDepartment:
|
|
36874
|
+
type: object
|
|
36875
|
+
description: SCIM department serializer
|
|
36876
|
+
properties:
|
|
36877
|
+
schemas:
|
|
36878
|
+
type: array
|
|
36879
|
+
items:
|
|
36880
|
+
type: string
|
|
36881
|
+
default:
|
|
36882
|
+
- urn:ietf:params:scim:schemas:core:2.0:Group
|
|
36883
|
+
description: SCIM schema identifiers
|
|
36884
|
+
id:
|
|
36885
|
+
type: string
|
|
36886
|
+
description: Department ID
|
|
36887
|
+
displayName:
|
|
36888
|
+
type: string
|
|
36889
|
+
description: Department display name
|
|
36890
|
+
description:
|
|
36891
|
+
type: string
|
|
36892
|
+
description: Department description
|
|
36893
|
+
meta:
|
|
36894
|
+
allOf:
|
|
36895
|
+
- $ref: '#/components/schemas/SCIMMeta'
|
|
36896
|
+
description: Resource metadata
|
|
36897
|
+
required:
|
|
36898
|
+
- displayName
|
|
36899
|
+
- id
|
|
36900
|
+
SCIMEmail:
|
|
36901
|
+
type: object
|
|
36902
|
+
description: SCIM email object serializer
|
|
36903
|
+
properties:
|
|
36904
|
+
value:
|
|
36905
|
+
type: string
|
|
36906
|
+
format: email
|
|
36907
|
+
description: Email address
|
|
36908
|
+
primary:
|
|
36909
|
+
type: boolean
|
|
36910
|
+
default: true
|
|
36911
|
+
description: Whether this is the primary email
|
|
36912
|
+
type:
|
|
36913
|
+
type: string
|
|
36914
|
+
default: work
|
|
36915
|
+
description: Email type (work, home, etc.)
|
|
36916
|
+
required:
|
|
36917
|
+
- value
|
|
36918
|
+
SCIMEnterpriseUser:
|
|
36919
|
+
type: object
|
|
36920
|
+
description: SCIM enterprise user extension serializer
|
|
36921
|
+
properties:
|
|
36922
|
+
edxData:
|
|
36923
|
+
description: edX user data
|
|
36924
|
+
userData:
|
|
36925
|
+
description: User metadata
|
|
36926
|
+
departments:
|
|
36927
|
+
type: array
|
|
36928
|
+
items:
|
|
36929
|
+
type: object
|
|
36930
|
+
additionalProperties: {}
|
|
36931
|
+
description: List of department memberships
|
|
36932
|
+
groups:
|
|
36933
|
+
type: array
|
|
36934
|
+
items:
|
|
36935
|
+
type: object
|
|
36936
|
+
additionalProperties: {}
|
|
36937
|
+
description: List of group memberships
|
|
36938
|
+
rbacGroups:
|
|
36939
|
+
type: array
|
|
36940
|
+
items:
|
|
36941
|
+
type: object
|
|
36942
|
+
additionalProperties: {}
|
|
36943
|
+
description: List of RBAC groups the user belongs to
|
|
36944
|
+
platforms:
|
|
36945
|
+
type: array
|
|
36946
|
+
items:
|
|
36947
|
+
type: object
|
|
36948
|
+
additionalProperties: {}
|
|
36949
|
+
description: List of platforms the user has access to
|
|
36950
|
+
SCIMGroup:
|
|
36951
|
+
type: object
|
|
36952
|
+
description: SCIM group serializer
|
|
36953
|
+
properties:
|
|
36954
|
+
schemas:
|
|
36955
|
+
type: array
|
|
36956
|
+
items:
|
|
36957
|
+
type: string
|
|
36958
|
+
default:
|
|
36959
|
+
- urn:ietf:params:scim:schemas:core:2.0:Group
|
|
36960
|
+
description: SCIM schema identifiers
|
|
36961
|
+
id:
|
|
36962
|
+
type: string
|
|
36963
|
+
description: Group ID
|
|
36964
|
+
displayName:
|
|
36965
|
+
type: string
|
|
36966
|
+
description: Group display name
|
|
36967
|
+
description:
|
|
36968
|
+
type: string
|
|
36969
|
+
description: Group description
|
|
36970
|
+
members:
|
|
36971
|
+
type: array
|
|
36972
|
+
items:
|
|
36973
|
+
type: object
|
|
36974
|
+
additionalProperties: {}
|
|
36975
|
+
description: Group members
|
|
36976
|
+
departments:
|
|
36977
|
+
type: array
|
|
36978
|
+
items:
|
|
36979
|
+
type: object
|
|
36980
|
+
additionalProperties: {}
|
|
36981
|
+
description: Group departments
|
|
36982
|
+
meta:
|
|
36983
|
+
allOf:
|
|
36984
|
+
- $ref: '#/components/schemas/SCIMMeta'
|
|
36985
|
+
description: Resource metadata
|
|
36986
|
+
data:
|
|
36987
|
+
type: object
|
|
36988
|
+
additionalProperties: {}
|
|
36989
|
+
description: Additional data
|
|
36990
|
+
required:
|
|
36991
|
+
- displayName
|
|
36992
|
+
- id
|
|
36993
|
+
SCIMMeta:
|
|
36994
|
+
type: object
|
|
36995
|
+
description: SCIM meta object serializer
|
|
36996
|
+
properties:
|
|
36997
|
+
resourceType:
|
|
36998
|
+
type: string
|
|
36999
|
+
description: Resource type
|
|
37000
|
+
created:
|
|
37001
|
+
type: string
|
|
37002
|
+
description: Creation timestamp
|
|
37003
|
+
lastModified:
|
|
37004
|
+
type: string
|
|
37005
|
+
description: Last modification timestamp
|
|
37006
|
+
version:
|
|
37007
|
+
type: string
|
|
37008
|
+
description: Resource version
|
|
37009
|
+
location:
|
|
37010
|
+
type: string
|
|
37011
|
+
description: Resource location URL
|
|
37012
|
+
SCIMName:
|
|
37013
|
+
type: object
|
|
37014
|
+
description: SCIM name object serializer
|
|
37015
|
+
properties:
|
|
37016
|
+
formatted:
|
|
37017
|
+
type: string
|
|
37018
|
+
description: Full formatted name
|
|
37019
|
+
familyName:
|
|
37020
|
+
type: string
|
|
37021
|
+
description: Family/last name
|
|
37022
|
+
givenName:
|
|
37023
|
+
type: string
|
|
37024
|
+
description: Given/first name
|
|
37025
|
+
required:
|
|
37026
|
+
- familyName
|
|
37027
|
+
- formatted
|
|
37028
|
+
- givenName
|
|
37029
|
+
SCIMPhoneNumber:
|
|
37030
|
+
type: object
|
|
37031
|
+
description: SCIM phone number object serializer
|
|
37032
|
+
properties:
|
|
37033
|
+
value:
|
|
37034
|
+
type: string
|
|
37035
|
+
description: Phone number
|
|
37036
|
+
type:
|
|
37037
|
+
type: string
|
|
37038
|
+
description: Phone type (work, home, mobile, etc.)
|
|
37039
|
+
required:
|
|
37040
|
+
- type
|
|
37041
|
+
- value
|
|
37042
|
+
SCIMUserCreateRequest:
|
|
37043
|
+
type: object
|
|
37044
|
+
description: SCIM user creation request serializer
|
|
37045
|
+
properties:
|
|
37046
|
+
schemas:
|
|
37047
|
+
type: array
|
|
37048
|
+
items:
|
|
37049
|
+
type: string
|
|
37050
|
+
default:
|
|
37051
|
+
- urn:ietf:params:scim:schemas:core:2.0:User
|
|
37052
|
+
description: SCIM schema identifiers
|
|
37053
|
+
userName:
|
|
37054
|
+
type: string
|
|
37055
|
+
description: Unique username/email for the user
|
|
37056
|
+
name:
|
|
37057
|
+
allOf:
|
|
37058
|
+
- $ref: '#/components/schemas/SCIMName'
|
|
37059
|
+
description: User's name information
|
|
37060
|
+
emails:
|
|
37061
|
+
type: array
|
|
37062
|
+
items:
|
|
37063
|
+
$ref: '#/components/schemas/SCIMEmail'
|
|
37064
|
+
description: User's email addresses
|
|
37065
|
+
active:
|
|
37066
|
+
type: boolean
|
|
37067
|
+
default: true
|
|
37068
|
+
description: Whether the user is active
|
|
37069
|
+
displayName:
|
|
37070
|
+
type: string
|
|
37071
|
+
description: Display name
|
|
37072
|
+
locale:
|
|
37073
|
+
type: string
|
|
37074
|
+
description: User locale
|
|
37075
|
+
timezone:
|
|
37076
|
+
type: string
|
|
37077
|
+
description: User timezone
|
|
37078
|
+
title:
|
|
37079
|
+
type: string
|
|
37080
|
+
description: Job title
|
|
37081
|
+
organization:
|
|
37082
|
+
type: string
|
|
37083
|
+
description: Organization
|
|
37084
|
+
phoneNumbers:
|
|
37085
|
+
type: array
|
|
37086
|
+
items:
|
|
37087
|
+
$ref: '#/components/schemas/SCIMPhoneNumber'
|
|
37088
|
+
description: Phone numbers
|
|
37089
|
+
addresses:
|
|
37090
|
+
type: array
|
|
37091
|
+
items:
|
|
37092
|
+
$ref: '#/components/schemas/SCIMAddress'
|
|
37093
|
+
description: Addresses
|
|
37094
|
+
entitlements:
|
|
37095
|
+
type: array
|
|
37096
|
+
items:
|
|
37097
|
+
type: string
|
|
37098
|
+
description: User entitlements
|
|
37099
|
+
roles:
|
|
37100
|
+
type: array
|
|
37101
|
+
items:
|
|
37102
|
+
type: string
|
|
37103
|
+
description: User roles
|
|
37104
|
+
x509Certificates:
|
|
37105
|
+
type: array
|
|
37106
|
+
items:
|
|
37107
|
+
type: string
|
|
37108
|
+
description: X.509 certificates
|
|
37109
|
+
password:
|
|
37110
|
+
type: string
|
|
37111
|
+
description: User password
|
|
37112
|
+
provider:
|
|
37113
|
+
type: string
|
|
37114
|
+
description: Authentication provider
|
|
37115
|
+
tpaUid:
|
|
37116
|
+
type: string
|
|
37117
|
+
description: Third-party authentication UID
|
|
37118
|
+
isStaff:
|
|
37119
|
+
type: boolean
|
|
37120
|
+
default: false
|
|
37121
|
+
description: Whether the user is a staff member
|
|
37122
|
+
update:
|
|
37123
|
+
type: boolean
|
|
37124
|
+
default: false
|
|
37125
|
+
description: Whether to update existing user
|
|
37126
|
+
platformOrgs:
|
|
37127
|
+
type: array
|
|
37128
|
+
items:
|
|
37129
|
+
type: string
|
|
37130
|
+
description: List of platform organizations to link the user to
|
|
37131
|
+
departmentIds:
|
|
37132
|
+
type: array
|
|
37133
|
+
items:
|
|
37134
|
+
type: integer
|
|
37135
|
+
description: List of department IDs to make the user a member of
|
|
37136
|
+
groupIds:
|
|
37137
|
+
type: array
|
|
37138
|
+
items:
|
|
37139
|
+
type: integer
|
|
37140
|
+
description: List of group IDs to add the user to
|
|
37141
|
+
rbacGroupUniqueIds:
|
|
37142
|
+
type: array
|
|
37143
|
+
items:
|
|
37144
|
+
type: string
|
|
37145
|
+
description: List of RBAC group unique IDs to add the user to
|
|
37146
|
+
meta:
|
|
37147
|
+
allOf:
|
|
37148
|
+
- $ref: '#/components/schemas/SCIMMeta'
|
|
37149
|
+
description: Resource metadata
|
|
37150
|
+
required:
|
|
37151
|
+
- emails
|
|
37152
|
+
- name
|
|
37153
|
+
- userName
|
|
37154
|
+
SCIMUserListResponse:
|
|
37155
|
+
type: object
|
|
37156
|
+
description: SCIM user list response serializer
|
|
37157
|
+
properties:
|
|
37158
|
+
schemas:
|
|
37159
|
+
type: array
|
|
37160
|
+
items:
|
|
37161
|
+
type: string
|
|
37162
|
+
description: SCIM schema identifiers
|
|
37163
|
+
totalResults:
|
|
37164
|
+
type: integer
|
|
37165
|
+
description: Total number of results
|
|
37166
|
+
Resources:
|
|
37167
|
+
type: array
|
|
37168
|
+
items:
|
|
37169
|
+
type: object
|
|
37170
|
+
additionalProperties: {}
|
|
37171
|
+
description: List of user resources
|
|
37172
|
+
required:
|
|
37173
|
+
- Resources
|
|
37174
|
+
- schemas
|
|
37175
|
+
- totalResults
|
|
37176
|
+
SCIMUserResponse:
|
|
37177
|
+
type: object
|
|
37178
|
+
description: SCIM user response serializer
|
|
37179
|
+
properties:
|
|
37180
|
+
schemas:
|
|
37181
|
+
type: array
|
|
37182
|
+
items:
|
|
37183
|
+
type: string
|
|
37184
|
+
description: SCIM schema identifiers
|
|
37185
|
+
id:
|
|
37186
|
+
type: string
|
|
37187
|
+
description: User ID
|
|
37188
|
+
userName:
|
|
37189
|
+
type: string
|
|
37190
|
+
description: Username
|
|
37191
|
+
name:
|
|
37192
|
+
allOf:
|
|
37193
|
+
- $ref: '#/components/schemas/SCIMName'
|
|
37194
|
+
description: User's name information
|
|
37195
|
+
emails:
|
|
37196
|
+
type: array
|
|
37197
|
+
items:
|
|
37198
|
+
$ref: '#/components/schemas/SCIMEmail'
|
|
37199
|
+
description: User's email addresses
|
|
37200
|
+
active:
|
|
37201
|
+
type: boolean
|
|
37202
|
+
description: Whether the user is active
|
|
37203
|
+
urn_ietf_params_scim_schemas_extension_enterprise_2_0_User:
|
|
37204
|
+
allOf:
|
|
37205
|
+
- $ref: '#/components/schemas/SCIMEnterpriseUser'
|
|
37206
|
+
description: Enterprise user extension data
|
|
37207
|
+
meta:
|
|
37208
|
+
allOf:
|
|
37209
|
+
- $ref: '#/components/schemas/SCIMMeta'
|
|
37210
|
+
description: Resource metadata
|
|
37211
|
+
required:
|
|
37212
|
+
- active
|
|
37213
|
+
- emails
|
|
37214
|
+
- id
|
|
37215
|
+
- name
|
|
37216
|
+
- schemas
|
|
37217
|
+
- urn_ietf_params_scim_schemas_extension_enterprise_2_0_User
|
|
37218
|
+
- userName
|
|
36085
37219
|
SendNotification:
|
|
36086
37220
|
type: object
|
|
36087
37221
|
description: Request serializer for sending notification
|