Mercurial > hg > orthanc-book
comparison Sphinx/source/plugins/authorization.rst @ 893:8b48d42665c4
auth 0.4.0
author | Alain Mazy <am@osimis.io> |
---|---|
date | Thu, 10 Nov 2022 11:31:36 +0100 |
parents | 2e3493d618ad |
children | 1d9e0aa08fdd |
comparison
equal
deleted
inserted
replaced
892:3982b4a4bdbc | 893:8b48d42665c4 |
---|---|
283 "WebServiceUsername": "my-user", // new in v 0.3.0 | 283 "WebServiceUsername": "my-user", // new in v 0.3.0 |
284 "WebServicePassword": "my-password", // new in v 0.3.0 | 284 "WebServicePassword": "my-password", // new in v 0.3.0 |
285 "WebServiceIdentifier": "my-id", // new in v 0.3.0 | 285 "WebServiceIdentifier": "my-id", // new in v 0.3.0 |
286 "TokenGetArguments" : [ "user" ], | 286 "TokenGetArguments" : [ "user" ], |
287 "TokenHttpHeaders" : [ "hello" ], | 287 "TokenHttpHeaders" : [ "hello" ], |
288 "StandardConfigurations": [ // new in v 0.4.0 | |
289 "osimis-web-viewer", | |
290 "stone-webviewer" | |
291 ], | |
288 "UncheckedResources" : [ | 292 "UncheckedResources" : [ |
289 "/series", | 293 "/series", |
290 "/instances", | 294 "/instances", |
291 "/patients", | 295 "/patients", |
292 "/studies", | 296 "/studies", |
297 "/app/", | 301 "/app/", |
298 "/web-viewer/app/", | 302 "/web-viewer/app/", |
299 "/web-viewer/libs/", | 303 "/web-viewer/libs/", |
300 "/wsi/app/" | 304 "/wsi/app/" |
301 ], | 305 ], |
302 "UncheckedLevels" : [ "study" ] | 306 "CheckedLevel" : "studies", // new in v 0.4.0 |
307 "UncheckedLevels" : [ | |
308 "patients", | |
309 "series", | |
310 "instances" | |
311 ] | |
303 } | 312 } |
304 } | 313 } |
305 | 314 |
306 The following options have been described above: ``WebService``, | 315 The following options have been described above: ``WebService``, |
307 ``TokenGetArguments``, and ``TokenHttpHeaders``. Here are the | 316 ``TokenGetArguments``, and ``TokenHttpHeaders``. Here are the |
308 remaining options: | 317 remaining options: |
318 | |
319 * ``StandardConfigurations`` is a helper configuration to pre-populate | |
320 ``UncheckedResources``, ``UncheckedFolders``, ``TokenGetArguments``, | |
321 and ``TokenHttpHeaders`` of well-known plugins. | |
322 Allowed values are ``osimis-web-viewer``, ``stone-webviewer``. | |
323 | |
324 * ``CheckedLevel`` may replace ``UncheckedLevels`` when authorization | |
325 is checked only at one level of the DICOM hierarchy. This is the most | |
326 common use-case. | |
309 | 327 |
310 * ``UncheckedResources`` specifies a list of resources for which the | 328 * ``UncheckedResources`` specifies a list of resources for which the |
311 authentication plugin is not triggered, and to which access is | 329 authentication plugin is not triggered, and to which access is |
312 always granted. | 330 always granted. |
313 | 331 |
320 service. Think for instance about an authorization mechanism that | 338 service. Think for instance about an authorization mechanism that |
321 simply associates its studies to a set of granted users: In this case, | 339 simply associates its studies to a set of granted users: In this case, |
322 the series and instance levels can be ignored. | 340 the series and instance levels can be ignored. |
323 | 341 |
324 | 342 |
343 Here is a minimal configuration for the :ref:`Stone Web viewer <stone_webviewer>`:: | |
344 | |
345 { | |
346 // disable basic authentication since it is replaced by the authorization plugin | |
347 "AuthenticationEnabled": false, | |
348 | |
349 "Authorization" : { | |
350 "WebService" : "http://localhost:8000/shares/validate", | |
351 "StandardConfigurations": [ | |
352 "stone-webviewer" | |
353 ], | |
354 "CheckedLevel" : "studies" | |
355 } | |
356 } | |
357 | |
358 | |
325 .. _orthanc-explorer-authorization: | 359 .. _orthanc-explorer-authorization: |
326 | 360 |
327 Integration with the Orthanc Explorer | 361 Integration with the Orthanc Explorer |
328 ------------------------------------- | 362 ------------------------------------- |
329 | 363 |