-
Notifications
You must be signed in to change notification settings - Fork 0
/
ezLDAP-openapi.yaml
405 lines (405 loc) · 10.1 KB
/
ezLDAP-openapi.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
openapi: 3.0.1
info:
title: ezLDAP API
description: >-
ezLDAP ermöglicht einen einfachen Lesezugriff auf das städtische LDAP
mittels einer HTTP API.
contact:
name: Michael Prankl
email: [email protected]
version: 2.0.5
servers:
# Added by API Auto Mocking Plugin
- description: SwaggerHub API Auto Mocking
url: https://virtserver.swaggerhub.com/ITMKM23/ezLDAP/2.0.5
tags:
- name: User
description: Lese/Suchzugriffe für Personen
- name: OU
description: Lese/Suchzugriffe für Organisationseinheiten (OU)
paths:
/v1/ldap/user/{lhmObjectId}:
get:
tags:
- User
summary: Lookup eines Users via lhmObjectId
operationId: getUserByLhmObjectId
parameters:
- name: lhmObjectId
in: path
description: lhmObjectId des Users
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/LdapUserDTO"
"401":
description: Unauthenticated
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Server Error
/v1/ldap/user/outree/{lhmObjectId}:
get:
tags:
- User
summary: Lookup des OU Baums des Users
operationId: ouTree
parameters:
- name: lhmObjectId
in: path
description: lhmObjectId des Users
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: string
"401":
description: Unauthenticated
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Server Error
/v1/ldap/search/findByUid:
get:
tags:
- User
summary: Lookup eines Users via uid
operationId: getUserByUid
parameters:
- name: uid
in: query
description: uid des Users
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/LdapUserDTO"
"401":
description: Unauthenticated
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Server Error
/v1/ldap/search/findByUidWildcard:
get:
tags:
- User
summary: Wildcard-unterstüztende Suche nach Usern via uid
operationId: searchUser
parameters:
- name: uid
in: query
description: uid des Users (* als Wildcards erlaubt)
required: true
schema:
maxLength: 2147483647
minLength: 3
type: string
- name: size
in: query
description: "Trefferanzahl, default: 10, Maximum: 100"
required: false
schema:
maximum: 100
type: integer
format: int32
default: 10
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/LdapBaseUserDTO"
"401":
description: Unauthenticated
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Server Error
/v1/ldap/search/findByOu:
get:
tags:
- User
summary: Lookup von Usern via OU Kurzbezeichnung
operationId: findByOu
parameters:
- name: ou
in: query
description: OU Kurzbezeichnung (z.B. ITM-KM21)
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/LdapBaseUserDTO"
"401":
description: Unauthenticated
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Server Error
/v1/ldap/outree/{ouShortCode}:
get:
tags:
- OU
summary: Lookup des OU Baums via OU Kurzbezeichnung
operationId: ouTree_1
parameters:
- name: ouShortCode
in: path
description: OU Kurzbezeichnung (z.B. ITM-KM21)
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: string
"401":
description: Unauthenticated
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Server Error
/v1/ldap/ou/{lhmObjectId}:
get:
tags:
- OU
summary: Lookup einer OU via lhmObjectId
operationId: getOuByLhmObjectId
parameters:
- name: lhmObjectId
in: path
description: lhmObjectId der OU
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/LdapOuDTO"
"401":
description: Unauthenticated
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Server Error
/v1/ldap/ou/search/findByOu:
get:
tags:
- OU
summary: Lookup einer OU via OU Kurzbezeichnung
operationId: findOuByOuShortcode
parameters:
- name: ou
in: query
description: OU Kurzbezeichnung (z.B. ITM-KM21)
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/LdapOuDTO"
"401":
description: Unauthenticated
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Server Error
components:
schemas:
AnschriftDTO:
type: object
properties:
strasse:
type: string
example: "Marienplatz 1"
plz:
type: string
example: "80331"
ort:
type: string
example: "München"
LdapUserDTO:
type: object
properties:
lhmObjectId:
type: string
example: "123456789"
uid:
type: string
example: "erika.musterfrau"
anrede:
type: string
example: "Frau"
vorname:
type: string
example: "Erika"
nachname:
type: string
example: "Musterfrau"
cn:
type: string
example: "Erika Musterfrau"
ou:
type: string
example: "REF-A1"
lhmOULongname:
type: string
example: "Abteilung 1"
lhmObjectPath:
type: string
example: "ou=Abteilung 1,ou=REF,o=LHM,c=de"
lhmOberOrga:
type: string
example: "Referat"
lhmReferatName:
type: string
example: "REF"
lhmFunctionalTitle:
type: string
example: "Lösungsberater"
amtsbezeichnung:
type: string
example: "Tech.Af"
erreichbarkeit:
type: string
mail:
type: string
example: "[email protected]"
lhmOrgaMail:
type: string
example: "[email protected]"
telephoneNumber:
type: string
example: "089 / 32 16 8"
facsimileTelephoneNumber:
type: string
example: "089 / 32 16 8"
mobile:
type: string
example: "089 / 32 16 8"
zimmer:
type: string
example: "EG.001"
postanschrift:
$ref: "#/components/schemas/AnschriftDTO"
bueroanschrift:
$ref: "#/components/schemas/AnschriftDTO"
personalTitle:
type: string
LdapBaseUserDTO:
type: object
properties:
lhmObjectId:
type: string
example: "123456789"
uid:
type: string
example: "erika.musterfrau"
anrede:
type: string
example: "Frau"
vorname:
type: string
example: "Erika"
nachname:
type: string
example: "Musterfrau"
cn:
type: string
example: "Erika Musterfrau"
ou:
type: string
example: "REF-A1"
LdapOuDTO:
type: object
properties:
lhmObjectId:
type: string
example: "123456789"
ou:
type: string
example: "REF-A1"
lhmOUKey:
type: string
lhmOULongname:
type: string
example: "Abteilung 1"
lhmOUShortname:
type: string
example: "REF-A1"
postalCode:
type: string
example: "80331"
street:
type: string
example: "Marienplatz 8"
mail:
type: string
example: "[email protected]"
telephoneNumber:
type: string
example: "089 / 32 16 8"
facsimileTelephoneNumber:
type: string
example: "089 / 32 16 8"
leitung:
$ref: "#/components/schemas/LdapUserDTO"
stellvertretung:
$ref: "#/components/schemas/LdapUserDTO"