|
Lines 616-621
Link Here
|
| 616 |
type: string |
616 |
type: string |
| 617 |
enum: |
617 |
enum: |
| 618 |
- domains |
618 |
- domains |
|
|
619 |
- hostnames |
| 620 |
- mappings |
| 619 |
collectionFormat: csv |
621 |
collectionFormat: csv |
| 620 |
produces: |
622 |
produces: |
| 621 |
- application/json |
623 |
- application/json |
|
Lines 731-736
Link Here
|
| 731 |
type: string |
733 |
type: string |
| 732 |
enum: |
734 |
enum: |
| 733 |
- domains |
735 |
- domains |
|
|
736 |
- hostnames |
| 737 |
- mappings |
| 734 |
collectionFormat: csv |
738 |
collectionFormat: csv |
| 735 |
produces: |
739 |
produces: |
| 736 |
- application/json |
740 |
- application/json |
|
Lines 1104-1109
Link Here
|
| 1104 |
x-koha-authorization: |
1108 |
x-koha-authorization: |
| 1105 |
permissions: |
1109 |
permissions: |
| 1106 |
parameters: manage_identity_providers |
1110 |
parameters: manage_identity_providers |
|
|
1111 |
"/auth/identity_providers/{identity_provider_id}/mappings": |
| 1112 |
get: |
| 1113 |
x-mojo-to: Auth::Identity::Provider::Mappings#list |
| 1114 |
operationId: listIdentityProviderMappings |
| 1115 |
tags: |
| 1116 |
- identity_providers |
| 1117 |
summary: List field mappings for an identity provider |
| 1118 |
parameters: |
| 1119 |
- $ref: ../swagger.yaml#/parameters/identity_provider_id_pp |
| 1120 |
- $ref: ../swagger.yaml#/parameters/match |
| 1121 |
- $ref: ../swagger.yaml#/parameters/order_by |
| 1122 |
- $ref: ../swagger.yaml#/parameters/page |
| 1123 |
- $ref: ../swagger.yaml#/parameters/per_page |
| 1124 |
- $ref: ../swagger.yaml#/parameters/q_param |
| 1125 |
- $ref: ../swagger.yaml#/parameters/q_body |
| 1126 |
- $ref: ../swagger.yaml#/parameters/request_id_header |
| 1127 |
produces: |
| 1128 |
- application/json |
| 1129 |
responses: |
| 1130 |
"200": |
| 1131 |
description: List of field mappings |
| 1132 |
schema: |
| 1133 |
type: array |
| 1134 |
items: |
| 1135 |
$ref: ../swagger.yaml#/definitions/identity_provider_mapping |
| 1136 |
"400": |
| 1137 |
description: | |
| 1138 |
Bad request. Possible `error_code` attribute values: |
| 1139 |
|
| 1140 |
* `invalid_query` |
| 1141 |
schema: |
| 1142 |
$ref: ../swagger.yaml#/definitions/error |
| 1143 |
"403": |
| 1144 |
description: Access forbidden |
| 1145 |
schema: |
| 1146 |
$ref: ../swagger.yaml#/definitions/error |
| 1147 |
"404": |
| 1148 |
description: Identity provider not found |
| 1149 |
schema: |
| 1150 |
$ref: ../swagger.yaml#/definitions/error |
| 1151 |
x-koha-authorization: |
| 1152 |
permissions: |
| 1153 |
parameters: manage_identity_providers |
| 1154 |
post: |
| 1155 |
x-mojo-to: Auth::Identity::Provider::Mappings#add |
| 1156 |
operationId: addIdentityProviderMapping |
| 1157 |
tags: |
| 1158 |
- identity_providers |
| 1159 |
summary: Add a field mapping to an identity provider |
| 1160 |
parameters: |
| 1161 |
- $ref: ../swagger.yaml#/parameters/identity_provider_id_pp |
| 1162 |
- name: body |
| 1163 |
in: body |
| 1164 |
description: A field mapping object |
| 1165 |
required: true |
| 1166 |
schema: |
| 1167 |
$ref: ../swagger.yaml#/definitions/identity_provider_mapping |
| 1168 |
produces: |
| 1169 |
- application/json |
| 1170 |
responses: |
| 1171 |
"201": |
| 1172 |
description: The created field mapping |
| 1173 |
schema: |
| 1174 |
$ref: ../swagger.yaml#/definitions/identity_provider_mapping |
| 1175 |
"400": |
| 1176 |
description: Bad request |
| 1177 |
schema: |
| 1178 |
$ref: ../swagger.yaml#/definitions/error |
| 1179 |
"403": |
| 1180 |
description: Access forbidden |
| 1181 |
schema: |
| 1182 |
$ref: ../swagger.yaml#/definitions/error |
| 1183 |
"404": |
| 1184 |
description: Identity provider not found |
| 1185 |
schema: |
| 1186 |
$ref: ../swagger.yaml#/definitions/error |
| 1187 |
x-koha-authorization: |
| 1188 |
permissions: |
| 1189 |
parameters: manage_identity_providers |
| 1190 |
"/auth/identity_providers/{identity_provider_id}/mappings/{identity_provider_mapping_id}": |
| 1191 |
get: |
| 1192 |
x-mojo-to: Auth::Identity::Provider::Mappings#get |
| 1193 |
operationId: getIdentityProviderMapping |
| 1194 |
tags: |
| 1195 |
- identity_providers |
| 1196 |
summary: Get a field mapping |
| 1197 |
parameters: |
| 1198 |
- $ref: ../swagger.yaml#/parameters/identity_provider_id_pp |
| 1199 |
- $ref: ../swagger.yaml#/parameters/identity_provider_mapping_id_pp |
| 1200 |
produces: |
| 1201 |
- application/json |
| 1202 |
responses: |
| 1203 |
"200": |
| 1204 |
description: A field mapping |
| 1205 |
schema: |
| 1206 |
$ref: ../swagger.yaml#/definitions/identity_provider_mapping |
| 1207 |
"400": |
| 1208 |
description: Bad request |
| 1209 |
schema: |
| 1210 |
$ref: ../swagger.yaml#/definitions/error |
| 1211 |
"403": |
| 1212 |
description: Access forbidden |
| 1213 |
schema: |
| 1214 |
$ref: ../swagger.yaml#/definitions/error |
| 1215 |
"404": |
| 1216 |
description: Mapping not found |
| 1217 |
schema: |
| 1218 |
$ref: ../swagger.yaml#/definitions/error |
| 1219 |
x-koha-authorization: |
| 1220 |
permissions: |
| 1221 |
parameters: manage_identity_providers |
| 1222 |
put: |
| 1223 |
x-mojo-to: Auth::Identity::Provider::Mappings#update |
| 1224 |
operationId: updateIdentityProviderMapping |
| 1225 |
tags: |
| 1226 |
- identity_providers |
| 1227 |
summary: Update a field mapping |
| 1228 |
parameters: |
| 1229 |
- $ref: ../swagger.yaml#/parameters/identity_provider_id_pp |
| 1230 |
- $ref: ../swagger.yaml#/parameters/identity_provider_mapping_id_pp |
| 1231 |
- name: body |
| 1232 |
in: body |
| 1233 |
description: Updated mapping object |
| 1234 |
required: true |
| 1235 |
schema: |
| 1236 |
$ref: ../swagger.yaml#/definitions/identity_provider_mapping |
| 1237 |
produces: |
| 1238 |
- application/json |
| 1239 |
responses: |
| 1240 |
"200": |
| 1241 |
description: Updated field mapping |
| 1242 |
schema: |
| 1243 |
$ref: ../swagger.yaml#/definitions/identity_provider_mapping |
| 1244 |
"400": |
| 1245 |
description: Bad request |
| 1246 |
schema: |
| 1247 |
$ref: ../swagger.yaml#/definitions/error |
| 1248 |
"403": |
| 1249 |
description: Access forbidden |
| 1250 |
schema: |
| 1251 |
$ref: ../swagger.yaml#/definitions/error |
| 1252 |
"404": |
| 1253 |
description: Mapping not found |
| 1254 |
schema: |
| 1255 |
$ref: ../swagger.yaml#/definitions/error |
| 1256 |
x-koha-authorization: |
| 1257 |
permissions: |
| 1258 |
parameters: manage_identity_providers |
| 1259 |
delete: |
| 1260 |
x-mojo-to: Auth::Identity::Provider::Mappings#delete |
| 1261 |
operationId: delIdentityProviderMapping |
| 1262 |
tags: |
| 1263 |
- identity_providers |
| 1264 |
summary: Delete a field mapping |
| 1265 |
parameters: |
| 1266 |
- $ref: ../swagger.yaml#/parameters/identity_provider_id_pp |
| 1267 |
- $ref: ../swagger.yaml#/parameters/identity_provider_mapping_id_pp |
| 1268 |
produces: |
| 1269 |
- application/json |
| 1270 |
responses: |
| 1271 |
"204": |
| 1272 |
description: Field mapping deleted |
| 1273 |
"400": |
| 1274 |
description: Bad request |
| 1275 |
schema: |
| 1276 |
$ref: ../swagger.yaml#/definitions/error |
| 1277 |
"403": |
| 1278 |
description: Access forbidden |
| 1279 |
schema: |
| 1280 |
$ref: ../swagger.yaml#/definitions/error |
| 1281 |
"404": |
| 1282 |
description: Mapping not found |
| 1283 |
schema: |
| 1284 |
$ref: ../swagger.yaml#/definitions/error |
| 1285 |
x-koha-authorization: |
| 1286 |
permissions: |
| 1287 |
parameters: manage_identity_providers |
| 1107 |
"/auth/password/validation": |
1288 |
"/auth/password/validation": |
| 1108 |
post: |
1289 |
post: |
| 1109 |
x-mojo-to: Auth::Password#validate |
1290 |
x-mojo-to: Auth::Password#validate |
|
Lines 1184-1186
Link Here
|
| 1184 |
x-koha-authorization: |
1365 |
x-koha-authorization: |
| 1185 |
permissions: |
1366 |
permissions: |
| 1186 |
borrowers: api_validate_password |
1367 |
borrowers: api_validate_password |
|
|
1368 |
"/auth/identity_providers/{identity_provider_id}/hostnames": |
| 1369 |
get: |
| 1370 |
x-mojo-to: Auth::Identity::Provider::Hostnames#list |
| 1371 |
operationId: listIdentityProviderHostnames |
| 1372 |
tags: |
| 1373 |
- identity_providers |
| 1374 |
summary: List identity provider hostnames |
| 1375 |
parameters: |
| 1376 |
- $ref: ../swagger.yaml#/parameters/identity_provider_id_pp |
| 1377 |
- $ref: ../swagger.yaml#/parameters/match |
| 1378 |
- $ref: ../swagger.yaml#/parameters/order_by |
| 1379 |
- $ref: ../swagger.yaml#/parameters/page |
| 1380 |
- $ref: ../swagger.yaml#/parameters/per_page |
| 1381 |
- $ref: ../swagger.yaml#/parameters/q_param |
| 1382 |
- $ref: ../swagger.yaml#/parameters/q_body |
| 1383 |
- $ref: ../swagger.yaml#/parameters/request_id_header |
| 1384 |
produces: |
| 1385 |
- application/json |
| 1386 |
responses: |
| 1387 |
"200": |
| 1388 |
description: A list of identity provider hostnames |
| 1389 |
schema: |
| 1390 |
type: array |
| 1391 |
items: |
| 1392 |
$ref: ../swagger.yaml#/definitions/identity_provider_hostname |
| 1393 |
"400": |
| 1394 |
description: | |
| 1395 |
Bad request. Possible `error_code` attribute values: |
| 1396 |
|
| 1397 |
* `invalid_query` |
| 1398 |
schema: |
| 1399 |
$ref: "../swagger.yaml#/definitions/error" |
| 1400 |
"404": |
| 1401 |
description: Object not found |
| 1402 |
schema: |
| 1403 |
$ref: ../swagger.yaml#/definitions/error |
| 1404 |
"500": |
| 1405 |
description: | |
| 1406 |
Internal server error. Possible `error_code` attribute values: |
| 1407 |
|
| 1408 |
* `internal_server_error` |
| 1409 |
schema: |
| 1410 |
$ref: ../swagger.yaml#/definitions/error |
| 1411 |
"503": |
| 1412 |
description: Under maintenance |
| 1413 |
schema: |
| 1414 |
$ref: ../swagger.yaml#/definitions/error |
| 1415 |
x-koha-authorization: |
| 1416 |
permissions: |
| 1417 |
parameters: manage_identity_providers |
| 1418 |
post: |
| 1419 |
x-mojo-to: Auth::Identity::Provider::Hostnames#add |
| 1420 |
operationId: addIdentityProviderHostname |
| 1421 |
tags: |
| 1422 |
- identity_providers |
| 1423 |
summary: Add an identity provider hostname |
| 1424 |
parameters: |
| 1425 |
- $ref: ../swagger.yaml#/parameters/identity_provider_id_pp |
| 1426 |
- name: body |
| 1427 |
in: body |
| 1428 |
description: An identity provider hostname object |
| 1429 |
required: true |
| 1430 |
schema: |
| 1431 |
$ref: ../swagger.yaml#/definitions/identity_provider_hostname |
| 1432 |
produces: |
| 1433 |
- application/json |
| 1434 |
responses: |
| 1435 |
"201": |
| 1436 |
description: Created identity provider hostname |
| 1437 |
schema: |
| 1438 |
$ref: ../swagger.yaml#/definitions/identity_provider_hostname |
| 1439 |
"400": |
| 1440 |
description: Bad request |
| 1441 |
schema: |
| 1442 |
$ref: ../swagger.yaml#/definitions/error |
| 1443 |
"403": |
| 1444 |
description: Access forbidden |
| 1445 |
schema: |
| 1446 |
$ref: ../swagger.yaml#/definitions/error |
| 1447 |
"404": |
| 1448 |
description: Identity provider not found |
| 1449 |
schema: |
| 1450 |
$ref: ../swagger.yaml#/definitions/error |
| 1451 |
"409": |
| 1452 |
description: Conflict - hostname already exists |
| 1453 |
schema: |
| 1454 |
$ref: ../swagger.yaml#/definitions/error |
| 1455 |
"500": |
| 1456 |
description: | |
| 1457 |
Internal server error. Possible `error_code` attribute values: |
| 1458 |
|
| 1459 |
* `internal_server_error` |
| 1460 |
schema: |
| 1461 |
$ref: ../swagger.yaml#/definitions/error |
| 1462 |
"503": |
| 1463 |
description: Under maintenance |
| 1464 |
schema: |
| 1465 |
$ref: ../swagger.yaml#/definitions/error |
| 1466 |
x-koha-authorization: |
| 1467 |
permissions: |
| 1468 |
parameters: manage_identity_providers |
| 1469 |
"/auth/identity_providers/{identity_provider_id}/hostnames/{identity_provider_hostname_id}": |
| 1470 |
get: |
| 1471 |
x-mojo-to: Auth::Identity::Provider::Hostnames#get |
| 1472 |
operationId: getIdentityProviderHostname |
| 1473 |
tags: |
| 1474 |
- identity_providers |
| 1475 |
summary: Get an identity provider hostname |
| 1476 |
parameters: |
| 1477 |
- $ref: ../swagger.yaml#/parameters/identity_provider_id_pp |
| 1478 |
- $ref: ../swagger.yaml#/parameters/identity_provider_hostname_id_pp |
| 1479 |
produces: |
| 1480 |
- application/json |
| 1481 |
responses: |
| 1482 |
"200": |
| 1483 |
description: An identity provider hostname |
| 1484 |
schema: |
| 1485 |
$ref: ../swagger.yaml#/definitions/identity_provider_hostname |
| 1486 |
"400": |
| 1487 |
description: Bad request |
| 1488 |
schema: |
| 1489 |
$ref: "../swagger.yaml#/definitions/error" |
| 1490 |
"404": |
| 1491 |
description: Object not found |
| 1492 |
schema: |
| 1493 |
$ref: ../swagger.yaml#/definitions/error |
| 1494 |
"500": |
| 1495 |
description: | |
| 1496 |
Internal server error. Possible `error_code` attribute values: |
| 1497 |
|
| 1498 |
* `internal_server_error` |
| 1499 |
schema: |
| 1500 |
$ref: ../swagger.yaml#/definitions/error |
| 1501 |
"503": |
| 1502 |
description: Under maintenance |
| 1503 |
schema: |
| 1504 |
$ref: ../swagger.yaml#/definitions/error |
| 1505 |
x-koha-authorization: |
| 1506 |
permissions: |
| 1507 |
parameters: manage_identity_providers |
| 1508 |
put: |
| 1509 |
x-mojo-to: Auth::Identity::Provider::Hostnames#update |
| 1510 |
operationId: updateIdentityProviderHostname |
| 1511 |
tags: |
| 1512 |
- identity_providers |
| 1513 |
summary: Update an identity provider hostname |
| 1514 |
parameters: |
| 1515 |
- $ref: ../swagger.yaml#/parameters/identity_provider_id_pp |
| 1516 |
- $ref: ../swagger.yaml#/parameters/identity_provider_hostname_id_pp |
| 1517 |
- name: body |
| 1518 |
in: body |
| 1519 |
description: An identity provider hostname object |
| 1520 |
required: true |
| 1521 |
schema: |
| 1522 |
$ref: ../swagger.yaml#/definitions/identity_provider_hostname |
| 1523 |
produces: |
| 1524 |
- application/json |
| 1525 |
responses: |
| 1526 |
"200": |
| 1527 |
description: Updated identity provider hostname |
| 1528 |
schema: |
| 1529 |
$ref: ../swagger.yaml#/definitions/identity_provider_hostname |
| 1530 |
"400": |
| 1531 |
description: Bad request |
| 1532 |
schema: |
| 1533 |
$ref: ../swagger.yaml#/definitions/error |
| 1534 |
"403": |
| 1535 |
description: Access forbidden |
| 1536 |
schema: |
| 1537 |
$ref: ../swagger.yaml#/definitions/error |
| 1538 |
"404": |
| 1539 |
description: Object not found |
| 1540 |
schema: |
| 1541 |
$ref: ../swagger.yaml#/definitions/error |
| 1542 |
"409": |
| 1543 |
description: Conflict - hostname already exists |
| 1544 |
schema: |
| 1545 |
$ref: ../swagger.yaml#/definitions/error |
| 1546 |
"500": |
| 1547 |
description: | |
| 1548 |
Internal server error. Possible `error_code` attribute values: |
| 1549 |
|
| 1550 |
* `internal_server_error` |
| 1551 |
schema: |
| 1552 |
$ref: ../swagger.yaml#/definitions/error |
| 1553 |
"503": |
| 1554 |
description: Under maintenance |
| 1555 |
schema: |
| 1556 |
$ref: ../swagger.yaml#/definitions/error |
| 1557 |
x-koha-authorization: |
| 1558 |
permissions: |
| 1559 |
parameters: manage_identity_providers |
| 1560 |
delete: |
| 1561 |
x-mojo-to: Auth::Identity::Provider::Hostnames#delete |
| 1562 |
operationId: deleteIdentityProviderHostname |
| 1563 |
tags: |
| 1564 |
- identity_providers |
| 1565 |
summary: Delete an identity provider hostname |
| 1566 |
parameters: |
| 1567 |
- $ref: ../swagger.yaml#/parameters/identity_provider_id_pp |
| 1568 |
- $ref: ../swagger.yaml#/parameters/identity_provider_hostname_id_pp |
| 1569 |
produces: |
| 1570 |
- application/json |
| 1571 |
responses: |
| 1572 |
"204": |
| 1573 |
description: Identity provider hostname deleted |
| 1574 |
"400": |
| 1575 |
description: Bad request |
| 1576 |
schema: |
| 1577 |
$ref: "../swagger.yaml#/definitions/error" |
| 1578 |
"401": |
| 1579 |
description: Authentication required |
| 1580 |
schema: |
| 1581 |
$ref: ../swagger.yaml#/definitions/error |
| 1582 |
"403": |
| 1583 |
description: Access forbidden |
| 1584 |
schema: |
| 1585 |
$ref: ../swagger.yaml#/definitions/error |
| 1586 |
"404": |
| 1587 |
description: Object not found |
| 1588 |
schema: |
| 1589 |
$ref: ../swagger.yaml#/definitions/error |
| 1590 |
"500": |
| 1591 |
description: | |
| 1592 |
Internal server error. Possible `error_code` attribute values: |
| 1593 |
|
| 1594 |
* `internal_server_error` |
| 1595 |
schema: |
| 1596 |
$ref: ../swagger.yaml#/definitions/error |
| 1597 |
"503": |
| 1598 |
description: Under maintenance |
| 1599 |
schema: |
| 1600 |
$ref: ../swagger.yaml#/definitions/error |
| 1601 |
x-koha-authorization: |
| 1602 |
permissions: |
| 1603 |
parameters: manage_identity_providers |
| 1604 |
/auth/hostnames: |
| 1605 |
get: |
| 1606 |
x-mojo-to: Auth::Hostnames#list |
| 1607 |
operationId: listHostnames |
| 1608 |
tags: |
| 1609 |
- identity_providers |
| 1610 |
summary: List all known hostnames |
| 1611 |
parameters: |
| 1612 |
- $ref: ../swagger.yaml#/parameters/match |
| 1613 |
- $ref: ../swagger.yaml#/parameters/order_by |
| 1614 |
- $ref: ../swagger.yaml#/parameters/page |
| 1615 |
- $ref: ../swagger.yaml#/parameters/per_page |
| 1616 |
- $ref: ../swagger.yaml#/parameters/q_param |
| 1617 |
- $ref: ../swagger.yaml#/parameters/q_body |
| 1618 |
- $ref: ../swagger.yaml#/parameters/request_id_header |
| 1619 |
produces: |
| 1620 |
- application/json |
| 1621 |
responses: |
| 1622 |
"200": |
| 1623 |
description: A list of hostnames |
| 1624 |
schema: |
| 1625 |
type: array |
| 1626 |
items: |
| 1627 |
$ref: ../swagger.yaml#/definitions/hostname |
| 1628 |
"400": |
| 1629 |
description: | |
| 1630 |
Bad request. Possible `error_code` attribute values: |
| 1631 |
|
| 1632 |
* `invalid_query` |
| 1633 |
schema: |
| 1634 |
$ref: "../swagger.yaml#/definitions/error" |
| 1635 |
"500": |
| 1636 |
description: | |
| 1637 |
Internal server error. Possible `error_code` attribute values: |
| 1638 |
|
| 1639 |
* `internal_server_error` |
| 1640 |
schema: |
| 1641 |
$ref: ../swagger.yaml#/definitions/error |
| 1642 |
"503": |
| 1643 |
description: Under maintenance |
| 1644 |
schema: |
| 1645 |
$ref: ../swagger.yaml#/definitions/error |
| 1646 |
x-koha-authorization: |
| 1647 |
permissions: |
| 1648 |
parameters: manage_identity_providers |
| 1649 |
"/auth/hostnames/{hostname_id}": |
| 1650 |
get: |
| 1651 |
x-mojo-to: Auth::Hostnames#get |
| 1652 |
operationId: getHostname |
| 1653 |
tags: |
| 1654 |
- identity_providers |
| 1655 |
summary: Get a hostname |
| 1656 |
parameters: |
| 1657 |
- $ref: ../swagger.yaml#/parameters/hostname_id_pp |
| 1658 |
produces: |
| 1659 |
- application/json |
| 1660 |
responses: |
| 1661 |
"200": |
| 1662 |
description: A hostname |
| 1663 |
schema: |
| 1664 |
$ref: ../swagger.yaml#/definitions/hostname |
| 1665 |
"400": |
| 1666 |
description: Bad request |
| 1667 |
schema: |
| 1668 |
$ref: "../swagger.yaml#/definitions/error" |
| 1669 |
"404": |
| 1670 |
description: Object not found |
| 1671 |
schema: |
| 1672 |
$ref: ../swagger.yaml#/definitions/error |
| 1673 |
"500": |
| 1674 |
description: | |
| 1675 |
Internal server error. Possible `error_code` attribute values: |
| 1676 |
|
| 1677 |
* `internal_server_error` |
| 1678 |
schema: |
| 1679 |
$ref: ../swagger.yaml#/definitions/error |
| 1680 |
"503": |
| 1681 |
description: Under maintenance |
| 1682 |
schema: |
| 1683 |
$ref: ../swagger.yaml#/definitions/error |
| 1684 |
x-koha-authorization: |
| 1685 |
permissions: |
| 1686 |
parameters: manage_identity_providers |