Lines 128-130
Link Here
|
128 |
x-koha-authorization: |
128 |
x-koha-authorization: |
129 |
permissions: |
129 |
permissions: |
130 |
catalogue: "1" |
130 |
catalogue: "1" |
|
|
131 |
/auth/providers: |
132 |
get: |
133 |
x-mojo-to: Auth::Providers#list |
134 |
operationId: listAuthProviders |
135 |
tags: |
136 |
- auth_providers |
137 |
summary: List configured authentication providers |
138 |
parameters: |
139 |
- $ref: ../swagger.yaml#/parameters/match |
140 |
- $ref: ../swagger.yaml#/parameters/order_by |
141 |
- $ref: ../swagger.yaml#/parameters/page |
142 |
- $ref: ../swagger.yaml#/parameters/per_page |
143 |
- $ref: ../swagger.yaml#/parameters/q_param |
144 |
- $ref: ../swagger.yaml#/parameters/q_body |
145 |
- $ref: ../swagger.yaml#/parameters/q_header |
146 |
- $ref: ../swagger.yaml#/parameters/request_id_header |
147 |
- name: x-koha-embed |
148 |
in: header |
149 |
required: false |
150 |
description: Embed list sent as a request header |
151 |
type: array |
152 |
items: |
153 |
type: string |
154 |
enum: |
155 |
- domains |
156 |
collectionFormat: csv |
157 |
produces: |
158 |
- application/json |
159 |
responses: |
160 |
"200": |
161 |
description: A list of authentication providers |
162 |
schema: |
163 |
type: array |
164 |
items: |
165 |
$ref: ../swagger.yaml#/definitions/auth_provider |
166 |
"400": |
167 |
description: Bad Request |
168 |
schema: |
169 |
$ref: ../swagger.yaml#/definitions/error |
170 |
"403": |
171 |
description: Access forbidden |
172 |
schema: |
173 |
$ref: ../swagger.yaml#/definitions/error |
174 |
"500": |
175 |
description: | |
176 |
Internal server error. Possible `error_code` attribute values: |
177 |
|
178 |
* `internal_server_error` |
179 |
schema: |
180 |
$ref: ../swagger.yaml#/definitions/error |
181 |
"503": |
182 |
description: Under maintenance |
183 |
schema: |
184 |
$ref: ../swagger.yaml#/definitions/error |
185 |
x-koha-authorization: |
186 |
permissions: |
187 |
parameters: manage_authentication_providers |
188 |
post: |
189 |
x-mojo-to: Auth::Providers#add |
190 |
operationId: addAuthProvider |
191 |
tags: |
192 |
- auth_providers |
193 |
summary: Add a new authentication provider |
194 |
parameters: |
195 |
- name: body |
196 |
in: body |
197 |
description: | |
198 |
A JSON object containing OAuth provider parameters. |
199 |
|
200 |
The `config` object required attributes depends on the chosen `protocol` |
201 |
|
202 |
## OAuth |
203 |
|
204 |
Requires: |
205 |
|
206 |
* key |
207 |
* secret |
208 |
* authorize_url |
209 |
* token_url |
210 |
|
211 |
## OIDC |
212 |
|
213 |
Requires: |
214 |
|
215 |
* key |
216 |
* secret |
217 |
* well_known_url |
218 |
required: true |
219 |
schema: |
220 |
$ref: ../swagger.yaml#/definitions/auth_provider |
221 |
produces: |
222 |
- application/json |
223 |
responses: |
224 |
"201": |
225 |
description: The generated authentication provider |
226 |
schema: |
227 |
$ref: ../swagger.yaml#/definitions/auth_provider |
228 |
"400": |
229 |
description: Bad Request |
230 |
schema: |
231 |
$ref: ../swagger.yaml#/definitions/error |
232 |
"403": |
233 |
description: Access forbidden |
234 |
schema: |
235 |
$ref: ../swagger.yaml#/definitions/error |
236 |
"500": |
237 |
description: | |
238 |
Internal server error. Possible `error_code` attribute values: |
239 |
|
240 |
* `internal_server_error` |
241 |
schema: |
242 |
$ref: ../swagger.yaml#/definitions/error |
243 |
"503": |
244 |
description: Under maintenance |
245 |
schema: |
246 |
$ref: ../swagger.yaml#/definitions/error |
247 |
x-koha-authorization: |
248 |
permissions: |
249 |
parameters: manage_authentication_providers |
250 |
"/auth/providers/{auth_provider_id}": |
251 |
get: |
252 |
x-mojo-to: Auth::Providers#get |
253 |
operationId: getAuthProvider |
254 |
tags: |
255 |
- auth_providers |
256 |
summary: Get authentication provider |
257 |
parameters: |
258 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
259 |
- name: x-koha-embed |
260 |
in: header |
261 |
required: false |
262 |
description: Embed list sent as a request header |
263 |
type: array |
264 |
items: |
265 |
type: string |
266 |
enum: |
267 |
- domains |
268 |
collectionFormat: csv |
269 |
produces: |
270 |
- application/json |
271 |
responses: |
272 |
"200": |
273 |
description: An authentication provider |
274 |
schema: |
275 |
$ref: ../swagger.yaml#/definitions/auth_provider |
276 |
"404": |
277 |
description: Object not found |
278 |
schema: |
279 |
$ref: ../swagger.yaml#/definitions/error |
280 |
"500": |
281 |
description: | |
282 |
Internal server error. Possible `error_code` attribute values: |
283 |
|
284 |
* `internal_server_error` |
285 |
schema: |
286 |
$ref: ../swagger.yaml#/definitions/error |
287 |
"503": |
288 |
description: Under maintenance |
289 |
schema: |
290 |
$ref: ../swagger.yaml#/definitions/error |
291 |
x-koha-authorization: |
292 |
permissions: |
293 |
parameters: manage_authentication_providers |
294 |
put: |
295 |
x-mojo-to: Auth::Providers#update |
296 |
operationId: updateAuthProvider |
297 |
tags: |
298 |
- auth_providers |
299 |
summary: Update an authentication provider |
300 |
parameters: |
301 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
302 |
- name: body |
303 |
in: body |
304 |
description: | |
305 |
A JSON object containing OAuth provider parameters. |
306 |
|
307 |
The `config` object required attributes depends on the chosen `protocol` |
308 |
|
309 |
## OAuth |
310 |
|
311 |
Requires: |
312 |
|
313 |
* key |
314 |
* secret |
315 |
* authorize_url |
316 |
* token_url |
317 |
|
318 |
## OIDC |
319 |
|
320 |
Requires: |
321 |
|
322 |
* key |
323 |
* secret |
324 |
* well_known_url |
325 |
required: true |
326 |
schema: |
327 |
$ref: ../swagger.yaml#/definitions/auth_provider |
328 |
produces: |
329 |
- application/json |
330 |
responses: |
331 |
"200": |
332 |
description: Updated authentication provider |
333 |
schema: |
334 |
$ref: ../swagger.yaml#/definitions/auth_provider |
335 |
"400": |
336 |
description: Bad Request |
337 |
schema: |
338 |
$ref: ../swagger.yaml#/definitions/error |
339 |
"403": |
340 |
description: Access forbidden |
341 |
schema: |
342 |
$ref: ../swagger.yaml#/definitions/error |
343 |
"404": |
344 |
description: Object not found |
345 |
schema: |
346 |
$ref: ../swagger.yaml#/definitions/error |
347 |
"500": |
348 |
description: | |
349 |
Internal server error. Possible `error_code` attribute values: |
350 |
|
351 |
* `internal_server_error` |
352 |
schema: |
353 |
$ref: ../swagger.yaml#/definitions/error |
354 |
"503": |
355 |
description: Under maintenance |
356 |
schema: |
357 |
$ref: ../swagger.yaml#/definitions/error |
358 |
x-koha-authorization: |
359 |
permissions: |
360 |
parameters: manage_authentication_providers |
361 |
delete: |
362 |
x-mojo-to: Auth::Providers#delete |
363 |
operationId: delAuthProvider |
364 |
tags: |
365 |
- auth_providers |
366 |
summary: Delete authentication provider |
367 |
parameters: |
368 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
369 |
produces: |
370 |
- application/json |
371 |
responses: |
372 |
"204": |
373 |
description: Authentication provider deleted |
374 |
"401": |
375 |
description: Authentication required |
376 |
schema: |
377 |
$ref: ../swagger.yaml#/definitions/error |
378 |
"403": |
379 |
description: Access forbidden |
380 |
schema: |
381 |
$ref: ../swagger.yaml#/definitions/error |
382 |
"404": |
383 |
description: City not found |
384 |
schema: |
385 |
$ref: ../swagger.yaml#/definitions/error |
386 |
"500": |
387 |
description: | |
388 |
Internal server error. Possible `error_code` attribute values: |
389 |
|
390 |
* `internal_server_error` |
391 |
"503": |
392 |
description: Under maintenance |
393 |
schema: |
394 |
$ref: ../swagger.yaml#/definitions/error |
395 |
x-koha-authorization: |
396 |
permissions: |
397 |
parameters: manage_authentication_providers |
398 |
"/auth/providers/{auth_provider_id}/domains": |
399 |
get: |
400 |
x-mojo-to: Auth::Provider::Domains#list |
401 |
operationId: listAuthProviderDomains |
402 |
tags: |
403 |
- auth_providers |
404 |
summary: Get authentication provider configured domains |
405 |
parameters: |
406 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
407 |
- $ref: ../swagger.yaml#/parameters/match |
408 |
- $ref: ../swagger.yaml#/parameters/order_by |
409 |
- $ref: ../swagger.yaml#/parameters/page |
410 |
- $ref: ../swagger.yaml#/parameters/per_page |
411 |
- $ref: ../swagger.yaml#/parameters/q_param |
412 |
- $ref: ../swagger.yaml#/parameters/q_body |
413 |
- $ref: ../swagger.yaml#/parameters/q_header |
414 |
- $ref: ../swagger.yaml#/parameters/request_id_header |
415 |
- name: x-koha-embed |
416 |
in: header |
417 |
required: false |
418 |
description: Embed list sent as a request header |
419 |
type: array |
420 |
items: |
421 |
type: string |
422 |
enum: |
423 |
- domains |
424 |
collectionFormat: csv |
425 |
produces: |
426 |
- application/json |
427 |
responses: |
428 |
"200": |
429 |
description: An authentication provider |
430 |
schema: |
431 |
items: |
432 |
$ref: ../swagger.yaml#/definitions/auth_provider_domain |
433 |
"404": |
434 |
description: Object not found |
435 |
schema: |
436 |
$ref: ../swagger.yaml#/definitions/error |
437 |
"500": |
438 |
description: | |
439 |
Internal server error. Possible `error_code` attribute values: |
440 |
|
441 |
* `internal_server_error` |
442 |
schema: |
443 |
$ref: ../swagger.yaml#/definitions/error |
444 |
"503": |
445 |
description: Under maintenance |
446 |
schema: |
447 |
$ref: ../swagger.yaml#/definitions/error |
448 |
x-koha-authorization: |
449 |
permissions: |
450 |
parameters: manage_authentication_providers |
451 |
post: |
452 |
x-mojo-to: Auth::Provider::Domains#add |
453 |
operationId: addAuthProviderDomain |
454 |
tags: |
455 |
- auth_providers |
456 |
summary: Add an authentication provider domain |
457 |
parameters: |
458 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
459 |
- name: body |
460 |
in: body |
461 |
description: An authentication provider domain object |
462 |
required: true |
463 |
schema: |
464 |
$ref: ../swagger.yaml#/definitions/auth_provider_domain |
465 |
produces: |
466 |
- application/json |
467 |
responses: |
468 |
"201": |
469 |
description: Updated authentication provider domain |
470 |
schema: |
471 |
$ref: ../swagger.yaml#/definitions/auth_provider_domain |
472 |
"400": |
473 |
description: Bad Request |
474 |
schema: |
475 |
$ref: ../swagger.yaml#/definitions/error |
476 |
"403": |
477 |
description: Access forbidden |
478 |
schema: |
479 |
$ref: ../swagger.yaml#/definitions/error |
480 |
"404": |
481 |
description: Object not found |
482 |
schema: |
483 |
$ref: ../swagger.yaml#/definitions/error |
484 |
"500": |
485 |
description: | |
486 |
Internal server error. Possible `error_code` attribute values: |
487 |
|
488 |
* `internal_server_error` |
489 |
schema: |
490 |
$ref: ../swagger.yaml#/definitions/error |
491 |
"503": |
492 |
description: Under maintenance |
493 |
schema: |
494 |
$ref: ../swagger.yaml#/definitions/error |
495 |
x-koha-authorization: |
496 |
permissions: |
497 |
parameters: manage_authentication_providers |
498 |
"/auth/providers/{auth_provider_id}/domains/{auth_provider_domain_id}": |
499 |
get: |
500 |
x-mojo-to: Auth::Provider::Domains#get |
501 |
operationId: getAuthProviderDomain |
502 |
tags: |
503 |
- auth_providers |
504 |
summary: Get authentication provider domain |
505 |
parameters: |
506 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
507 |
- $ref: ../swagger.yaml#/parameters/auth_provider_domain_id_pp |
508 |
produces: |
509 |
- application/json |
510 |
responses: |
511 |
"200": |
512 |
description: An authentication provider |
513 |
schema: |
514 |
$ref: ../swagger.yaml#/definitions/auth_provider_domain |
515 |
"404": |
516 |
description: Object not found |
517 |
schema: |
518 |
$ref: ../swagger.yaml#/definitions/error |
519 |
"500": |
520 |
description: | |
521 |
Internal server error. Possible `error_code` attribute values: |
522 |
|
523 |
* `internal_server_error` |
524 |
schema: |
525 |
$ref: ../swagger.yaml#/definitions/error |
526 |
"503": |
527 |
description: Under maintenance |
528 |
schema: |
529 |
$ref: ../swagger.yaml#/definitions/error |
530 |
x-koha-authorization: |
531 |
permissions: |
532 |
parameters: manage_authentication_providers |
533 |
delete: |
534 |
x-mojo-to: Auth::Provider::Domains#delete |
535 |
operationId: delAuthProviderDomain |
536 |
tags: |
537 |
- auth_providers |
538 |
summary: Delete authentication provider |
539 |
parameters: |
540 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
541 |
- $ref: ../swagger.yaml#/parameters/auth_provider_domain_id_pp |
542 |
produces: |
543 |
- application/json |
544 |
responses: |
545 |
"204": |
546 |
description: Authentication provider deleted |
547 |
"401": |
548 |
description: Authentication required |
549 |
schema: |
550 |
$ref: ../swagger.yaml#/definitions/error |
551 |
"403": |
552 |
description: Access forbidden |
553 |
schema: |
554 |
$ref: ../swagger.yaml#/definitions/error |
555 |
"404": |
556 |
description: City not found |
557 |
schema: |
558 |
$ref: ../swagger.yaml#/definitions/error |
559 |
"500": |
560 |
description: | |
561 |
Internal server error. Possible `error_code` attribute values: |
562 |
|
563 |
* `internal_server_error` |
564 |
"503": |
565 |
description: Under maintenance |
566 |
schema: |
567 |
$ref: ../swagger.yaml#/definitions/error |
568 |
x-koha-authorization: |
569 |
permissions: |
570 |
parameters: manage_authentication_providers |