|
Line 0
Link Here
|
|
|
1 |
--- |
| 2 |
/shibboleth/config: |
| 3 |
get: |
| 4 |
x-mojo-to: ShibbolethConfig#get |
| 5 |
operationId: getShibbolethConfig |
| 6 |
tags: |
| 7 |
- shibboleth |
| 8 |
summary: Get Shibboleth configuration |
| 9 |
produces: |
| 10 |
- application/json |
| 11 |
responses: |
| 12 |
"200": |
| 13 |
description: Shibboleth configuration |
| 14 |
schema: |
| 15 |
$ref: "../swagger.yaml#/definitions/shibboleth_config" |
| 16 |
"400": |
| 17 |
description: | |
| 18 |
Bad request. Possible `error_code` attribute values: |
| 19 |
|
| 20 |
* `invalid_query` |
| 21 |
schema: |
| 22 |
$ref: "../swagger.yaml#/definitions/error" |
| 23 |
"401": |
| 24 |
description: Authentication required |
| 25 |
schema: |
| 26 |
$ref: "../swagger.yaml#/definitions/error" |
| 27 |
"403": |
| 28 |
description: Access forbidden |
| 29 |
schema: |
| 30 |
$ref: "../swagger.yaml#/definitions/error" |
| 31 |
x-koha-authorization: |
| 32 |
permissions: |
| 33 |
parameters: manage_identity_providers |
| 34 |
put: |
| 35 |
x-mojo-to: ShibbolethConfig#update |
| 36 |
operationId: updateShibbolethConfig |
| 37 |
tags: |
| 38 |
- shibboleth |
| 39 |
summary: Update Shibboleth configuration |
| 40 |
parameters: |
| 41 |
- name: body |
| 42 |
in: body |
| 43 |
description: Shibboleth configuration object |
| 44 |
required: true |
| 45 |
schema: |
| 46 |
$ref: "../swagger.yaml#/definitions/shibboleth_config" |
| 47 |
produces: |
| 48 |
- application/json |
| 49 |
responses: |
| 50 |
"200": |
| 51 |
description: Configuration updated |
| 52 |
schema: |
| 53 |
$ref: "../swagger.yaml#/definitions/shibboleth_config" |
| 54 |
"400": |
| 55 |
description: Bad request |
| 56 |
schema: |
| 57 |
$ref: "../swagger.yaml#/definitions/error" |
| 58 |
"401": |
| 59 |
description: Authentication required |
| 60 |
schema: |
| 61 |
$ref: "../swagger.yaml#/definitions/error" |
| 62 |
"403": |
| 63 |
description: Access forbidden |
| 64 |
schema: |
| 65 |
$ref: "../swagger.yaml#/definitions/error" |
| 66 |
x-koha-authorization: |
| 67 |
permissions: |
| 68 |
parameters: manage_identity_providers |
| 69 |
|
| 70 |
/shibboleth/mappings: |
| 71 |
get: |
| 72 |
x-mojo-to: ShibbolethFieldMappings#list |
| 73 |
operationId: listShibbolethMappings |
| 74 |
tags: |
| 75 |
- shibboleth |
| 76 |
summary: List Shibboleth field mappings |
| 77 |
parameters: |
| 78 |
- $ref: "../swagger.yaml#/parameters/match" |
| 79 |
- $ref: "../swagger.yaml#/parameters/order_by" |
| 80 |
- $ref: "../swagger.yaml#/parameters/page" |
| 81 |
- $ref: "../swagger.yaml#/parameters/per_page" |
| 82 |
- $ref: "../swagger.yaml#/parameters/q_param" |
| 83 |
- $ref: "../swagger.yaml#/parameters/q_body" |
| 84 |
produces: |
| 85 |
- application/json |
| 86 |
responses: |
| 87 |
"200": |
| 88 |
description: List of field mappings |
| 89 |
schema: |
| 90 |
type: array |
| 91 |
items: |
| 92 |
$ref: "../swagger.yaml#/definitions/shibboleth_mapping" |
| 93 |
"400": |
| 94 |
description: | |
| 95 |
Bad request. Possible `error_code` attribute values: |
| 96 |
|
| 97 |
* `invalid_query` |
| 98 |
schema: |
| 99 |
$ref: "../swagger.yaml#/definitions/error" |
| 100 |
x-koha-authorization: |
| 101 |
permissions: |
| 102 |
parameters: manage_identity_providers |
| 103 |
post: |
| 104 |
x-mojo-to: ShibbolethFieldMappings#add |
| 105 |
operationId: addShibbolethMapping |
| 106 |
tags: |
| 107 |
- shibboleth |
| 108 |
summary: Add new field mapping |
| 109 |
parameters: |
| 110 |
- name: body |
| 111 |
in: body |
| 112 |
description: Field mapping object |
| 113 |
required: true |
| 114 |
schema: |
| 115 |
$ref: "../swagger.yaml#/definitions/shibboleth_mapping" |
| 116 |
produces: |
| 117 |
- application/json |
| 118 |
responses: |
| 119 |
"201": |
| 120 |
description: Mapping created |
| 121 |
schema: |
| 122 |
$ref: "../swagger.yaml#/definitions/shibboleth_mapping" |
| 123 |
"400": |
| 124 |
description: Bad request |
| 125 |
schema: |
| 126 |
$ref: "../swagger.yaml#/definitions/error" |
| 127 |
"401": |
| 128 |
description: Authentication required |
| 129 |
schema: |
| 130 |
$ref: "../swagger.yaml#/definitions/error" |
| 131 |
"403": |
| 132 |
description: Access forbidden |
| 133 |
schema: |
| 134 |
$ref: "../swagger.yaml#/definitions/error" |
| 135 |
x-koha-authorization: |
| 136 |
permissions: |
| 137 |
parameters: manage_identity_providers |
| 138 |
|
| 139 |
"/shibboleth/mappings/{mapping_id}": |
| 140 |
get: |
| 141 |
x-mojo-to: ShibbolethFieldMappings#get |
| 142 |
operationId: getShibbolethMapping |
| 143 |
tags: |
| 144 |
- shibboleth |
| 145 |
summary: Get field mapping |
| 146 |
parameters: |
| 147 |
- $ref: "../swagger.yaml#/parameters/mapping_id_pp" |
| 148 |
produces: |
| 149 |
- application/json |
| 150 |
responses: |
| 151 |
"200": |
| 152 |
description: Field mapping |
| 153 |
schema: |
| 154 |
$ref: "../swagger.yaml#/definitions/shibboleth_mapping" |
| 155 |
"400": |
| 156 |
description: Bad request |
| 157 |
schema: |
| 158 |
$ref: "../swagger.yaml#/definitions/error" |
| 159 |
"404": |
| 160 |
description: Mapping not found |
| 161 |
schema: |
| 162 |
$ref: "../swagger.yaml#/definitions/error" |
| 163 |
x-koha-authorization: |
| 164 |
permissions: |
| 165 |
parameters: manage_identity_providers |
| 166 |
put: |
| 167 |
x-mojo-to: ShibbolethFieldMappings#update |
| 168 |
operationId: updateShibbolethMapping |
| 169 |
tags: |
| 170 |
- shibboleth |
| 171 |
summary: Update field mapping |
| 172 |
parameters: |
| 173 |
- $ref: "../swagger.yaml#/parameters/mapping_id_pp" |
| 174 |
- name: body |
| 175 |
in: body |
| 176 |
description: Updated mapping object |
| 177 |
required: true |
| 178 |
schema: |
| 179 |
$ref: "../swagger.yaml#/definitions/shibboleth_mapping" |
| 180 |
produces: |
| 181 |
- application/json |
| 182 |
responses: |
| 183 |
"200": |
| 184 |
description: Mapping updated |
| 185 |
schema: |
| 186 |
$ref: "../swagger.yaml#/definitions/shibboleth_mapping" |
| 187 |
"400": |
| 188 |
description: Bad request |
| 189 |
schema: |
| 190 |
$ref: "../swagger.yaml#/definitions/error" |
| 191 |
"404": |
| 192 |
description: Mapping not found |
| 193 |
schema: |
| 194 |
$ref: "../swagger.yaml#/definitions/error" |
| 195 |
x-koha-authorization: |
| 196 |
permissions: |
| 197 |
parameters: manage_identity_providers |
| 198 |
delete: |
| 199 |
x-mojo-to: ShibbolethFieldMappings#delete |
| 200 |
operationId: deleteShibbolethMapping |
| 201 |
tags: |
| 202 |
- shibboleth |
| 203 |
summary: Delete field mapping |
| 204 |
parameters: |
| 205 |
- $ref: "../swagger.yaml#/parameters/mapping_id_pp" |
| 206 |
produces: |
| 207 |
- application/json |
| 208 |
responses: |
| 209 |
"204": |
| 210 |
description: Mapping deleted |
| 211 |
"400": |
| 212 |
description: Bad request |
| 213 |
schema: |
| 214 |
$ref: "../swagger.yaml#/definitions/error" |
| 215 |
"404": |
| 216 |
description: Mapping not found |
| 217 |
schema: |
| 218 |
$ref: "../swagger.yaml#/definitions/error" |
| 219 |
x-koha-authorization: |
| 220 |
permissions: |
| 221 |
parameters: manage_identity_providers |