Produced by Araxis Merge on 10/4/2017 8:04:34 AM Central Daylight Time. See www.araxis.com for information about Merge. This report uses XHTML and CSS2, and is best viewed with a modern standards-compliant browser. For optimum results when printing this report, use landscape orientation and enable printing of background images and colours in your browser.
| # | Location | File | Last Modified |
|---|---|---|---|
| 1 | rdk.zip\rdk\product\production\rdk\src\resources\authentication | auth-resource.md | Mon Aug 21 12:51:00 2017 UTC |
| 2 | rdk.zip\rdk\product\production\rdk\src\resources\authentication | auth-resource.md | Tue Oct 3 18:11:48 2017 UTC |
| Description | Between Files 1 and 2 |
|
|---|---|---|
| Text Blocks | Lines | |
| Unchanged | 10 | 978 |
| Changed | 9 | 22 |
| Inserted | 0 | 0 |
| Removed | 0 | 0 |
| Whitespace | |
|---|---|
| Character case | Differences in character case are significant |
| Line endings | Differences in line endings (CR and LF characters) are ignored |
| CR/LF characters | Not shown in the comparison detail |
No regular expressions were active.
| 1 | # Group Au thenticati on | |
| 2 | ||
| 3 | ## Authent ication [{ {{path}}}] | |
| 4 | ||
| 5 | ### Authen ticate [PO ST] | |
| 6 | ||
| 7 | Login to c reate a us er session | |
| 8 | ||
| 9 | #### Notes | |
| 10 | ||
| 11 | Requires t he authent ication in terceptor to run in order to a dd the use r to the s ession for returning that data . | |
| 12 | ||
| 13 | + Request JSON Messa ge (applic ation/json ) | |
| 14 | ||
| 15 | + Body | |
| 16 | ||
| 17 | { | |
| 18 | "accessCod e": " REDACT ", | |
| 19 | "verifyCod e": " REDACTED ", | |
| 20 | "site": " R E D A CTED ", | |
| 21 | "div ision": "5 00" | |
| 22 | } | |
| 23 | ||
| 24 | + Sche ma | |
| 25 | ||
| 26 | { | |
| 27 | "$sc hema": "ht tp://json- schema.org /draft-04/ schema#", | |
| 28 | "typ e": "objec t", | |
| 29 | "req uired": [ | |
| 30 | "accessCod e", | |
| 31 | "verifyCod e", | |
| 32 | "site", | |
| 33 | "division" | |
| 34 | ], | |
| 35 | "pro perties": { | |
| 36 | "accessCod e": { | |
| 37 | "type" : "string" | |
| 38 | }, | |
| 39 | "verifyCod e": { | |
| 40 | "type" : "string" | |
| 41 | }, | |
| 42 | "site": { | |
| 43 | "type" : "string" | |
| 44 | }, | |
| 45 | "division" : { | |
| 46 | "type" : "string" | |
| 47 | } | |
| 48 | } | |
| 49 | } | |
| 50 | ||
| 51 | + Response 200 (appl ication/js on) | |
| 52 | ||
| 53 | + Body | |
| 54 | ||
| 55 | { | |
| 56 | "dat a": { | |
| 57 | "uid": "ur n:va:user: R E D A CTED :100000002 70", | |
| 58 | "disabled" : false, | |
| 59 | "divisionS elect": fa lse, | |
| 60 | "duz": { | |
| 61 | " R E D A CTED ": "100000 00270" | |
| 62 | }, | |
| 63 | "expires": "2016-09- 20T17:42:2 5.654Z", | |
| 64 | "facility" : "PANORAM A", | |
| 65 | "firstname ": "PANORA MA", | |
| 66 | "lastname" : "USER", | |
| 67 | "preferenc es": { | |
| 68 | "defau ltScreen": {} | |
| 69 | }, | |
| 70 | "permissio ns": [ | |
| 71 | "read- patient-re cord", | |
| 72 | "read- active-med ication" | |
| 73 | ], | |
| 74 | "pcmm": [{ | |
| 75 | "servi ce": [ | |
| 76 | "H OME TELEHE ALTH", | |
| 77 | "H OSPITAL ME DICINE", | |
| 78 | "I MAGING", | |
| 79 | "I NFECTIOUS DISEASE" | |
| 80 | ], | |
| 81 | "team" : [ | |
| 82 | "T EAM1" | |
| 83 | ], | |
| 84 | "roles ": [ | |
| 85 | "N URSE (RN)" | |
| 86 | ] | |
| 87 | }], | |
| 88 | "requiresR eset": fal se, | |
| 89 | "section": "Medicine ", | |
| 90 | "sessionLe ngth": 900 000, | |
| 91 | "site": " R E D A CTED ", | |
| 92 | "division" : "500", | |
| 93 | "title": " Clinician" , | |
| 94 | "provider" : true | |
| 95 | }, | |
| 96 | "sta tus": 200 | |
| 97 | } | |
| 98 | ||
| 99 | + Sche ma | |
| 100 | ||
| 101 | :[Schema ]({{{commo n}}}/schem as/authent ication-20 0.jsonsche ma) | |
| 102 | ||
| 103 | + Response 401 (appl ication/js on) | |
| 104 | ||
| 105 | + Body | |
| 106 | ||
| 107 | { | |
| 108 | "err or": "No D UZ returne d from log in request ", | |
| 109 | "mes sage": "No t a valid ACCESS COD E/VERIFY C ODE pair." , | |
| 110 | "sta tus": 401 | |
| 111 | } | |
| 112 | ||
| 113 | + Sche ma | |
| 114 | ||
| 115 | :[Schema ]({{{commo n}}}/schem as/authent ication-40 1.jsonsche ma) | |
| 116 | ||
| 117 | ||
| 118 | ### Refres h Token [G ET {{{path }}}] | |
| 119 | ||
| 120 | Refreshes the curren t user ses sion | |
| 121 | ||
| 122 | #### Notes | |
| 123 | ||
| 124 | Expects a session to already o ccur or it returns a blank obj ect. | |
| 125 | ||
| 126 | + Response 200 (appl ication/js on) | |
| 127 | ||
| 128 | + Body | |
| 129 | ||
| 130 | { | |
| 131 | "dat a": { | |
| 132 | "uid": "ur n:va:user: R E D A CTED :100000002 70", | |
| 133 | "disabled" : false, | |
| 134 | "divisionS elect": fa lse, | |
| 135 | "duz": { | |
| 136 | " R E D A CTED ": "100000 00270" | |
| 137 | }, | |
| 138 | "expires": "2016-09- 20T17:42:2 5.654Z", | |
| 139 | "facility" : "PANORAM A", | |
| 140 | "firstname ": "PANORA MA", | |
| 141 | "lastname" : "USER", | |
| 142 | "permissio ns": [ | |
| 143 | "read- patient-re cord", | |
| 144 | "read- active-med ication" | |
| 145 | ], | |
| 146 | "pcmm": [{ | |
| 147 | "servi ce": [ | |
| 148 | "H OME TELEHE ALTH", | |
| 149 | "H OSPITAL ME DICINE", | |
| 150 | "I MAGING", | |
| 151 | "I NFECTIOUS DISEASE" | |
| 152 | ], | |
| 153 | "team" : [ | |
| 154 | "T EAM1" | |
| 155 | ], | |
| 156 | "roles ": [ | |
| 157 | "N URSE (RN)" | |
| 158 | ] | |
| 159 | }], | |
| 160 | "requiresR eset": fal se, | |
| 161 | "section": "Medicine ", | |
| 162 | "sessionLe ngth": 900 000, | |
| 163 | "site": " R E D A CTED ", | |
| 164 | "division" : "500", | |
| 165 | "title": " Clinician" , | |
| 166 | "provider" : true | |
| 167 | }, | |
| 168 | "sta tus": 200 | |
| 169 | } | |
| 170 | ||
| 171 | + Sche ma | |
| 172 | ||
| 173 | :[Schema ]({{{commo n}}}/schem as/authent ication-20 0.jsonsche ma) | |
| 174 | ||
| 175 | + Response 401 (appl ication/js on) | |
| 176 | ||
| 177 | + Body | |
| 178 | ||
| 179 | { | |
| 180 | "sta tus": 401 | |
| 181 | } | |
| 182 | ||
| 183 | + Sche ma | |
| 184 | ||
| 185 | :[Schema ]({{{commo n}}}/schem as/authent ication-st atus.jsons chema) | |
| 186 | ||
| 187 | ||
| 188 | ### Destro y Session [DELETE] | |
| 189 | ||
| 190 | Destroys t he current user sess ion | |
| 191 | ||
| 192 | #### Notes | |
| 193 | ||
| 194 | Expects a session to exist els e it retur ns nothing . | |
| 195 | ||
| 196 | + Response 200 (appl ication/js on) | |
| 197 | ||
| 198 | + Body | |
| 199 | ||
| 200 | { | |
| 201 | "sta tus": 200 | |
| 202 | } | |
| 203 | ||
| 204 | + Sche ma | |
| 205 | ||
| 206 | :[Schema ]({{{commo n}}}/schem as/authent ication-st atus.jsons chema) | |
| 207 | ||
| 208 | + Response 401 (appl ication/js on) | |
| 209 | ||
| 210 | + Body | |
| 211 | ||
| 212 | { | |
| 213 | "mes sage": "No session t o destroy" , | |
| 214 | "sta tus": 401 | |
| 215 | } | |
| 216 | ||
| 217 | + Sche ma | |
| 218 | ||
| 219 | :[Schema ]({{{commo n}}}/schem as/message .jsonschem a) | |
| 220 | ||
| 221 | ||
| 222 | ### List V istA Insta nces [GET {{{path}}} /list] | |
| 223 | ||
| 224 | Return the list of v istas avai lable | |
| 225 | ||
| 226 | #### Notes | |
| 227 | ||
| 228 | Is a reado nly resour ce that re turns an a rray. | |
| 229 | ||
| 230 | + Response 200 (appl ication/js on) | |
| 231 | ||
| 232 | + Body | |
| 233 | ||
| 234 | { | |
| 235 | "dat a": { | |
| 236 | "items": [ | |
| 237 | { | |
| 238 | "n ame": "KOD AK", | |
| 239 | "d ivision": "507", | |
| 240 | "p roduction" : false, | |
| 241 | "siteCode" : " REDA C TED " | |
| 242 | }, | |
| 243 | { | |
| 244 | "n ame": "PAN ORAMA", | |
| 245 | "d ivision": "500", | |
| 246 | "p roduction" : false, | |
| 247 | "siteCode" : " R E D A CTED " | |
| 248 | } | |
| 249 | ] | |
| 250 | }, | |
| 251 | "sta tus": 200 | |
| 252 | } | |
| 253 | ||
| 254 | + Sche ma | |
| 255 | ||
| 256 | :[Schema ]({{{commo n}}}/schem as/authent ication_li st-GET-200 .jsonschem a) | |
| 257 | ||
| 258 | ### Intern al System Authentica te [POST { {{path}}}/ systems/in ternal] | |
| 259 | ||
| 260 | Login to c reate an i nternal sy stem sessi on | |
| 261 | ||
| 262 | The Author ization he ader will be the nam e of the s ystem aski ng for acc ess | |
| 263 | ||
| 264 | #### Notes | |
| 265 | ||
| 266 | Requires t he system- authentica tion inter ceptor to run in ord er to add the system user to t he session for retur ning data. | |
| 267 | ||
| 268 | + Request JSON Messa ge (applic ation/json ) | |
| 269 | ||
| 270 | + Head ers | |
| 271 | ||
| 272 | Authoriz ation: CDS | |
| 273 | ||
| 274 | + Response 200 (appl ication/js on) | |
| 275 | ||
| 276 | + Body | |
| 277 | ||
| 278 | { | |
| 279 | "dat a": { | |
| 280 | "name": "C DS", | |
| 281 | "permissio ns": [ | |
| 282 | "read- patient-re cord", | |
| 283 | "read- active-med ication" | |
| 284 | ], | |
| 285 | "permissio nSets": [" read-acces s"], | |
| 286 | "expires": "" | |
| 287 | }, | |
| 288 | "sta tus": 200 | |
| 289 | } | |
| 290 | ||
| 291 | + Sche ma | |
| 292 | ||
| 293 | :[Schema ]({{{commo n}}}/schem as/authent ication_sy stems-200. jsonschema ) | |
| 294 | ||
| 295 | + Response 401 (appl ication/js on) | |
| 296 | ||
| 297 | + Body | |
| 298 | ||
| 299 | { | |
| 300 | "err or": "No D UZ returne d from log in request ", | |
| 301 | "mes sage": "No t a valid ACCESS COD E/VERIFY C ODE pair." , | |
| 302 | "sta tus": 401 | |
| 303 | } | |
| 304 | ||
| 305 | + Sche ma | |
| 306 | ||
| 307 | :[Schema ]({{{commo n}}}/schem as/authent ication-40 1.jsonsche ma) | |
| 308 | ||
| 309 | ### Intern al System Authentica te [GET {{ {path}}}/s ystems/int ernal] | |
| 310 | ||
| 311 | Request to refresh t he expirat ion on an internal s ystem sess ion | |
| 312 | ||
| 313 | #### Notes | |
| 314 | ||
| 315 | Requires t he system- authentica tion inter ceptor to run in ord er to add the system user to t he session for retur ning data. | |
| 316 | ||
| 317 | ||
| 318 | + Response 200 (appl ication/js on) | |
| 319 | ||
| 320 | + Body | |
| 321 | ||
| 322 | { | |
| 323 | "dat a": { | |
| 324 | "name": "C DS", | |
| 325 | "permissio ns": [ | |
| 326 | "read- patient-re cord", | |
| 327 | "read- active-med ication" | |
| 328 | ], | |
| 329 | "permissio nSets": [" read-acces s"], | |
| 330 | "expires": "2015-12- 18T13:59:0 0.834Z" | |
| 331 | }, | |
| 332 | "sta tus": 200 | |
| 333 | } | |
| 334 | ||
| 335 | + Sche ma | |
| 336 | ||
| 337 | :[Schema ]({{{commo n}}}/schem as/authent ication_sy stems-200. jsonschema ) | |
| 338 | ||
| 339 | + Response 401 (appl ication/js on) | |
| 340 | ||
| 341 | + Body | |
| 342 | ||
| 343 | { | |
| 344 | "sta tus": 401 | |
| 345 | } | |
| 346 | ||
| 347 | + Sche ma | |
| 348 | ||
| 349 | :[Schema ]({{{commo n}}}/schem as/authent ication-st atus.jsons chema) | |
| 350 | ||
| 351 | ### Intern al System Authentica te [DELETE {{{path}} }/systems/ internal] | |
| 352 | ||
| 353 | Request to delete th e internal system se ssion | |
| 354 | ||
| 355 | + Response 200 (appl ication/js on) | |
| 356 | ||
| 357 | + Body | |
| 358 | ||
| 359 | { | |
| 360 | "sta tus": 200 | |
| 361 | } | |
| 362 | ||
| 363 | + Sche ma | |
| 364 | ||
| 365 | :[Schema ]({{{commo n}}}/schem as/authent ication-st atus.jsons chema) | |
| 366 | ||
| 367 | + Response 401 (appl ication/js on) | |
| 368 | ||
| 369 | + Body | |
| 370 | ||
| 371 | { | |
| 372 | "sta tus": 401 | |
| 373 | } | |
| 374 | ||
| 375 | + Sche ma | |
| 376 | ||
| 377 | :[Schema ]({{{commo n}}}/schem as/authent ication-st atus.jsons chema) | |
| 378 | ||
| 379 | ||
| 380 | ### Extern al System Authentica te [POST { {{path}}}/ systems/ex ternal] | |
| 381 | ||
| 382 | Login to c reate an e xternal sy stem sessi on | |
| 383 | ||
| 384 | The Author ization he ader will be the nam e of the s ystem aski ng for acc ess | |
| 385 | ||
| 386 | #### Notes | |
| 387 | ||
| 388 | Requires t he system- authentica tion inter ceptor to run in ord er to add the system user to t he session for retur ning data. | |
| 389 | ||
| 390 | + Request JSON Messa ge (applic ation/json ) | |
| 391 | ||
| 392 | + Head ers | |
| 393 | ||
| 394 | Authoriz ation: CDS | |
| 395 | ||
| 396 | + Response 200 (appl ication/js on) | |
| 397 | ||
| 398 | + Body | |
| 399 | ||
| 400 | { | |
| 401 | "dat a": { | |
| 402 | "name": "C DS", | |
| 403 | "permissio ns": [ | |
| 404 | "read- patient-re cord", | |
| 405 | "read- active-med ication" | |
| 406 | ], | |
| 407 | "permissio nSets": [" read-acces s"], | |
| 408 | "expires": "" | |
| 409 | }, | |
| 410 | "sta tus": 200 | |
| 411 | } | |
| 412 | ||
| 413 | + Sche ma | |
| 414 | ||
| 415 | :[Schema ]({{{commo n}}}/schem as/authent ication_sy stems-200. jsonschema ) | |
| 416 | ||
| 417 | + Response 401 (appl ication/js on) | |
| 418 | ||
| 419 | + Body | |
| 420 | ||
| 421 | { | |
| 422 | "err or": "No D UZ returne d from log in request ", | |
| 423 | "mes sage": "No t a valid ACCESS COD E/VERIFY C ODE pair." , | |
| 424 | "sta tus": 401 | |
| 425 | } | |
| 426 | ||
| 427 | + Sche ma | |
| 428 | ||
| 429 | :[Schema ]({{{commo n}}}/schem as/authent ication-40 1.jsonsche ma) | |
| 430 | ||
| 431 | ### Extern al System Authentica te [GET {{ {path}}}/s ystems/ext ernal] | |
| 432 | ||
| 433 | Request to refresh t he expirat ion on an external s ystem sess ion | |
| 434 | ||
| 435 | #### Notes | |
| 436 | ||
| 437 | Requires t he system- authentica tion inter ceptor to run in ord er to add the system user to t he session for retur ning data. | |
| 438 | ||
| 439 | ||
| 440 | + Response 200 (appl ication/js on) | |
| 441 | ||
| 442 | + Body | |
| 443 | ||
| 444 | { | |
| 445 | "dat a": { | |
| 446 | "name": "C DS", | |
| 447 | "permissio ns": [ | |
| 448 | "read- patient-re cord", | |
| 449 | "read- active-med ication" | |
| 450 | ], | |
| 451 | "permissio nSets": [" read-acces s"], | |
| 452 | "expires": "2015-12- 18T13:59:0 0.834Z" | |
| 453 | }, | |
| 454 | "sta tus": 200 | |
| 455 | } | |
| 456 | ||
| 457 | + Sche ma | |
| 458 | ||
| 459 | :[Schema ]({{{commo n}}}/schem as/authent ication_sy stems-200. jsonschema ) | |
| 460 | ||
| 461 | + Response 401 (appl ication/js on) | |
| 462 | ||
| 463 | + Body | |
| 464 | ||
| 465 | { | |
| 466 | "sta tus": 401 | |
| 467 | } | |
| 468 | ||
| 469 | + Sche ma | |
| 470 | ||
| 471 | :[Schema ]({{{commo n}}}/schem as/authent ication-st atus.jsons chema) | |
| 472 | ||
| 473 | ### Extern al System Authentica te [DELETE {{{path}} }/systems/ external] | |
| 474 | ||
| 475 | Request to delete th e external system se ssion | |
| 476 | ||
| 477 | + Response 200 (appl ication/js on) | |
| 478 | ||
| 479 | + Body | |
| 480 | ||
| 481 | { | |
| 482 | "sta tus": 200 | |
| 483 | } | |
| 484 | ||
| 485 | + Sche ma | |
| 486 | ||
| 487 | :[Schema ]({{{commo n}}}/schem as/authent ication-st atus.jsons chema) | |
| 488 | ||
| 489 | + Response 401 (appl ication/js on) | |
| 490 | ||
| 491 | + Body | |
| 492 | ||
| 493 | { | |
| 494 | "sta tus": 401 | |
| 495 | } | |
| 496 | ||
| 497 | + Sche ma | |
| 498 | ||
| 499 | :[Schema ]({{{commo n}}}/schem as/authent ication-st atus.jsons chema) | |
| 500 |
Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.