Mercurial > hg > orthanc-authorization
annotate Plugin/DefaultConfiguration.json @ 72:e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Fri, 24 Feb 2023 18:13:36 +0100 |
| parents | 30fb3ce960d9 |
| children | 512247750f0a |
| rev | line source |
|---|---|
| 71 | 1 { |
| 2 "Authorization" : { | |
|
72
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
3 // The Base URL of the auth webservice. This is an alias for all 3 next configurations: |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
4 // // "WebServiceUserProfileUrl" : " ROOT /user/get-profile", |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
5 // // "WebServiceTokenValidationUrl" : " ROOT /tokens/validate", |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
6 // // "WebServiceTokenCreationBaseUrl" : " ROOT /tokens/", |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
7 // "WebServiceRootUrl" : "http://change-me:8000/", |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
8 |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
9 // The URL of the auth webservice route implementing user profile (optional) |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
10 // (this configuration was previously named "WebService" and its old name is still accepted |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
11 // for backward compatibility) |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
12 // "WebServiceUserProfileUrl" : "http://change-me:8000/user/profile", |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
13 |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
14 // The URL of the auth webservice route implementing resource level authorization (optional) |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
15 // "WebServiceTokenValidationUrl" : "http://change-me:8000/tokens/validate", |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
16 |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
17 // The Base URL of the auth webservice route to create tokens (optional) |
|
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
18 // "WebServiceTokenCreationBaseUrl" : "http://change-me:8000/tokens/", |
| 71 | 19 |
| 20 // The username and password to connect to the webservice (optional) | |
| 21 //"WebServiceUsername": "change-me", | |
| 22 //"WebServicePassword": "change-me", | |
| 23 | |
| 24 // An identifier added to the payload of each request to the auth webservice (optional) | |
| 25 //"WebServiceIdentifier": "change-me" | |
| 26 | |
| 27 // The name of the HTTP headers that may contain auth tokens | |
| 28 //"TokenHttpHeaders" : [], | |
| 29 | |
| 30 // the name of the GET arguments that may contain auth tokens | |
| 31 //"TokenGetArguments" : [], | |
| 32 | |
| 33 // A list of predefined configurations for well-known plugins | |
| 34 // "StandardConfigurations": [ // new in v 0.4.0 | |
| 35 // "osimis-web-viewer", | |
| 36 // "stone-webviewer", | |
| 37 // "orthanc-explorer-2" | |
| 38 // ], | |
| 39 | |
| 40 //"UncheckedResources" : [], | |
| 41 //"UncheckedFolders" : [], | |
| 42 //"CheckedLevel" : "studies", | |
| 43 //"UncheckedLevels" : [], | |
| 44 | |
| 45 // Definition of required "user-permissions". This can be fully customized. | |
|
72
e381ba725669
new PUT auth/tokens/{token-type} API route + updated interface with WebService
Alain Mazy <am@osimis.io>
parents:
71
diff
changeset
|
46 // You may define other permissions yourself as long as they match the permissions |
| 71 | 47 // provided in the user-profile route implemented by the auth-service. |
| 48 // You may test your regex in https://regex101.com/ by selecting .NET (C#) and removing the leading ^ and trailing $ | |
| 49 // The default configuration is suitable for Orthanc-Explorer-2 (see TBD sample) | |
| 50 "Permissions" : [ | |
| 51 // elemental browsing in OE2 | |
| 52 ["post", "^/tools/find$", "all|view"], | |
| 53 ["get" , "^/(patients|studies|series|instances)/([a-f0-9-]+)/(studies|series|instances)$", "all|view"], | |
| 54 ["get" , "^/instances/([a-f0-9-]+)/(tags|header)$", "all|view"], | |
| 55 ["get" , "^/statistics$", "all|view"], | |
| 56 | |
| 57 // monitor jobs you have created | |
| 58 ["get" , "^/jobs/([a-f0-9-]+)$", "all|send|modify|anonymize|q-r-remote-modalities"], | |
| 59 | |
| 60 // downloads: not functional yet, we need one-time-tokens | |
| 61 ["get" , "^/(patients|studies|series|instances)/([a-f0-9-]+)/archive$", "all|download"], | |
| 62 ["get" , "^/(patients|studies|series|instances)/([a-f0-9-]+)/media$", "all|download"], | |
| 63 | |
| 64 // interacting with peers/modalities/dicomweb | |
| 65 ["post", "^/(peers|modalities)/(.*)/store$", "all|send"], | |
| 66 ["get" , "^/(peers|modalities)$", "all|send|q-r-remote-modalities"], | |
| 67 ["post", "^/modalities/(.*)/echo$", "all|send|q-r-remote-modalities"], | |
| 68 ["post", "^/modalities/(.*)/query$", "all|q-r-remote-modalities"], | |
| 69 ["get", "^/queries/([a-f0-9-]+)/answers$", "all|q-r-remote-modalities"], | |
| 70 ["post", "^/modalities/(.*)/move$", "all|q-r-remote-modalities"], | |
| 71 ["get" , "^/DICOM_WEB_ROOT/(servers)/(.*)/stow$", "all|send"], | |
| 72 | |
| 73 // upload | |
| 74 ["post", "^/instances$", "all|upload"], | |
| 75 | |
| 76 // modifications/anonymization | |
| 77 ["post", "^/(patients|studies|series|instances)/([a-f0-9-]+)/modify(.*)$", "all|modify"], | |
| 78 ["post", "^/(patients|studies|series|instances)/([a-f0-9-]+)/anonymize(.*)$", "all|anonymize"] | |
| 79 | |
| 80 ] | |
| 81 } | |
| 82 } |