|
Lines 1-4
Link Here
|
| 1 |
--- |
|
|
| 2 |
/auth/otp/token_delivery: |
1 |
/auth/otp/token_delivery: |
| 3 |
post: |
2 |
post: |
| 4 |
x-mojo-to: TwoFactorAuth#send_otp_token |
3 |
x-mojo-to: TwoFactorAuth#send_otp_token |
|
Lines 24-41
Link Here
|
| 24 |
"400": |
23 |
"400": |
| 25 |
description: Bad Request |
24 |
description: Bad Request |
| 26 |
schema: |
25 |
schema: |
| 27 |
$ref: "../swagger.yaml#/definitions/error" |
26 |
$ref: ../swagger.yaml#/definitions/error |
| 28 |
"403": |
27 |
"403": |
| 29 |
description: Access forbidden |
28 |
description: Access forbidden |
| 30 |
schema: |
29 |
schema: |
| 31 |
$ref: "../swagger.yaml#/definitions/error" |
30 |
$ref: ../swagger.yaml#/definitions/error |
| 32 |
"500": |
31 |
"500": |
| 33 |
description: | |
32 |
description: | |
| 34 |
Internal server error. Possible `error_code` attribute values: |
33 |
Internal server error. Possible `error_code` attribute values: |
| 35 |
|
34 |
|
| 36 |
* `internal_server_error` |
35 |
* `internal_server_error` |
| 37 |
schema: |
36 |
schema: |
| 38 |
$ref: "../swagger.yaml#/definitions/error" |
37 |
$ref: ../swagger.yaml#/definitions/error |
|
|
38 |
"503": |
| 39 |
description: Under maintenance |
| 40 |
schema: |
| 41 |
$ref: ../swagger.yaml#/definitions/error |
| 42 |
x-koha-authorization: |
| 43 |
permissions: |
| 44 |
parameters: manage_authentication_providers |
| 45 |
/auth/providers: |
| 46 |
get: |
| 47 |
x-mojo-to: Auth::Providers#list |
| 48 |
operationId: listAuthProviders |
| 49 |
tags: |
| 50 |
- auth_providers |
| 51 |
summary: List configured authentication providers |
| 52 |
parameters: |
| 53 |
- $ref: ../swagger.yaml#/parameters/match |
| 54 |
- $ref: ../swagger.yaml#/parameters/order_by |
| 55 |
- $ref: ../swagger.yaml#/parameters/page |
| 56 |
- $ref: ../swagger.yaml#/parameters/per_page |
| 57 |
- $ref: ../swagger.yaml#/parameters/q_param |
| 58 |
- $ref: ../swagger.yaml#/parameters/q_body |
| 59 |
- $ref: ../swagger.yaml#/parameters/q_header |
| 60 |
- $ref: ../swagger.yaml#/parameters/request_id_header |
| 61 |
- name: x-koha-embed |
| 62 |
in: header |
| 63 |
required: false |
| 64 |
description: Embed list sent as a request header |
| 65 |
type: array |
| 66 |
items: |
| 67 |
type: string |
| 68 |
enum: |
| 69 |
- domains |
| 70 |
collectionFormat: csv |
| 71 |
produces: |
| 72 |
- application/json |
| 73 |
responses: |
| 74 |
"200": |
| 75 |
description: A list of authentication providers |
| 76 |
schema: |
| 77 |
type: array |
| 78 |
items: |
| 79 |
$ref: ../swagger.yaml#/definitions/auth_provider |
| 80 |
"400": |
| 81 |
description: Bad Request |
| 82 |
schema: |
| 83 |
$ref: ../swagger.yaml#/definitions/error |
| 84 |
"403": |
| 85 |
description: Access forbidden |
| 86 |
schema: |
| 87 |
$ref: ../swagger.yaml#/definitions/error |
| 88 |
"500": |
| 89 |
description: | |
| 90 |
Internal server error. Possible `error_code` attribute values: |
| 91 |
|
| 92 |
* `internal_server_error` |
| 93 |
schema: |
| 94 |
$ref: ../swagger.yaml#/definitions/error |
| 95 |
"503": |
| 96 |
description: Under maintenance |
| 97 |
schema: |
| 98 |
$ref: ../swagger.yaml#/definitions/error |
| 99 |
x-koha-authorization: |
| 100 |
permissions: |
| 101 |
parameters: manage_authentication_providers |
| 102 |
post: |
| 103 |
x-mojo-to: Auth::Providers#add |
| 104 |
operationId: addAuthProvider |
| 105 |
tags: |
| 106 |
- auth_providers |
| 107 |
summary: Add a new authentication provider |
| 108 |
parameters: |
| 109 |
- name: body |
| 110 |
in: body |
| 111 |
description: | |
| 112 |
A JSON object containing OAuth provider parameters. |
| 113 |
|
| 114 |
The `config` object required attributes depends on the chosen `protocol` |
| 115 |
|
| 116 |
## OAuth |
| 117 |
|
| 118 |
Requires: |
| 119 |
|
| 120 |
* key |
| 121 |
* secret |
| 122 |
* authorize_url |
| 123 |
* token_url |
| 124 |
|
| 125 |
## OIDC |
| 126 |
|
| 127 |
Requires: |
| 128 |
|
| 129 |
* key |
| 130 |
* secret |
| 131 |
* well_known_url |
| 132 |
required: true |
| 133 |
schema: |
| 134 |
$ref: ../swagger.yaml#/definitions/auth_provider |
| 135 |
produces: |
| 136 |
- application/json |
| 137 |
responses: |
| 138 |
"201": |
| 139 |
description: The generated authentication provider |
| 140 |
schema: |
| 141 |
$ref: ../swagger.yaml#/definitions/auth_provider |
| 142 |
"400": |
| 143 |
description: Bad Request |
| 144 |
schema: |
| 145 |
$ref: ../swagger.yaml#/definitions/error |
| 146 |
"403": |
| 147 |
description: Access forbidden |
| 148 |
schema: |
| 149 |
$ref: ../swagger.yaml#/definitions/error |
| 150 |
"500": |
| 151 |
description: | |
| 152 |
Internal server error. Possible `error_code` attribute values: |
| 153 |
|
| 154 |
* `internal_server_error` |
| 155 |
schema: |
| 156 |
$ref: ../swagger.yaml#/definitions/error |
| 157 |
"503": |
| 158 |
description: Under maintenance |
| 159 |
schema: |
| 160 |
$ref: ../swagger.yaml#/definitions/error |
| 161 |
x-koha-authorization: |
| 162 |
permissions: |
| 163 |
parameters: manage_authentication_providers |
| 164 |
"/auth/providers/{auth_provider_id}": |
| 165 |
get: |
| 166 |
x-mojo-to: Auth::Providers#get |
| 167 |
operationId: getAuthProvider |
| 168 |
tags: |
| 169 |
- auth_providers |
| 170 |
summary: Get authentication provider |
| 171 |
parameters: |
| 172 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
| 173 |
- name: x-koha-embed |
| 174 |
in: header |
| 175 |
required: false |
| 176 |
description: Embed list sent as a request header |
| 177 |
type: array |
| 178 |
items: |
| 179 |
type: string |
| 180 |
enum: |
| 181 |
- domains |
| 182 |
collectionFormat: csv |
| 183 |
produces: |
| 184 |
- application/json |
| 185 |
responses: |
| 186 |
"200": |
| 187 |
description: An authentication provider |
| 188 |
schema: |
| 189 |
$ref: ../swagger.yaml#/definitions/auth_provider |
| 190 |
"404": |
| 191 |
description: Object not found |
| 192 |
schema: |
| 193 |
$ref: ../swagger.yaml#/definitions/error |
| 194 |
"500": |
| 195 |
description: | |
| 196 |
Internal server error. Possible `error_code` attribute values: |
| 197 |
|
| 198 |
* `internal_server_error` |
| 199 |
schema: |
| 200 |
$ref: ../swagger.yaml#/definitions/error |
| 201 |
"503": |
| 202 |
description: Under maintenance |
| 203 |
schema: |
| 204 |
$ref: ../swagger.yaml#/definitions/error |
| 205 |
x-koha-authorization: |
| 206 |
permissions: |
| 207 |
parameters: manage_authentication_providers |
| 208 |
put: |
| 209 |
x-mojo-to: Auth::Providers#update |
| 210 |
operationId: updateAuthProvider |
| 211 |
tags: |
| 212 |
- auth_providers |
| 213 |
summary: Update an authentication provider |
| 214 |
parameters: |
| 215 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
| 216 |
- name: body |
| 217 |
in: body |
| 218 |
description: | |
| 219 |
A JSON object containing OAuth provider parameters. |
| 220 |
|
| 221 |
The `config` object required attributes depends on the chosen `protocol` |
| 222 |
|
| 223 |
## OAuth |
| 224 |
|
| 225 |
Requires: |
| 226 |
|
| 227 |
* key |
| 228 |
* secret |
| 229 |
* authorize_url |
| 230 |
* token_url |
| 231 |
|
| 232 |
## OIDC |
| 233 |
|
| 234 |
Requires: |
| 235 |
|
| 236 |
* key |
| 237 |
* secret |
| 238 |
* well_known_url |
| 239 |
required: true |
| 240 |
schema: |
| 241 |
$ref: ../swagger.yaml#/definitions/auth_provider |
| 242 |
produces: |
| 243 |
- application/json |
| 244 |
responses: |
| 245 |
"200": |
| 246 |
description: Updated authentication provider |
| 247 |
schema: |
| 248 |
$ref: ../swagger.yaml#/definitions/auth_provider |
| 249 |
"400": |
| 250 |
description: Bad Request |
| 251 |
schema: |
| 252 |
$ref: ../swagger.yaml#/definitions/error |
| 253 |
"403": |
| 254 |
description: Access forbidden |
| 255 |
schema: |
| 256 |
$ref: ../swagger.yaml#/definitions/error |
| 257 |
"404": |
| 258 |
description: Object not found |
| 259 |
schema: |
| 260 |
$ref: ../swagger.yaml#/definitions/error |
| 261 |
"500": |
| 262 |
description: | |
| 263 |
Internal server error. Possible `error_code` attribute values: |
| 264 |
|
| 265 |
* `internal_server_error` |
| 266 |
schema: |
| 267 |
$ref: ../swagger.yaml#/definitions/error |
| 268 |
"503": |
| 269 |
description: Under maintenance |
| 270 |
schema: |
| 271 |
$ref: ../swagger.yaml#/definitions/error |
| 272 |
x-koha-authorization: |
| 273 |
permissions: |
| 274 |
parameters: manage_authentication_providers |
| 275 |
delete: |
| 276 |
x-mojo-to: Auth::Providers#delete |
| 277 |
operationId: delAuthProvider |
| 278 |
tags: |
| 279 |
- auth_providers |
| 280 |
summary: Delete authentication provider |
| 281 |
parameters: |
| 282 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
| 283 |
produces: |
| 284 |
- application/json |
| 285 |
responses: |
| 286 |
"204": |
| 287 |
description: Authentication provider deleted |
| 288 |
"401": |
| 289 |
description: Authentication required |
| 290 |
schema: |
| 291 |
$ref: ../swagger.yaml#/definitions/error |
| 292 |
"403": |
| 293 |
description: Access forbidden |
| 294 |
schema: |
| 295 |
$ref: ../swagger.yaml#/definitions/error |
| 296 |
"404": |
| 297 |
description: City not found |
| 298 |
schema: |
| 299 |
$ref: ../swagger.yaml#/definitions/error |
| 300 |
"500": |
| 301 |
description: | |
| 302 |
Internal server error. Possible `error_code` attribute values: |
| 303 |
|
| 304 |
* `internal_server_error` |
| 305 |
"503": |
| 306 |
description: Under maintenance |
| 307 |
schema: |
| 308 |
$ref: ../swagger.yaml#/definitions/error |
| 309 |
x-koha-authorization: |
| 310 |
permissions: |
| 311 |
parameters: manage_authentication_providers |
| 312 |
"/auth/providers/{auth_provider_id}/domains": |
| 313 |
get: |
| 314 |
x-mojo-to: Auth::Provider::Domains#list |
| 315 |
operationId: listAuthProviderDomains |
| 316 |
tags: |
| 317 |
- auth_providers |
| 318 |
summary: Get authentication provider configured domains |
| 319 |
parameters: |
| 320 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
| 321 |
- $ref: ../swagger.yaml#/parameters/match |
| 322 |
- $ref: ../swagger.yaml#/parameters/order_by |
| 323 |
- $ref: ../swagger.yaml#/parameters/page |
| 324 |
- $ref: ../swagger.yaml#/parameters/per_page |
| 325 |
- $ref: ../swagger.yaml#/parameters/q_param |
| 326 |
- $ref: ../swagger.yaml#/parameters/q_body |
| 327 |
- $ref: ../swagger.yaml#/parameters/q_header |
| 328 |
- $ref: ../swagger.yaml#/parameters/request_id_header |
| 329 |
- name: x-koha-embed |
| 330 |
in: header |
| 331 |
required: false |
| 332 |
description: Embed list sent as a request header |
| 333 |
type: array |
| 334 |
items: |
| 335 |
type: string |
| 336 |
enum: |
| 337 |
- domains |
| 338 |
collectionFormat: csv |
| 339 |
produces: |
| 340 |
- application/json |
| 341 |
responses: |
| 342 |
"200": |
| 343 |
description: An authentication provider |
| 344 |
schema: |
| 345 |
items: |
| 346 |
$ref: ../swagger.yaml#/definitions/auth_provider_domain |
| 347 |
"404": |
| 348 |
description: Object not found |
| 349 |
schema: |
| 350 |
$ref: ../swagger.yaml#/definitions/error |
| 351 |
"500": |
| 352 |
description: | |
| 353 |
Internal server error. Possible `error_code` attribute values: |
| 354 |
|
| 355 |
* `internal_server_error` |
| 356 |
schema: |
| 357 |
$ref: ../swagger.yaml#/definitions/error |
| 358 |
"503": |
| 359 |
description: Under maintenance |
| 360 |
schema: |
| 361 |
$ref: ../swagger.yaml#/definitions/error |
| 362 |
x-koha-authorization: |
| 363 |
permissions: |
| 364 |
parameters: manage_authentication_providers |
| 365 |
post: |
| 366 |
x-mojo-to: Auth::Provider::Domains#add |
| 367 |
operationId: addAuthProviderDomain |
| 368 |
tags: |
| 369 |
- auth_providers |
| 370 |
summary: Add an authentication provider domain |
| 371 |
parameters: |
| 372 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
| 373 |
- name: body |
| 374 |
in: body |
| 375 |
description: An authentication provider domain object |
| 376 |
required: true |
| 377 |
schema: |
| 378 |
$ref: ../swagger.yaml#/definitions/auth_provider_domain |
| 379 |
produces: |
| 380 |
- application/json |
| 381 |
responses: |
| 382 |
"201": |
| 383 |
description: Updated authentication provider domain |
| 384 |
schema: |
| 385 |
$ref: ../swagger.yaml#/definitions/auth_provider_domain |
| 386 |
"400": |
| 387 |
description: Bad Request |
| 388 |
schema: |
| 389 |
$ref: ../swagger.yaml#/definitions/error |
| 390 |
"403": |
| 391 |
description: Access forbidden |
| 392 |
schema: |
| 393 |
$ref: ../swagger.yaml#/definitions/error |
| 394 |
"404": |
| 395 |
description: Object not found |
| 396 |
schema: |
| 397 |
$ref: ../swagger.yaml#/definitions/error |
| 398 |
"500": |
| 399 |
description: | |
| 400 |
Internal server error. Possible `error_code` attribute values: |
| 401 |
|
| 402 |
* `internal_server_error` |
| 403 |
schema: |
| 404 |
$ref: ../swagger.yaml#/definitions/error |
| 405 |
"503": |
| 406 |
description: Under maintenance |
| 407 |
schema: |
| 408 |
$ref: ../swagger.yaml#/definitions/error |
| 409 |
x-koha-authorization: |
| 410 |
permissions: |
| 411 |
parameters: manage_authentication_providers |
| 412 |
"/auth/providers/{auth_provider_id}/domains/{auth_provider_domain_id}": |
| 413 |
get: |
| 414 |
x-mojo-to: Auth::Provider::Domains#get |
| 415 |
operationId: getAuthProviderDomain |
| 416 |
tags: |
| 417 |
- auth_providers |
| 418 |
summary: Get authentication provider domain |
| 419 |
parameters: |
| 420 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
| 421 |
- $ref: ../swagger.yaml#/parameters/auth_provider_domain_id_pp |
| 422 |
produces: |
| 423 |
- application/json |
| 424 |
responses: |
| 425 |
"200": |
| 426 |
description: An authentication provider |
| 427 |
schema: |
| 428 |
$ref: ../swagger.yaml#/definitions/auth_provider_domain |
| 429 |
"404": |
| 430 |
description: Object not found |
| 431 |
schema: |
| 432 |
$ref: ../swagger.yaml#/definitions/error |
| 433 |
"500": |
| 434 |
description: | |
| 435 |
Internal server error. Possible `error_code` attribute values: |
| 436 |
|
| 437 |
* `internal_server_error` |
| 438 |
schema: |
| 439 |
$ref: ../swagger.yaml#/definitions/error |
| 440 |
"503": |
| 441 |
description: Under maintenance |
| 442 |
schema: |
| 443 |
$ref: ../swagger.yaml#/definitions/error |
| 444 |
x-koha-authorization: |
| 445 |
permissions: |
| 446 |
parameters: manage_authentication_providers |
| 447 |
delete: |
| 448 |
x-mojo-to: Auth::Provider::Domains#delete |
| 449 |
operationId: delAuthProviderDomain |
| 450 |
tags: |
| 451 |
- auth_providers |
| 452 |
summary: Delete authentication provider |
| 453 |
parameters: |
| 454 |
- $ref: ../swagger.yaml#/parameters/auth_provider_id_pp |
| 455 |
- $ref: ../swagger.yaml#/parameters/auth_provider_domain_id_pp |
| 456 |
produces: |
| 457 |
- application/json |
| 458 |
responses: |
| 459 |
"204": |
| 460 |
description: Authentication provider deleted |
| 461 |
"401": |
| 462 |
description: Authentication required |
| 463 |
schema: |
| 464 |
$ref: ../swagger.yaml#/definitions/error |
| 465 |
"403": |
| 466 |
description: Access forbidden |
| 467 |
schema: |
| 468 |
$ref: ../swagger.yaml#/definitions/error |
| 469 |
"404": |
| 470 |
description: City not found |
| 471 |
schema: |
| 472 |
$ref: ../swagger.yaml#/definitions/error |
| 473 |
"500": |
| 474 |
description: | |
| 475 |
Internal server error. Possible `error_code` attribute values: |
| 476 |
|
| 477 |
* `internal_server_error` |
| 478 |
"503": |
| 479 |
description: Under maintenance |
| 480 |
schema: |
| 481 |
$ref: ../swagger.yaml#/definitions/error |
| 39 |
x-koha-authorization: |
482 |
x-koha-authorization: |
| 40 |
permissions: |
483 |
permissions: |
| 41 |
catalogue: "1" |
484 |
parameters: manage_authentication_providers |