-
Notifications
You must be signed in to change notification settings - Fork 0
/
user.yaml
245 lines (245 loc) · 6.75 KB
/
user.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
swagger: '2.0'
info:
description: SCIM 2.0 /Users endpoint
version: 1.0.0
title: /Users Endpoint Swagger Definition
contact:
name: WSO2 Identity Server Team
url: 'http://wso2.com'
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0'
basePath: /scim/v2/Users
tags:
- name: scimv2Users
paths:
/scim/v2/Users:
get:
tags:
- scimv2Users
summary: 'Return users according to the filter, sort and pagination parameters'
description: Returns HTTP 404 if the users are not found.
operationId: getUser
produces:
- application/json
- application/scim+json
parameters:
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: array
uniqueItems: true
collectionFormat: csv
items:
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: array
uniqueItems: true
collectionFormat: csv
items:
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
responses:
'200':
description: Valid users are found
'404':
description: Valid users are not found
post:
tags:
- scimv2Users
summary: Return the user which was created
description: Returns HTTP 201 if the user is successfully created.
operationId: createUser
consumes:
- application/scim+json
produces:
- application/json
- application/scim+json
parameters:
- name: attributes
in: query
description: SCIM defined attributes parameter.
required: false
type: array
uniqueItems: true
collectionFormat: csv
items:
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: array
uniqueItems: true
collectionFormat: csv
items:
type: string
- in: body
name: body
required: false
schema:
type: string
responses:
'201':
description: Valid user is created
'404':
description: User is not found
/scim/v2/Users/.search:
post:
tags:
- scimv2Users
summary: 'Return users according to the filter, sort and pagination parameters'
description: Returns HTTP 404 if the users are not found.
operationId: getUsersByPost
consumes:
- application/scim+json
produces:
- application/json
- application/scim+json
parameters:
- in: body
name: body
required: false
schema:
type: string
responses:
'200':
description: Valid users are found
'404':
description: Valid users are not found
'/scim/v2/Users/{id}':
get:
tags:
- scimv2Users
summary: Return the user with the given id
description: Returns HTTP 200 if the user is found.
operationId: getUser by id
produces:
- application/json
- 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: array
uniqueItems: true
collectionFormat: csv
items:
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: array
uniqueItems: true
collectionFormat: csv
items:
type: string
responses:
'200':
description: Valid user is found
'404':
description: Valid user is not found
put:
tags:
- scimv2Users
summary: Return the updated user
description: Returns HTTP 404 if the user is not found.
operationId: updateUser
consumes:
- application/scim+json
produces:
- application/json
- 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: array
uniqueItems: true
collectionFormat: csv
items:
type: string
- name: excludedAttributes
in: query
description: SCIM defined excludedAttribute parameter.
required: false
type: array
uniqueItems: true
collectionFormat: csv
items:
type: string
- in: body
name: body
required: false
schema:
type: string
responses:
'200':
description: User is updated
'404':
description: Valid user is not found
delete:
tags:
- scimv2Users
summary: Delete the user with the given id
description: Returns HTTP 204 if the user is successfully deleted.
operationId: deleteUser
produces:
- application/json
- 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
'404':
description: Valid user is not found