| sg481n | faf7f2d | 2017-09-22 17:17:23 +0000 | [diff] [blame] | 1 | AT&T Auth Tool
|
| 2 | ==============
|
| 3 |
|
| 4 | --------------
|
| 5 |
|
| 6 | AAF 2.0 RESTful interface
|
| 7 | =========================
|
| 8 |
|
| 9 | --------------
|
| 10 |
|
| 11 | Accessing RESTful
|
| 12 | -----------------
|
| 13 |
|
| 14 | AAF RESTful service is secured by the following:
|
| 15 |
|
| 16 | The Client must utilize HTTP/S. Non Secure HTTP is not acceptable
|
| 17 |
|
| 18 | The Client MUST supply an Identity validated by one of the following mechanisms
|
| 19 |
|
| 20 | - Valid Global Login Cookie (CSP)
|
| 21 | - BASIC AUTH protocol using CSO Registered MechID, provisioned in AAF
|
| 22 | - (Near Future) Application level Certificate & oAuth
|
| 23 |
|
| 24 | Responses
|
| 25 |
|
| 26 | Each API Entity listed shows what structure will be accepted by service (ContentType) or responded with by service (Accept). Therefore, use these in making your call. Critical for PUT/POST.
|
| 27 |
|
| 28 | Each API call may respond with JSON or XML. Choose the ContentType/Accept that has +json after the type for JSON or +xml after the Type for XML
|
| 29 |
|
| 30 | XSDs for Versions
|
| 31 |
|
| 32 |
|
| 33 | AAF can support multiple Versions of the API. Choose the ContentType/Accept that has the appropriate version=?.?
|
| 34 |
|
| 35 |
|
| 36 | Character Restrictions
|
| 37 |
|
| 38 | - Character Restrictions must depend on the Enforcement Point used
|
| 39 | - Most AAF usage will be AAF Enforcement Point Characters for Instance and Action are:
|
| 40 | *a-zA-Z0-9,.()\_-=%*
|
| 41 | For Instance, you may declare a multi-dimensional key with : (colon) separator, example:
|
| 42 |
|
| 43 | Ask for a Consultation on how these are typically used, or, if your tool is the only Enforcement Point, if set may be expanded
|
| 44 |
|
| 45 | +--------------------+--------------------+--------------------+--------------------+
|
| 46 | | Entity | Method | Path Info | Description |
|
| 47 | +====================+====================+====================+====================+
|
| 48 | | PERMISSION | POST | /authz/perm | Create a |
|
| 49 | | | | | Permission |
|
| 50 | | | | | |
|
| 51 | | | | | Permission |
|
| 52 | | | | | consists of: |
|
| 53 | | | | | |
|
| 54 | | | | | - type - a |
|
| 55 | | | | | Namespace |
|
| 56 | | | | | qualified |
|
| 57 | | | | | identifier |
|
| 58 | | | | | specifying what |
|
| 59 | | | | | kind of |
|
| 60 | | | | | resource is |
|
| 61 | | | | | being protected |
|
| 62 | | | | | - instance - a |
|
| 63 | | | | | key, possibly |
|
| 64 | | | | | multi-dimension |
|
| 65 | | | | | al, |
|
| 66 | | | | | that identifies |
|
| 67 | | | | | a specific |
|
| 68 | | | | | instance of the |
|
| 69 | | | | | type |
|
| 70 | | | | | - action - what |
|
| 71 | | | | | kind of action |
|
| 72 | | | | | is allowed |
|
| 73 | | | | | |
|
| 74 | | | | | Note: instance and |
|
| 75 | | | | | action can be an |
|
| 76 | | | | | \* |
|
| 77 | | | | | |
|
| 78 | | | | | Expected HTTP Code |
|
| 79 | | | | | |
|
| 80 | | | | | 201 |
|
| 81 | | | | | |
|
| 82 | | | | | Explicit HTTP |
|
| 83 | | | | | Error Codes |
|
| 84 | | | | | |
|
| 85 | | | | | 403, 404, 406, 409 |
|
| 86 | | | | | |
|
| 87 | | | | | ContentType: |
|
| 88 | | | | | |
|
| 89 | | | | | ` <./example/YXBwb |
|
| 90 | | | | | GljYXRpb24vUGVybVJ |
|
| 91 | | | | | lcXVlc3QranNvbjtxP |
|
| 92 | | | | | TEuMDtjaGFyc2V0PXV |
|
| 93 | | | | | 0Zi04O3ZlcnNpb249M |
|
| 94 | | | | | i4wLGFwcGxpY2F0aW9 |
|
| 95 | | | | | uL2pzb247cT0xLjA7d |
|
| 96 | | | | | mVyc2lvbj0yLjAsKi8 |
|
| 97 | | | | | qO3E9MS4w>`__\ app |
|
| 98 | | | | | lication/PermReque |
|
| 99 | | | | | st+json;q=1.0;char |
|
| 100 | | | | | set=utf-8;version= |
|
| 101 | | | | | 2.0,application/js |
|
| 102 | | | | | on;q=1.0;version=2 |
|
| 103 | | | | | .0,\*/\*;q=1.0 |
|
| 104 | | | | | |
|
| 105 | | | | | ` <./example/YXBwb |
|
| 106 | | | | | GljYXRpb24vUGVybVJ |
|
| 107 | | | | | lcXVlc3QreG1sO3E9M |
|
| 108 | | | | | S4wO2NoYXJzZXQ9dXR |
|
| 109 | | | | | mLTg7dmVyc2lvbj0yL |
|
| 110 | | | | | jAsdGV4dC94bWw7cT0 |
|
| 111 | | | | | xLjA7dmVyc2lvbj0yL |
|
| 112 | | | | | jA=>`__\ applicati |
|
| 113 | | | | | on/PermRequest+xml |
|
| 114 | | | | | ;q=1.0;charset=utf |
|
| 115 | | | | | -8;version=2.0,tex |
|
| 116 | | | | | t/xml;q=1.0;versio |
|
| 117 | | | | | n=2.0 |
|
| 118 | +--------------------+--------------------+--------------------+--------------------+
|
| 119 | | | PUT | /authz/perm | Set Description |
|
| 120 | | | | | for Permission |
|
| 121 | | | | | |
|
| 122 | | | | | Add Description |
|
| 123 | | | | | Data to Perm |
|
| 124 | | | | | |
|
| 125 | | | | | Expected HTTP Code |
|
| 126 | | | | | |
|
| 127 | | | | | 200 |
|
| 128 | | | | | |
|
| 129 | | | | | Explicit HTTP |
|
| 130 | | | | | Error Codes |
|
| 131 | | | | | |
|
| 132 | | | | | 404, 406 |
|
| 133 | | | | | |
|
| 134 | | | | | ContentType: |
|
| 135 | | | | | |
|
| 136 | | | | | ` <./example/YXBwb |
|
| 137 | | | | | GljYXRpb24vUGVybVJ |
|
| 138 | | | | | lcXVlc3QranNvbjtxP |
|
| 139 | | | | | TEuMDtjaGFyc2V0PXV |
|
| 140 | | | | | 0Zi04O3ZlcnNpb249M |
|
| 141 | | | | | i4wLGFwcGxpY2F0aW9 |
|
| 142 | | | | | uL2pzb247cT0xLjA7d |
|
| 143 | | | | | mVyc2lvbj0yLjAsKi8 |
|
| 144 | | | | | qO3E9MS4w>`__\ app |
|
| 145 | | | | | lication/PermReque |
|
| 146 | | | | | st+json;q=1.0;char |
|
| 147 | | | | | set=utf-8;version= |
|
| 148 | | | | | 2.0,application/js |
|
| 149 | | | | | on;q=1.0;version=2 |
|
| 150 | | | | | .0,\*/\*;q=1.0 |
|
| 151 | | | | | |
|
| 152 | | | | | ` <./example/YXBwb |
|
| 153 | | | | | GljYXRpb24vUGVybVJ |
|
| 154 | | | | | lcXVlc3QreG1sO3E9M |
|
| 155 | | | | | S4wO2NoYXJzZXQ9dXR |
|
| 156 | | | | | mLTg7dmVyc2lvbj0yL |
|
| 157 | | | | | jAsdGV4dC94bWw7cT0 |
|
| 158 | | | | | xLjA7dmVyc2lvbj0yL |
|
| 159 | | | | | jA=>`__\ applicati |
|
| 160 | | | | | on/PermRequest+xml |
|
| 161 | | | | | ;q=1.0;charset=utf |
|
| 162 | | | | | -8;version=2.0,tex |
|
| 163 | | | | | t/xml;q=1.0;versio |
|
| 164 | | | | | n=2.0 |
|
| 165 | +--------------------+--------------------+--------------------+--------------------+
|
| 166 | | | DELETE | /authz/perm | Delete a |
|
| 167 | | | | | Permission |
|
| 168 | | | | | |
|
| 169 | | | | | Delete the |
|
| 170 | | | | | Permission |
|
| 171 | | | | | referenced by |
|
| 172 | | | | | PermKey. |
|
| 173 | | | | | |
|
| 174 | | | | | You cannot |
|
| 175 | | | | | normally delete a |
|
| 176 | | | | | permission which |
|
| 177 | | | | | is still granted |
|
| 178 | | | | | to roles, |
|
| 179 | | | | | |
|
| 180 | | | | | however the |
|
| 181 | | | | | "force" property |
|
| 182 | | | | | allows you to do |
|
| 183 | | | | | just that. To do |
|
| 184 | | | | | this: Add |
|
| 185 | | | | | |
|
| 186 | | | | | 'force=true' as a |
|
| 187 | | | | | query parameter. |
|
| 188 | | | | | |
|
| 189 | | | | | WARNING: Using |
|
| 190 | | | | | force will ungrant |
|
| 191 | | | | | this permission |
|
| 192 | | | | | from all roles. |
|
| 193 | | | | | Use with care. |
|
| 194 | | | | | |
|
| 195 | | | | | Expected HTTP Code |
|
| 196 | | | | | |
|
| 197 | | | | | 200 |
|
| 198 | | | | | |
|
| 199 | | | | | Explicit HTTP |
|
| 200 | | | | | Error Codes |
|
| 201 | | | | | |
|
| 202 | | | | | 404, 406 |
|
| 203 | | | | | |
|
| 204 | | | | | ContentType: |
|
| 205 | | | | | |
|
| 206 | | | | | ` <./example/YXBwb |
|
| 207 | | | | | GljYXRpb24vUGVybVJ |
|
| 208 | | | | | lcXVlc3QranNvbjtxP |
|
| 209 | | | | | TEuMDtjaGFyc2V0PXV |
|
| 210 | | | | | 0Zi04O3ZlcnNpb249M |
|
| 211 | | | | | i4wLGFwcGxpY2F0aW9 |
|
| 212 | | | | | uL2pzb247cT0xLjA7d |
|
| 213 | | | | | mVyc2lvbj0yLjAsKi8 |
|
| 214 | | | | | qO3E9MS4w>`__\ app |
|
| 215 | | | | | lication/PermReque |
|
| 216 | | | | | st+json;q=1.0;char |
|
| 217 | | | | | set=utf-8;version= |
|
| 218 | | | | | 2.0,application/js |
|
| 219 | | | | | on;q=1.0;version=2 |
|
| 220 | | | | | .0,\*/\*;q=1.0 |
|
| 221 | | | | | |
|
| 222 | | | | | ` <./example/YXBwb |
|
| 223 | | | | | GljYXRpb24vUGVybVJ |
|
| 224 | | | | | lcXVlc3QreG1sO3E9M |
|
| 225 | | | | | S4wO2NoYXJzZXQ9dXR |
|
| 226 | | | | | mLTg7dmVyc2lvbj0yL |
|
| 227 | | | | | jAsdGV4dC94bWw7cT0 |
|
| 228 | | | | | xLjA7dmVyc2lvbj0yL |
|
| 229 | | | | | jA=>`__\ applicati |
|
| 230 | | | | | on/PermRequest+xml |
|
| 231 | | | | | ;q=1.0;charset=utf |
|
| 232 | | | | | -8;version=2.0,tex |
|
| 233 | | | | | t/xml;q=1.0;versio |
|
| 234 | | | | | n=2.0 |
|
| 235 | +--------------------+--------------------+--------------------+--------------------+
|
| 236 | | | DELETE | /authz/perm/:name/ | Delete a |
|
| 237 | | | | :type/:action | Permission |
|
| 238 | | | | | |
|
| 239 | | | | | Delete the |
|
| 240 | | | | | Permission |
|
| 241 | | | | | referenced by |
|
| 242 | | | | | :type :instance |
|
| 243 | | | | | :action |
|
| 244 | | | | | |
|
| 245 | | | | | You cannot |
|
| 246 | | | | | normally delete a |
|
| 247 | | | | | permission which |
|
| 248 | | | | | is still granted |
|
| 249 | | | | | to roles, |
|
| 250 | | | | | |
|
| 251 | | | | | however the |
|
| 252 | | | | | "force" property |
|
| 253 | | | | | allows you to do |
|
| 254 | | | | | just that. To do |
|
| 255 | | | | | this: Add |
|
| 256 | | | | | |
|
| 257 | | | | | 'force=true' as a |
|
| 258 | | | | | query parameter |
|
| 259 | | | | | |
|
| 260 | | | | | WARNING: Using |
|
| 261 | | | | | force will ungrant |
|
| 262 | | | | | this permission |
|
| 263 | | | | | from all roles. |
|
| 264 | | | | | Use with care. |
|
| 265 | | | | | |
|
| 266 | | | | | -------------- |
|
| 267 | | | | | |
|
| 268 | | | | | Parameters |
|
| 269 | | | | | |
|
| 270 | | | | | type : string |
|
| 271 | | | | | (Required) |
|
| 272 | | | | | |
|
| 273 | | | | | instance : string |
|
| 274 | | | | | (Required) |
|
| 275 | | | | | |
|
| 276 | | | | | action : string |
|
| 277 | | | | | (Required) |
|
| 278 | | | | | |
|
| 279 | | | | | Expected HTTP Code |
|
| 280 | | | | | |
|
| 281 | | | | | 200 |
|
| 282 | | | | | |
|
| 283 | | | | | Explicit HTTP |
|
| 284 | | | | | Error Codes |
|
| 285 | | | | | |
|
| 286 | | | | | 404, 406 |
|
| 287 | | | | | |
|
| 288 | | | | | ContentType: |
|
| 289 | | | | | |
|
| 290 | | | | | ` <./example/YXBwb |
|
| 291 | | | | | GljYXRpb24vUGVybUt |
|
| 292 | | | | | leStqc29uO3E9MS4wO |
|
| 293 | | | | | 2NoYXJzZXQ9dXRmLTg |
|
| 294 | | | | | 7dmVyc2lvbj0yLjAsY |
|
| 295 | | | | | XBwbGljYXRpb24vanN |
|
| 296 | | | | | vbjtxPTEuMDt2ZXJza |
|
| 297 | | | | | W9uPTIuMCwqLyo7cT0 |
|
| 298 | | | | | xLjA=>`__\ applica |
|
| 299 | | | | | tion/PermKey+json; |
|
| 300 | | | | | q=1.0;charset=utf- |
|
| 301 | | | | | 8;version=2.0,appl |
|
| 302 | | | | | ication/json;q=1.0 |
|
| 303 | | | | | ;version=2.0,\*/\* |
|
| 304 | | | | | ;q=1.0 |
|
| 305 | | | | | |
|
| 306 | | | | | ` <./example/YXBwb |
|
| 307 | | | | | GljYXRpb24vUGVybUt |
|
| 308 | | | | | leSt4bWw7cT0xLjA7Y |
|
| 309 | | | | | 2hhcnNldD11dGYtODt |
|
| 310 | | | | | 2ZXJzaW9uPTIuMCx0Z |
|
| 311 | | | | | Xh0L3htbDtxPTEuMDt |
|
| 312 | | | | | 2ZXJzaW9uPTIuMA==> |
|
| 313 | | | | | `__\ application/P |
|
| 314 | | | | | ermKey+xml;q=1.0;c |
|
| 315 | | | | | harset=utf-8;versi |
|
| 316 | | | | | on=2.0,text/xml;q= |
|
| 317 | | | | | 1.0;version=2.0 |
|
| 318 | +--------------------+--------------------+--------------------+--------------------+
|
| 319 | | | PUT | /authz/perm/:type/ | Update a |
|
| 320 | | | | :instance/:action | Permission |
|
| 321 | | | | | |
|
| 322 | | | | | Rename the |
|
| 323 | | | | | Permission |
|
| 324 | | | | | referenced by |
|
| 325 | | | | | :type :instance |
|
| 326 | | | | | :action, and |
|
| 327 | | | | | rename |
|
| 328 | | | | | (copy/delete) to |
|
| 329 | | | | | the Permission |
|
| 330 | | | | | described in |
|
| 331 | | | | | PermRequest |
|
| 332 | | | | | |
|
| 333 | | | | | -------------- |
|
| 334 | | | | | |
|
| 335 | | | | | Parameters |
|
| 336 | | | | | |
|
| 337 | | | | | type : string |
|
| 338 | | | | | (Required) |
|
| 339 | | | | | |
|
| 340 | | | | | instance : string |
|
| 341 | | | | | (Required) |
|
| 342 | | | | | |
|
| 343 | | | | | action : string |
|
| 344 | | | | | (Required) |
|
| 345 | | | | | |
|
| 346 | | | | | Expected HTTP Code |
|
| 347 | | | | | |
|
| 348 | | | | | 200 |
|
| 349 | | | | | |
|
| 350 | | | | | Explicit HTTP |
|
| 351 | | | | | Error Codes |
|
| 352 | | | | | |
|
| 353 | | | | | 404, 406, 409 |
|
| 354 | | | | | |
|
| 355 | | | | | ContentType: |
|
| 356 | | | | | |
|
| 357 | | | | | ` <./example/YXBwb |
|
| 358 | | | | | GljYXRpb24vUGVybVJ |
|
| 359 | | | | | lcXVlc3QranNvbjtxP |
|
| 360 | | | | | TEuMDtjaGFyc2V0PXV |
|
| 361 | | | | | 0Zi04O3ZlcnNpb249M |
|
| 362 | | | | | i4wLGFwcGxpY2F0aW9 |
|
| 363 | | | | | uL2pzb247cT0xLjA7d |
|
| 364 | | | | | mVyc2lvbj0yLjAsKi8 |
|
| 365 | | | | | qO3E9MS4w>`__\ app |
|
| 366 | | | | | lication/PermReque |
|
| 367 | | | | | st+json;q=1.0;char |
|
| 368 | | | | | set=utf-8;version= |
|
| 369 | | | | | 2.0,application/js |
|
| 370 | | | | | on;q=1.0;version=2 |
|
| 371 | | | | | .0,\*/\*;q=1.0 |
|
| 372 | | | | | |
|
| 373 | | | | | ` <./example/YXBwb |
|
| 374 | | | | | GljYXRpb24vUGVybVJ |
|
| 375 | | | | | lcXVlc3QreG1sO3E9M |
|
| 376 | | | | | S4wO2NoYXJzZXQ9dXR |
|
| 377 | | | | | mLTg7dmVyc2lvbj0yL |
|
| 378 | | | | | jAsdGV4dC94bWw7cT0 |
|
| 379 | | | | | xLjA7dmVyc2lvbj0yL |
|
| 380 | | | | | jA=>`__\ applicati |
|
| 381 | | | | | on/PermRequest+xml |
|
| 382 | | | | | ;q=1.0;charset=utf |
|
| 383 | | | | | -8;version=2.0,tex |
|
| 384 | | | | | t/xml;q=1.0;versio |
|
| 385 | | | | | n=2.0 |
|
| 386 | +--------------------+--------------------+--------------------+--------------------+
|
| 387 | | | GET | /authz/perms/:type | Get Permissions by |
|
| 388 | | | | | Type |
|
| 389 | | | | | |
|
| 390 | | | | | List All |
|
| 391 | | | | | Permissions that |
|
| 392 | | | | | match the :type |
|
| 393 | | | | | element of the key |
|
| 394 | | | | | |
|
| 395 | | | | | -------------- |
|
| 396 | | | | | |
|
| 397 | | | | | Parameters |
|
| 398 | | | | | |
|
| 399 | | | | | type : string |
|
| 400 | | | | | (Required) |
|
| 401 | | | | | |
|
| 402 | | | | | Expected HTTP Code |
|
| 403 | | | | | |
|
| 404 | | | | | 200 |
|
| 405 | | | | | |
|
| 406 | | | | | Explicit HTTP |
|
| 407 | | | | | Error Codes |
|
| 408 | | | | | |
|
| 409 | | | | | 404, 406 |
|
| 410 | | | | | |
|
| 411 | | | | | Accept: |
|
| 412 | | | | | |
|
| 413 | | | | | ` <./example/YXBwb |
|
| 414 | | | | | GljYXRpb24vUGVybXM |
|
| 415 | | | | | ranNvbjtxPTEuMDtja |
|
| 416 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 417 | | | | | lcnNpb249Mi4wLGFwc |
|
| 418 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 419 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 420 | | | | | j0yLjAsKi8qO3E9MS4 |
|
| 421 | | | | | w>`__\ application |
|
| 422 | | | | | /Perms+json;q=1.0; |
|
| 423 | | | | | charset=utf-8;vers |
|
| 424 | | | | | ion=2.0,applicatio |
|
| 425 | | | | | n/json;q=1.0;versi |
|
| 426 | | | | | on=2.0,\*/\*;q=1.0 |
|
| 427 | | | | | |
|
| 428 | | | | | ` <./example/YXBwb |
|
| 429 | | | | | GljYXRpb24vUGVybXM |
|
| 430 | | | | | reG1sO3E9MS4wO2NoY |
|
| 431 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 432 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 433 | | | | | C94bWw7cT0xLjA7dmV |
|
| 434 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 435 | | | | | application/Perms |
|
| 436 | | | | | +xml;q=1.0;charset |
|
| 437 | | | | | =utf-8;version=2.0 |
|
| 438 | | | | | ,text/xml;q=1.0;ve |
|
| 439 | | | | | rsion=2.0 |
|
| 440 | +--------------------+--------------------+--------------------+--------------------+
|
| 441 | | | GET | /authz/perms/:type | Get Permissions by |
|
| 442 | | | | /:instance/:action | Key |
|
| 443 | | | | | |
|
| 444 | | | | | List Permissions |
|
| 445 | | | | | that match key; |
|
| 446 | | | | | :type, :instance |
|
| 447 | | | | | and :action |
|
| 448 | | | | | |
|
| 449 | | | | | -------------- |
|
| 450 | | | | | |
|
| 451 | | | | | Parameters |
|
| 452 | | | | | |
|
| 453 | | | | | type : string |
|
| 454 | | | | | (Required) |
|
| 455 | | | | | |
|
| 456 | | | | | instance : string |
|
| 457 | | | | | (Required) |
|
| 458 | | | | | |
|
| 459 | | | | | action : string |
|
| 460 | | | | | (Required) |
|
| 461 | | | | | |
|
| 462 | | | | | Expected HTTP Code |
|
| 463 | | | | | |
|
| 464 | | | | | 200 |
|
| 465 | | | | | |
|
| 466 | | | | | Explicit HTTP |
|
| 467 | | | | | Error Codes |
|
| 468 | | | | | |
|
| 469 | | | | | 404, 406 |
|
| 470 | | | | | |
|
| 471 | | | | | Accept: |
|
| 472 | | | | | |
|
| 473 | | | | | ` <./example/YXBwb |
|
| 474 | | | | | GljYXRpb24vUGVybXM |
|
| 475 | | | | | ranNvbjtxPTEuMDtja |
|
| 476 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 477 | | | | | lcnNpb249Mi4wLGFwc |
|
| 478 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 479 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 480 | | | | | j0yLjAsKi8qO3E9MS4 |
|
| 481 | | | | | w>`__\ application |
|
| 482 | | | | | /Perms+json;q=1.0; |
|
| 483 | | | | | charset=utf-8;vers |
|
| 484 | | | | | ion=2.0,applicatio |
|
| 485 | | | | | n/json;q=1.0;versi |
|
| 486 | | | | | on=2.0,\*/\*;q=1.0 |
|
| 487 | | | | | |
|
| 488 | | | | | ` <./example/YXBwb |
|
| 489 | | | | | GljYXRpb24vUGVybXM |
|
| 490 | | | | | reG1sO3E9MS4wO2NoY |
|
| 491 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 492 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 493 | | | | | C94bWw7cT0xLjA7dmV |
|
| 494 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 495 | | | | | application/Perms |
|
| 496 | | | | | +xml;q=1.0;charset |
|
| 497 | | | | | =utf-8;version=2.0 |
|
| 498 | | | | | ,text/xml;q=1.0;ve |
|
| 499 | | | | | rsion=2.0 |
|
| 500 | +--------------------+--------------------+--------------------+--------------------+
|
| 501 | | | GET | /authz/perms/ns/:n | Get PermsByNS |
|
| 502 | | | | s | |
|
| 503 | | | | | List All |
|
| 504 | | | | | Permissions that |
|
| 505 | | | | | are in Namespace |
|
| 506 | | | | | :ns |
|
| 507 | | | | | |
|
| 508 | | | | | -------------- |
|
| 509 | | | | | |
|
| 510 | | | | | Parameters |
|
| 511 | | | | | |
|
| 512 | | | | | ns : string |
|
| 513 | | | | | (Required) |
|
| 514 | | | | | |
|
| 515 | | | | | Expected HTTP Code |
|
| 516 | | | | | |
|
| 517 | | | | | 200 |
|
| 518 | | | | | |
|
| 519 | | | | | Explicit HTTP |
|
| 520 | | | | | Error Codes |
|
| 521 | | | | | |
|
| 522 | | | | | 404, 406 |
|
| 523 | | | | | |
|
| 524 | | | | | Accept: |
|
| 525 | | | | | |
|
| 526 | | | | | ` <./example/YXBwb |
|
| 527 | | | | | GljYXRpb24vUGVybXM |
|
| 528 | | | | | ranNvbjtxPTEuMDtja |
|
| 529 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 530 | | | | | lcnNpb249Mi4wLGFwc |
|
| 531 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 532 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 533 | | | | | j0yLjAsKi8qO3E9MC4 |
|
| 534 | | | | | y>`__\ application |
|
| 535 | | | | | /Perms+json;q=1.0; |
|
| 536 | | | | | charset=utf-8;vers |
|
| 537 | | | | | ion=2.0,applicatio |
|
| 538 | | | | | n/json;q=1.0;versi |
|
| 539 | | | | | on=2.0,\*/\*;q=0.2 |
|
| 540 | | | | | |
|
| 541 | | | | | ` <./example/YXBwb |
|
| 542 | | | | | GljYXRpb24vUGVybXM |
|
| 543 | | | | | reG1sO3E9MS4wO2NoY |
|
| 544 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 545 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 546 | | | | | C94bWw7cT0xLjA7dmV |
|
| 547 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 548 | | | | | application/Perms |
|
| 549 | | | | | +xml;q=1.0;charset |
|
| 550 | | | | | =utf-8;version=2.0 |
|
| 551 | | | | | ,text/xml;q=1.0;ve |
|
| 552 | | | | | rsion=2.0 |
|
| 553 | +--------------------+--------------------+--------------------+--------------------+
|
| 554 | | | GET | /authz/perms/role/ | Get Permissions by |
|
| 555 | | | | :role | Role |
|
| 556 | | | | | |
|
| 557 | | | | | List All |
|
| 558 | | | | | Permissions that |
|
| 559 | | | | | are granted to |
|
| 560 | | | | | :role |
|
| 561 | | | | | |
|
| 562 | | | | | -------------- |
|
| 563 | | | | | |
|
| 564 | | | | | Parameters |
|
| 565 | | | | | |
|
| 566 | | | | | role : string |
|
| 567 | | | | | (Required) |
|
| 568 | | | | | |
|
| 569 | | | | | Expected HTTP Code |
|
| 570 | | | | | |
|
| 571 | | | | | 200 |
|
| 572 | | | | | |
|
| 573 | | | | | Explicit HTTP |
|
| 574 | | | | | Error Codes |
|
| 575 | | | | | |
|
| 576 | | | | | 404, 406 |
|
| 577 | | | | | |
|
| 578 | | | | | Accept: |
|
| 579 | | | | | |
|
| 580 | | | | | ` <./example/YXBwb |
|
| 581 | | | | | GljYXRpb24vUGVybXM |
|
| 582 | | | | | ranNvbjtxPTEuMDtja |
|
| 583 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 584 | | | | | lcnNpb249Mi4wLGFwc |
|
| 585 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 586 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 587 | | | | | j0yLjAsKi8qO3E9MS4 |
|
| 588 | | | | | w>`__\ application |
|
| 589 | | | | | /Perms+json;q=1.0; |
|
| 590 | | | | | charset=utf-8;vers |
|
| 591 | | | | | ion=2.0,applicatio |
|
| 592 | | | | | n/json;q=1.0;versi |
|
| 593 | | | | | on=2.0,\*/\*;q=1.0 |
|
| 594 | | | | | |
|
| 595 | | | | | ` <./example/YXBwb |
|
| 596 | | | | | GljYXRpb24vUGVybXM |
|
| 597 | | | | | reG1sO3E9MS4wO2NoY |
|
| 598 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 599 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 600 | | | | | C94bWw7cT0xLjA7dmV |
|
| 601 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 602 | | | | | application/Perms |
|
| 603 | | | | | +xml;q=1.0;charset |
|
| 604 | | | | | =utf-8;version=2.0 |
|
| 605 | | | | | ,text/xml;q=1.0;ve |
|
| 606 | | | | | rsion=2.0 |
|
| 607 | +--------------------+--------------------+--------------------+--------------------+
|
| 608 | | | POST | /authz/perms/user/ | Get Permissions by |
|
| 609 | | | | :user | User, Query AAF |
|
| 610 | | | | | Perms |
|
| 611 | | | | | |
|
| 612 | | | | | List All |
|
| 613 | | | | | Permissions that |
|
| 614 | | | | | match user :user |
|
| 615 | | | | | |
|
| 616 | | | | | 'user' must be |
|
| 617 | | | | | expressed as full |
|
| 618 | | | | | identity (ex: |
|
| 619 | | | | | id@full.domain.com |
|
| 620 | | | | | ) |
|
| 621 | | | | | |
|
| 622 | | | | | Present Queries as |
|
| 623 | | | | | one or more |
|
| 624 | | | | | Permissions (see |
|
| 625 | | | | | ContentType Links |
|
| 626 | | | | | below for format). |
|
| 627 | | | | | |
|
| 628 | | | | | If the Caller is |
|
| 629 | | | | | Granted this |
|
| 630 | | | | | specific |
|
| 631 | | | | | Permission, and |
|
| 632 | | | | | the Permission is |
|
| 633 | | | | | valid |
|
| 634 | | | | | |
|
| 635 | | | | | for the User, it |
|
| 636 | | | | | will be included |
|
| 637 | | | | | in response |
|
| 638 | | | | | Permissions, along |
|
| 639 | | | | | with |
|
| 640 | | | | | |
|
| 641 | | | | | all the normal |
|
| 642 | | | | | permissions on the |
|
| 643 | | | | | 'GET' version of |
|
| 644 | | | | | this call. If it |
|
| 645 | | | | | is not |
|
| 646 | | | | | |
|
| 647 | | | | | valid, or Caller |
|
| 648 | | | | | does not have |
|
| 649 | | | | | permission to see, |
|
| 650 | | | | | it will be removed |
|
| 651 | | | | | from the list |
|
| 652 | | | | | |
|
| 653 | | | | | \*Note: This |
|
| 654 | | | | | design allows you |
|
| 655 | | | | | to make one call |
|
| 656 | | | | | for all expected |
|
| 657 | | | | | permissions |
|
| 658 | | | | | |
|
| 659 | | | | | The permission to |
|
| 660 | | | | | be included MUST |
|
| 661 | | | | | be: |
|
| 662 | | | | | |
|
| 663 | | | | | .access\|:[:key]\| |
|
| 664 | | | | | |
|
| 665 | | | | | examples: |
|
| 666 | | | | | |
|
| 667 | | | | | com.onap.myns.acces |
|
| 668 | | | | | s\|:ns\|write |
|
| 669 | | | | | |
|
| 670 | | | | | com.onap.myns.acces |
|
| 671 | | | | | s\|:role:myrole\|c |
|
| 672 | | | | | reate |
|
| 673 | | | | | |
|
| 674 | | | | | com.onap.myns.acces |
|
| 675 | | | | | s\|:perm:mytype:my |
|
| 676 | | | | | instance:myaction\ |
|
| 677 | | | | | |read |
|
| 678 | | | | | |
|
| 679 | | | | | -------------- |
|
| 680 | | | | | |
|
| 681 | | | | | Parameters |
|
| 682 | | | | | |
|
| 683 | | | | | user : string |
|
| 684 | | | | | (Required) |
|
| 685 | | | | | |
|
| 686 | | | | | Expected HTTP Code |
|
| 687 | | | | | |
|
| 688 | | | | | 200 |
|
| 689 | | | | | |
|
| 690 | | | | | Explicit HTTP |
|
| 691 | | | | | Error Codes |
|
| 692 | | | | | |
|
| 693 | | | | | 404, 406 |
|
| 694 | | | | | |
|
| 695 | | | | | ContentType: |
|
| 696 | | | | | |
|
| 697 | | | | | ` <./example/YXBwb |
|
| 698 | | | | | GljYXRpb24vUGVybXM |
|
| 699 | | | | | ranNvbjtxPTEuMDtja |
|
| 700 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 701 | | | | | lcnNpb249Mi4wLGFwc |
|
| 702 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 703 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 704 | | | | | j0yLjAsKi8qO3E9MS4 |
|
| 705 | | | | | w>`__\ application |
|
| 706 | | | | | /Perms+json;q=1.0; |
|
| 707 | | | | | charset=utf-8;vers |
|
| 708 | | | | | ion=2.0,applicatio |
|
| 709 | | | | | n/json;q=1.0;versi |
|
| 710 | | | | | on=2.0,\*/\*;q=1.0 |
|
| 711 | | | | | |
|
| 712 | | | | | ` <./example/YXBwb |
|
| 713 | | | | | GljYXRpb24vUGVybXM |
|
| 714 | | | | | reG1sO3E9MS4wO2NoY |
|
| 715 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 716 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 717 | | | | | C94bWw7cT0xLjA7dmV |
|
| 718 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 719 | | | | | application/Perms |
|
| 720 | | | | | +xml;q=1.0;charset |
|
| 721 | | | | | =utf-8;version=2.0 |
|
| 722 | | | | | ,text/xml;q=1.0;ve |
|
| 723 | | | | | rsion=2.0 |
|
| 724 | +--------------------+--------------------+--------------------+--------------------+
|
| 725 | | | GET | /authz/perms/user/ | Get Permissions by |
|
| 726 | | | | :user | User |
|
| 727 | | | | | |
|
| 728 | | | | | List All |
|
| 729 | | | | | Permissions that |
|
| 730 | | | | | match user :user |
|
| 731 | | | | | |
|
| 732 | | | | | 'user' must be |
|
| 733 | | | | | expressed as full |
|
| 734 | | | | | identity (ex: |
|
| 735 | | | | | id@full.domain.com |
|
| 736 | | | | | ) |
|
| 737 | | | | | |
|
| 738 | | | | | -------------- |
|
| 739 | | | | | |
|
| 740 | | | | | Parameters |
|
| 741 | | | | | |
|
| 742 | | | | | user : string |
|
| 743 | | | | | (Required) |
|
| 744 | | | | | |
|
| 745 | | | | | Expected HTTP Code |
|
| 746 | | | | | |
|
| 747 | | | | | 200 |
|
| 748 | | | | | |
|
| 749 | | | | | Explicit HTTP |
|
| 750 | | | | | Error Codes |
|
| 751 | | | | | |
|
| 752 | | | | | 404, 406 |
|
| 753 | | | | | |
|
| 754 | | | | | Accept: |
|
| 755 | | | | | |
|
| 756 | | | | | ` <./example/YXBwb |
|
| 757 | | | | | GljYXRpb24vUGVybXM |
|
| 758 | | | | | ranNvbjtxPTEuMDtja |
|
| 759 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 760 | | | | | lcnNpb249Mi4wLGFwc |
|
| 761 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 762 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 763 | | | | | j0yLjAsKi8qO3E9MC4 |
|
| 764 | | | | | y>`__\ application |
|
| 765 | | | | | /Perms+json;q=1.0; |
|
| 766 | | | | | charset=utf-8;vers |
|
| 767 | | | | | ion=2.0,applicatio |
|
| 768 | | | | | n/json;q=1.0;versi |
|
| 769 | | | | | on=2.0,\*/\*;q=0.2 |
|
| 770 | | | | | |
|
| 771 | | | | | ` <./example/YXBwb |
|
| 772 | | | | | GljYXRpb24vUGVybXM |
|
| 773 | | | | | reG1sO3E9MS4wO2NoY |
|
| 774 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 775 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 776 | | | | | C94bWw7cT0xLjA7dmV |
|
| 777 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 778 | | | | | application/Perms |
|
| 779 | | | | | +xml;q=1.0;charset |
|
| 780 | | | | | =utf-8;version=2.0 |
|
| 781 | | | | | ,text/xml;q=1.0;ve |
|
| 782 | | | | | rsion=2.0 |
|
| 783 | +--------------------+--------------------+--------------------+--------------------+
|
| 784 | | ROLE | POST | /authz/role | Create Role |
|
| 785 | | | | | |
|
| 786 | | | | | Roles are part of |
|
| 787 | | | | | Namespaces |
|
| 788 | | | | | |
|
| 789 | | | | | Examples: |
|
| 790 | | | | | |
|
| 791 | | | | | - com.onap.aaf - |
|
| 792 | | | | | The team that |
|
| 793 | | | | | created and |
|
| 794 | | | | | maintains AAF |
|
| 795 | | | | | - com.onap.csp - |
|
| 796 | | | | | The team that |
|
| 797 | | | | | created Global |
|
| 798 | | | | | Login |
|
| 799 | | | | | |
|
| 800 | | | | | Roles do not |
|
| 801 | | | | | include implied |
|
| 802 | | | | | permissions for an |
|
| 803 | | | | | App. Instead, they |
|
| 804 | | | | | contain explicit |
|
| 805 | | | | | Granted |
|
| 806 | | | | | Permissions by any |
|
| 807 | | | | | Namespace in AAF |
|
| 808 | | | | | (See Permissions) |
|
| 809 | | | | | |
|
| 810 | | | | | Restrictions on |
|
| 811 | | | | | Role Names: |
|
| 812 | | | | | |
|
| 813 | | | | | - Must start with |
|
| 814 | | | | | valid Namespace |
|
| 815 | | | | | name, |
|
| 816 | | | | | terminated by . |
|
| 817 | | | | | (dot/period) |
|
| 818 | | | | | - Allowed |
|
| 819 | | | | | Characters are |
|
| 820 | | | | | a-zA-Z0-9.\_- |
|
| 821 | | | | | - role names are |
|
| 822 | | | | | Case Sensitive |
|
| 823 | | | | | |
|
| 824 | | | | | The right |
|
| 825 | | | | | questions to ask |
|
| 826 | | | | | for defining and |
|
| 827 | | | | | populating a Role |
|
| 828 | | | | | in AAF, therefore, |
|
| 829 | | | | | are: |
|
| 830 | | | | | |
|
| 831 | | | | | - 'What Job |
|
| 832 | | | | | Function does |
|
| 833 | | | | | this |
|
| 834 | | | | | represent?' |
|
| 835 | | | | | - 'Does this |
|
| 836 | | | | | person perform |
|
| 837 | | | | | this Job |
|
| 838 | | | | | Function?' |
|
| 839 | | | | | |
|
| 840 | | | | | Expected HTTP Code |
|
| 841 | | | | | |
|
| 842 | | | | | 201 |
|
| 843 | | | | | |
|
| 844 | | | | | Explicit HTTP |
|
| 845 | | | | | Error Codes |
|
| 846 | | | | | |
|
| 847 | | | | | 403, 404, 406, 409 |
|
| 848 | | | | | |
|
| 849 | | | | | ContentType: |
|
| 850 | | | | | |
|
| 851 | | | | | ` <./example/YXBwb |
|
| 852 | | | | | GljYXRpb24vUm9sZVJ |
|
| 853 | | | | | lcXVlc3QranNvbjtxP |
|
| 854 | | | | | TEuMDtjaGFyc2V0PXV |
|
| 855 | | | | | 0Zi04O3ZlcnNpb249M |
|
| 856 | | | | | i4wLGFwcGxpY2F0aW9 |
|
| 857 | | | | | uL2pzb247cT0xLjA7d |
|
| 858 | | | | | mVyc2lvbj0yLjAsKi8 |
|
| 859 | | | | | qO3E9MS4w>`__\ app |
|
| 860 | | | | | lication/RoleReque |
|
| 861 | | | | | st+json;q=1.0;char |
|
| 862 | | | | | set=utf-8;version= |
|
| 863 | | | | | 2.0,application/js |
|
| 864 | | | | | on;q=1.0;version=2 |
|
| 865 | | | | | .0,\*/\*;q=1.0 |
|
| 866 | | | | | |
|
| 867 | | | | | ` <./example/YXBwb |
|
| 868 | | | | | GljYXRpb24vUm9sZVJ |
|
| 869 | | | | | lcXVlc3QreG1sO3E9M |
|
| 870 | | | | | S4wO2NoYXJzZXQ9dXR |
|
| 871 | | | | | mLTg7dmVyc2lvbj0yL |
|
| 872 | | | | | jAsdGV4dC94bWw7cT0 |
|
| 873 | | | | | xLjA7dmVyc2lvbj0yL |
|
| 874 | | | | | jA=>`__\ applicati |
|
| 875 | | | | | on/RoleRequest+xml |
|
| 876 | | | | | ;q=1.0;charset=utf |
|
| 877 | | | | | -8;version=2.0,tex |
|
| 878 | | | | | t/xml;q=1.0;versio |
|
| 879 | | | | | n=2.0 |
|
| 880 | +--------------------+--------------------+--------------------+--------------------+
|
| 881 | | | PUT | /authz/role | Set Description |
|
| 882 | | | | | for role |
|
| 883 | | | | | |
|
| 884 | | | | | Add Description |
|
| 885 | | | | | Data to a Role |
|
| 886 | | | | | |
|
| 887 | | | | | Expected HTTP Code |
|
| 888 | | | | | |
|
| 889 | | | | | 200 |
|
| 890 | | | | | |
|
| 891 | | | | | Explicit HTTP |
|
| 892 | | | | | Error Codes |
|
| 893 | | | | | |
|
| 894 | | | | | 404, 406 |
|
| 895 | | | | | |
|
| 896 | | | | | ContentType: |
|
| 897 | | | | | |
|
| 898 | | | | | ` <./example/YXBwb |
|
| 899 | | | | | GljYXRpb24vUm9sZVJ |
|
| 900 | | | | | lcXVlc3QranNvbjtxP |
|
| 901 | | | | | TEuMDtjaGFyc2V0PXV |
|
| 902 | | | | | 0Zi04O3ZlcnNpb249M |
|
| 903 | | | | | i4wLGFwcGxpY2F0aW9 |
|
| 904 | | | | | uL2pzb247cT0xLjA7d |
|
| 905 | | | | | mVyc2lvbj0yLjAsKi8 |
|
| 906 | | | | | qO3E9MS4w>`__\ app |
|
| 907 | | | | | lication/RoleReque |
|
| 908 | | | | | st+json;q=1.0;char |
|
| 909 | | | | | set=utf-8;version= |
|
| 910 | | | | | 2.0,application/js |
|
| 911 | | | | | on;q=1.0;version=2 |
|
| 912 | | | | | .0,\*/\*;q=1.0 |
|
| 913 | | | | | |
|
| 914 | | | | | ` <./example/YXBwb |
|
| 915 | | | | | GljYXRpb24vUm9sZVJ |
|
| 916 | | | | | lcXVlc3QreG1sO3E9M |
|
| 917 | | | | | S4wO2NoYXJzZXQ9dXR |
|
| 918 | | | | | mLTg7dmVyc2lvbj0yL |
|
| 919 | | | | | jAsdGV4dC94bWw7cT0 |
|
| 920 | | | | | xLjA7dmVyc2lvbj0yL |
|
| 921 | | | | | jA=>`__\ applicati |
|
| 922 | | | | | on/RoleRequest+xml |
|
| 923 | | | | | ;q=1.0;charset=utf |
|
| 924 | | | | | -8;version=2.0,tex |
|
| 925 | | | | | t/xml;q=1.0;versio |
|
| 926 | | | | | n=2.0 |
|
| 927 | +--------------------+--------------------+--------------------+--------------------+
|
| 928 | | | DELETE | /authz/role | Delete Role |
|
| 929 | | | | | |
|
| 930 | | | | | Delete the Role |
|
| 931 | | | | | referenced by |
|
| 932 | | | | | RoleKey |
|
| 933 | | | | | |
|
| 934 | | | | | You cannot |
|
| 935 | | | | | normally delete a |
|
| 936 | | | | | role which still |
|
| 937 | | | | | has permissions |
|
| 938 | | | | | granted or users |
|
| 939 | | | | | assigned to it, |
|
| 940 | | | | | |
|
| 941 | | | | | however the |
|
| 942 | | | | | "force" property |
|
| 943 | | | | | allows you to do |
|
| 944 | | | | | just that. To do |
|
| 945 | | | | | this: Add |
|
| 946 | | | | | 'force=true' |
|
| 947 | | | | | |
|
| 948 | | | | | as a query |
|
| 949 | | | | | parameter. |
|
| 950 | | | | | |
|
| 951 | | | | | WARNING: Using |
|
| 952 | | | | | force will remove |
|
| 953 | | | | | all users and |
|
| 954 | | | | | permission from |
|
| 955 | | | | | this role. Use |
|
| 956 | | | | | with care. |
|
| 957 | | | | | |
|
| 958 | | | | | Expected HTTP Code |
|
| 959 | | | | | |
|
| 960 | | | | | 200 |
|
| 961 | | | | | |
|
| 962 | | | | | Explicit HTTP |
|
| 963 | | | | | Error Codes |
|
| 964 | | | | | |
|
| 965 | | | | | 404, 406 |
|
| 966 | | | | | |
|
| 967 | | | | | ContentType: |
|
| 968 | | | | | |
|
| 969 | | | | | ` <./example/YXBwb |
|
| 970 | | | | | GljYXRpb24vUm9sZVJ |
|
| 971 | | | | | lcXVlc3QranNvbjtxP |
|
| 972 | | | | | TEuMDtjaGFyc2V0PXV |
|
| 973 | | | | | 0Zi04O3ZlcnNpb249M |
|
| 974 | | | | | i4wLGFwcGxpY2F0aW9 |
|
| 975 | | | | | uL2pzb247cT0xLjA7d |
|
| 976 | | | | | mVyc2lvbj0yLjAsKi8 |
|
| 977 | | | | | qO3E9MS4w>`__\ app |
|
| 978 | | | | | lication/RoleReque |
|
| 979 | | | | | st+json;q=1.0;char |
|
| 980 | | | | | set=utf-8;version= |
|
| 981 | | | | | 2.0,application/js |
|
| 982 | | | | | on;q=1.0;version=2 |
|
| 983 | | | | | .0,\*/\*;q=1.0 |
|
| 984 | | | | | |
|
| 985 | | | | | ` <./example/YXBwb |
|
| 986 | | | | | GljYXRpb24vUm9sZVJ |
|
| 987 | | | | | lcXVlc3QreG1sO3E9M |
|
| 988 | | | | | S4wO2NoYXJzZXQ9dXR |
|
| 989 | | | | | mLTg7dmVyc2lvbj0yL |
|
| 990 | | | | | jAsdGV4dC94bWw7cT0 |
|
| 991 | | | | | xLjA7dmVyc2lvbj0yL |
|
| 992 | | | | | jA=>`__\ applicati |
|
| 993 | | | | | on/RoleRequest+xml |
|
| 994 | | | | | ;q=1.0;charset=utf |
|
| 995 | | | | | -8;version=2.0,tex |
|
| 996 | | | | | t/xml;q=1.0;versio |
|
| 997 | | | | | n=2.0 |
|
| 998 | +--------------------+--------------------+--------------------+--------------------+
|
| 999 | | | DELETE | /authz/role/:role | Delete Role |
|
| 1000 | | | | | |
|
| 1001 | | | | | Delete the Role |
|
| 1002 | | | | | named :role |
|
| 1003 | | | | | |
|
| 1004 | | | | | -------------- |
|
| 1005 | | | | | |
|
| 1006 | | | | | Parameters |
|
| 1007 | | | | | |
|
| 1008 | | | | | role : string |
|
| 1009 | | | | | (Required) |
|
| 1010 | | | | | |
|
| 1011 | | | | | Expected HTTP Code |
|
| 1012 | | | | | |
|
| 1013 | | | | | 200 |
|
| 1014 | | | | | |
|
| 1015 | | | | | Explicit HTTP |
|
| 1016 | | | | | Error Codes |
|
| 1017 | | | | | |
|
| 1018 | | | | | 404, 406 |
|
| 1019 | | | | | |
|
| 1020 | | | | | ContentType: |
|
| 1021 | | | | | |
|
| 1022 | | | | | ` <./example/YXBwb |
|
| 1023 | | | | | GljYXRpb24vUm9sZSt |
|
| 1024 | | | | | qc29uO3E9MS4wO2NoY |
|
| 1025 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 1026 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 1027 | | | | | GljYXRpb24vanNvbjt |
|
| 1028 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 1029 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 1030 | | | | | =>`__\ application |
|
| 1031 | | | | | /Role+json;q=1.0;c |
|
| 1032 | | | | | harset=utf-8;versi |
|
| 1033 | | | | | on=2.0,application |
|
| 1034 | | | | | /json;q=1.0;versio |
|
| 1035 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 1036 | | | | | |
|
| 1037 | | | | | ` <./example/YXBwb |
|
| 1038 | | | | | GljYXRpb24vUm9sZSt |
|
| 1039 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 1040 | | | | | nNldD11dGYtODt2ZXJ |
|
| 1041 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 1042 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 1043 | | | | | zaW9uPTIuMA==>`__\ |
|
| 1044 | | | | | application/Role+ |
|
| 1045 | | | | | xml;q=1.0;charset= |
|
| 1046 | | | | | utf-8;version=2.0, |
|
| 1047 | | | | | text/xml;q=1.0;ver |
|
| 1048 | | | | | sion=2.0 |
|
| 1049 | +--------------------+--------------------+--------------------+--------------------+
|
| 1050 | | | DELETE | /authz/role/:role/ | Delete Permission |
|
| 1051 | | | | perm | from Role |
|
| 1052 | | | | | |
|
| 1053 | | | | | Ungrant a |
|
| 1054 | | | | | permission from |
|
| 1055 | | | | | Role :role |
|
| 1056 | | | | | |
|
| 1057 | | | | | -------------- |
|
| 1058 | | | | | |
|
| 1059 | | | | | Parameters |
|
| 1060 | | | | | |
|
| 1061 | | | | | role : string |
|
| 1062 | | | | | (Required) |
|
| 1063 | | | | | |
|
| 1064 | | | | | Expected HTTP Code |
|
| 1065 | | | | | |
|
| 1066 | | | | | 200 |
|
| 1067 | | | | | |
|
| 1068 | | | | | Explicit HTTP |
|
| 1069 | | | | | Error Codes |
|
| 1070 | | | | | |
|
| 1071 | | | | | 404, 406 |
|
| 1072 | | | | | |
|
| 1073 | | | | | ContentType: |
|
| 1074 | | | | | |
|
| 1075 | | | | | ` <./example/YXBwb |
|
| 1076 | | | | | GljYXRpb24vUm9sZVB |
|
| 1077 | | | | | lcm1SZXF1ZXN0K2pzb |
|
| 1078 | | | | | 247cT0xLjA7Y2hhcnN |
|
| 1079 | | | | | ldD11dGYtODt2ZXJza |
|
| 1080 | | | | | W9uPTIuMCxhcHBsaWN |
|
| 1081 | | | | | hdGlvbi9qc29uO3E9M |
|
| 1082 | | | | | S4wO3ZlcnNpb249Mi4 |
|
| 1083 | | | | | wLCovKjtxPTEuMA==> |
|
| 1084 | | | | | `__\ application/R |
|
| 1085 | | | | | olePermRequest+jso |
|
| 1086 | | | | | n;q=1.0;charset=ut |
|
| 1087 | | | | | f-8;version=2.0,ap |
|
| 1088 | | | | | plication/json;q=1 |
|
| 1089 | | | | | .0;version=2.0,\*/ |
|
| 1090 | | | | | \*;q=1.0 |
|
| 1091 | | | | | |
|
| 1092 | | | | | ` <./example/YXBwb |
|
| 1093 | | | | | GljYXRpb24vUm9sZVB |
|
| 1094 | | | | | lcm1SZXF1ZXN0K3htb |
|
| 1095 | | | | | DtxPTEuMDtjaGFyc2V |
|
| 1096 | | | | | 0PXV0Zi04O3ZlcnNpb |
|
| 1097 | | | | | 249Mi4wLHRleHQveG1 |
|
| 1098 | | | | | sO3E9MS4wO3ZlcnNpb |
|
| 1099 | | | | | 249Mi4w>`__\ appli |
|
| 1100 | | | | | cation/RolePermReq |
|
| 1101 | | | | | uest+xml;q=1.0;cha |
|
| 1102 | | | | | rset=utf-8;version |
|
| 1103 | | | | | =2.0,text/xml;q=1. |
|
| 1104 | | | | | 0;version=2.0 |
|
| 1105 | +--------------------+--------------------+--------------------+--------------------+
|
| 1106 | | | POST | /authz/role/perm | Add Permission to |
|
| 1107 | | | | | Role |
|
| 1108 | | | | | |
|
| 1109 | | | | | Grant a Permission |
|
| 1110 | | | | | to a Role |
|
| 1111 | | | | | |
|
| 1112 | | | | | Permission |
|
| 1113 | | | | | consists of: |
|
| 1114 | | | | | |
|
| 1115 | | | | | - type - a |
|
| 1116 | | | | | Namespace |
|
| 1117 | | | | | qualified |
|
| 1118 | | | | | identifier |
|
| 1119 | | | | | specifying what |
|
| 1120 | | | | | kind of |
|
| 1121 | | | | | resource is |
|
| 1122 | | | | | being protected |
|
| 1123 | | | | | - instance - a |
|
| 1124 | | | | | key, possibly |
|
| 1125 | | | | | multi-dimension |
|
| 1126 | | | | | al, |
|
| 1127 | | | | | that identifies |
|
| 1128 | | | | | a specific |
|
| 1129 | | | | | instance of the |
|
| 1130 | | | | | type |
|
| 1131 | | | | | - action - what |
|
| 1132 | | | | | kind of action |
|
| 1133 | | | | | is allowed |
|
| 1134 | | | | | |
|
| 1135 | | | | | Note: instance and |
|
| 1136 | | | | | action can be an |
|
| 1137 | | | | | \* |
|
| 1138 | | | | | |
|
| 1139 | | | | | Note: Using the |
|
| 1140 | | | | | "force" property |
|
| 1141 | | | | | will create the |
|
| 1142 | | | | | Permission, if it |
|
| 1143 | | | | | doesn't exist AND |
|
| 1144 | | | | | the requesting ID |
|
| 1145 | | | | | is allowed to |
|
| 1146 | | | | | create. It will |
|
| 1147 | | | | | then grant |
|
| 1148 | | | | | |
|
| 1149 | | | | | the permission to |
|
| 1150 | | | | | the role in one |
|
| 1151 | | | | | step. To do this: |
|
| 1152 | | | | | add 'force=true' |
|
| 1153 | | | | | as a query |
|
| 1154 | | | | | parameter. |
|
| 1155 | | | | | |
|
| 1156 | | | | | Expected HTTP Code |
|
| 1157 | | | | | |
|
| 1158 | | | | | 201 |
|
| 1159 | | | | | |
|
| 1160 | | | | | Explicit HTTP |
|
| 1161 | | | | | Error Codes |
|
| 1162 | | | | | |
|
| 1163 | | | | | 403, 404, 406, 409 |
|
| 1164 | | | | | |
|
| 1165 | | | | | ContentType: |
|
| 1166 | | | | | |
|
| 1167 | | | | | ` <./example/YXBwb |
|
| 1168 | | | | | GljYXRpb24vUm9sZVB |
|
| 1169 | | | | | lcm1SZXF1ZXN0K2pzb |
|
| 1170 | | | | | 247cT0xLjA7Y2hhcnN |
|
| 1171 | | | | | ldD11dGYtODt2ZXJza |
|
| 1172 | | | | | W9uPTIuMCxhcHBsaWN |
|
| 1173 | | | | | hdGlvbi9qc29uO3E9M |
|
| 1174 | | | | | S4wO3ZlcnNpb249Mi4 |
|
| 1175 | | | | | wLCovKjtxPTEuMA==> |
|
| 1176 | | | | | `__\ application/R |
|
| 1177 | | | | | olePermRequest+jso |
|
| 1178 | | | | | n;q=1.0;charset=ut |
|
| 1179 | | | | | f-8;version=2.0,ap |
|
| 1180 | | | | | plication/json;q=1 |
|
| 1181 | | | | | .0;version=2.0,\*/ |
|
| 1182 | | | | | \*;q=1.0 |
|
| 1183 | | | | | |
|
| 1184 | | | | | ` <./example/YXBwb |
|
| 1185 | | | | | GljYXRpb24vUm9sZVB |
|
| 1186 | | | | | lcm1SZXF1ZXN0K3htb |
|
| 1187 | | | | | DtxPTEuMDtjaGFyc2V |
|
| 1188 | | | | | 0PXV0Zi04O3ZlcnNpb |
|
| 1189 | | | | | 249Mi4wLHRleHQveG1 |
|
| 1190 | | | | | sO3E9MS4wO3ZlcnNpb |
|
| 1191 | | | | | 249Mi4w>`__\ appli |
|
| 1192 | | | | | cation/RolePermReq |
|
| 1193 | | | | | uest+xml;q=1.0;cha |
|
| 1194 | | | | | rset=utf-8;version |
|
| 1195 | | | | | =2.0,text/xml;q=1. |
|
| 1196 | | | | | 0;version=2.0 |
|
| 1197 | +--------------------+--------------------+--------------------+--------------------+
|
| 1198 | | | PUT | /authz/role/perm | Set a Permission's |
|
| 1199 | | | | | Roles |
|
| 1200 | | | | | |
|
| 1201 | | | | | Set a permission's |
|
| 1202 | | | | | roles to roles |
|
| 1203 | | | | | given |
|
| 1204 | | | | | |
|
| 1205 | | | | | Expected HTTP Code |
|
| 1206 | | | | | |
|
| 1207 | | | | | 201 |
|
| 1208 | | | | | |
|
| 1209 | | | | | Explicit HTTP |
|
| 1210 | | | | | Error Codes |
|
| 1211 | | | | | |
|
| 1212 | | | | | 403, 404, 406, 409 |
|
| 1213 | | | | | |
|
| 1214 | | | | | ContentType: |
|
| 1215 | | | | | |
|
| 1216 | | | | | ` <./example/YXBwb |
|
| 1217 | | | | | GljYXRpb24vUm9sZVB |
|
| 1218 | | | | | lcm1SZXF1ZXN0K2pzb |
|
| 1219 | | | | | 247cT0xLjA7Y2hhcnN |
|
| 1220 | | | | | ldD11dGYtODt2ZXJza |
|
| 1221 | | | | | W9uPTIuMCxhcHBsaWN |
|
| 1222 | | | | | hdGlvbi9qc29uO3E9M |
|
| 1223 | | | | | S4wO3ZlcnNpb249Mi4 |
|
| 1224 | | | | | wLCovKjtxPTEuMA==> |
|
| 1225 | | | | | `__\ application/R |
|
| 1226 | | | | | olePermRequest+jso |
|
| 1227 | | | | | n;q=1.0;charset=ut |
|
| 1228 | | | | | f-8;version=2.0,ap |
|
| 1229 | | | | | plication/json;q=1 |
|
| 1230 | | | | | .0;version=2.0,\*/ |
|
| 1231 | | | | | \*;q=1.0 |
|
| 1232 | | | | | |
|
| 1233 | | | | | ` <./example/YXBwb |
|
| 1234 | | | | | GljYXRpb24vUm9sZVB |
|
| 1235 | | | | | lcm1SZXF1ZXN0K3htb |
|
| 1236 | | | | | DtxPTEuMDtjaGFyc2V |
|
| 1237 | | | | | 0PXV0Zi04O3ZlcnNpb |
|
| 1238 | | | | | 249Mi4wLHRleHQveG1 |
|
| 1239 | | | | | sO3E9MS4wO3ZlcnNpb |
|
| 1240 | | | | | 249Mi4w>`__\ appli |
|
| 1241 | | | | | cation/RolePermReq |
|
| 1242 | | | | | uest+xml;q=1.0;cha |
|
| 1243 | | | | | rset=utf-8;version |
|
| 1244 | | | | | =2.0,text/xml;q=1. |
|
| 1245 | | | | | 0;version=2.0 |
|
| 1246 | +--------------------+--------------------+--------------------+--------------------+
|
| 1247 | | | GET | /authz/roles/:role | GetRolesByFullName |
|
| 1248 | | | | | |
|
| 1249 | | | | | List Roles that |
|
| 1250 | | | | | match :role |
|
| 1251 | | | | | |
|
| 1252 | | | | | Note: You must |
|
| 1253 | | | | | have permission to |
|
| 1254 | | | | | see any given role |
|
| 1255 | | | | | |
|
| 1256 | | | | | -------------- |
|
| 1257 | | | | | |
|
| 1258 | | | | | Parameters |
|
| 1259 | | | | | |
|
| 1260 | | | | | role : string |
|
| 1261 | | | | | (Required) |
|
| 1262 | | | | | |
|
| 1263 | | | | | Expected HTTP Code |
|
| 1264 | | | | | |
|
| 1265 | | | | | 200 |
|
| 1266 | | | | | |
|
| 1267 | | | | | Explicit HTTP |
|
| 1268 | | | | | Error Codes |
|
| 1269 | | | | | |
|
| 1270 | | | | | 404, 406 |
|
| 1271 | | | | | |
|
| 1272 | | | | | Accept: |
|
| 1273 | | | | | |
|
| 1274 | | | | | ` <./example/YXBwb |
|
| 1275 | | | | | GljYXRpb24vUm9sZXM |
|
| 1276 | | | | | ranNvbjtxPTEuMDtja |
|
| 1277 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 1278 | | | | | lcnNpb249Mi4wLGFwc |
|
| 1279 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 1280 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 1281 | | | | | j0yLjAsKi8qO3E9MS4 |
|
| 1282 | | | | | w>`__\ application |
|
| 1283 | | | | | /Roles+json;q=1.0; |
|
| 1284 | | | | | charset=utf-8;vers |
|
| 1285 | | | | | ion=2.0,applicatio |
|
| 1286 | | | | | n/json;q=1.0;versi |
|
| 1287 | | | | | on=2.0,\*/\*;q=1.0 |
|
| 1288 | | | | | |
|
| 1289 | | | | | ` <./example/YXBwb |
|
| 1290 | | | | | GljYXRpb24vUm9sZXM |
|
| 1291 | | | | | reG1sO3E9MS4wO2NoY |
|
| 1292 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 1293 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 1294 | | | | | C94bWw7cT0xLjA7dmV |
|
| 1295 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 1296 | | | | | application/Roles |
|
| 1297 | | | | | +xml;q=1.0;charset |
|
| 1298 | | | | | =utf-8;version=2.0 |
|
| 1299 | | | | | ,text/xml;q=1.0;ve |
|
| 1300 | | | | | rsion=2.0 |
|
| 1301 | +--------------------+--------------------+--------------------+--------------------+
|
| 1302 | | | GET | /authz/roles/name/ | GetRolesByNameOnly |
|
| 1303 | | | | :name | |
|
| 1304 | | | | | List all Roles for |
|
| 1305 | | | | | only the Name of |
|
| 1306 | | | | | Role (without |
|
| 1307 | | | | | Namespace) |
|
| 1308 | | | | | |
|
| 1309 | | | | | Note: You must |
|
| 1310 | | | | | have permission to |
|
| 1311 | | | | | see any given role |
|
| 1312 | | | | | |
|
| 1313 | | | | | -------------- |
|
| 1314 | | | | | |
|
| 1315 | | | | | Parameters |
|
| 1316 | | | | | |
|
| 1317 | | | | | name : string |
|
| 1318 | | | | | (Required) |
|
| 1319 | | | | | |
|
| 1320 | | | | | Expected HTTP Code |
|
| 1321 | | | | | |
|
| 1322 | | | | | 200 |
|
| 1323 | | | | | |
|
| 1324 | | | | | Explicit HTTP |
|
| 1325 | | | | | Error Codes |
|
| 1326 | | | | | |
|
| 1327 | | | | | 404, 406 |
|
| 1328 | | | | | |
|
| 1329 | | | | | Accept: |
|
| 1330 | | | | | |
|
| 1331 | | | | | ` <./example/YXBwb |
|
| 1332 | | | | | GljYXRpb24vUm9sZXM |
|
| 1333 | | | | | ranNvbjtxPTEuMDtja |
|
| 1334 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 1335 | | | | | lcnNpb249Mi4wLGFwc |
|
| 1336 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 1337 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 1338 | | | | | j0yLjAsKi8qO3E9MS4 |
|
| 1339 | | | | | w>`__\ application |
|
| 1340 | | | | | /Roles+json;q=1.0; |
|
| 1341 | | | | | charset=utf-8;vers |
|
| 1342 | | | | | ion=2.0,applicatio |
|
| 1343 | | | | | n/json;q=1.0;versi |
|
| 1344 | | | | | on=2.0,\*/\*;q=1.0 |
|
| 1345 | | | | | |
|
| 1346 | | | | | ` <./example/YXBwb |
|
| 1347 | | | | | GljYXRpb24vUm9sZXM |
|
| 1348 | | | | | reG1sO3E9MS4wO2NoY |
|
| 1349 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 1350 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 1351 | | | | | C94bWw7cT0xLjA7dmV |
|
| 1352 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 1353 | | | | | application/Roles |
|
| 1354 | | | | | +xml;q=1.0;charset |
|
| 1355 | | | | | =utf-8;version=2.0 |
|
| 1356 | | | | | ,text/xml;q=1.0;ve |
|
| 1357 | | | | | rsion=2.0 |
|
| 1358 | +--------------------+--------------------+--------------------+--------------------+
|
| 1359 | | | GET | /authz/roles/ns/:n | GetRolesByNS |
|
| 1360 | | | | s | |
|
| 1361 | | | | | List all Roles for |
|
| 1362 | | | | | the Namespace :ns |
|
| 1363 | | | | | |
|
| 1364 | | | | | Note: You must |
|
| 1365 | | | | | have permission to |
|
| 1366 | | | | | see any given role |
|
| 1367 | | | | | |
|
| 1368 | | | | | -------------- |
|
| 1369 | | | | | |
|
| 1370 | | | | | Parameters |
|
| 1371 | | | | | |
|
| 1372 | | | | | ns : string |
|
| 1373 | | | | | (Required) |
|
| 1374 | | | | | |
|
| 1375 | | | | | Expected HTTP Code |
|
| 1376 | | | | | |
|
| 1377 | | | | | 200 |
|
| 1378 | | | | | |
|
| 1379 | | | | | Explicit HTTP |
|
| 1380 | | | | | Error Codes |
|
| 1381 | | | | | |
|
| 1382 | | | | | 404, 406 |
|
| 1383 | | | | | |
|
| 1384 | | | | | Accept: |
|
| 1385 | | | | | |
|
| 1386 | | | | | ` <./example/YXBwb |
|
| 1387 | | | | | GljYXRpb24vUm9sZXM |
|
| 1388 | | | | | ranNvbjtxPTEuMDtja |
|
| 1389 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 1390 | | | | | lcnNpb249Mi4wLGFwc |
|
| 1391 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 1392 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 1393 | | | | | j0yLjAsKi8qO3E9MC4 |
|
| 1394 | | | | | y>`__\ application |
|
| 1395 | | | | | /Roles+json;q=1.0; |
|
| 1396 | | | | | charset=utf-8;vers |
|
| 1397 | | | | | ion=2.0,applicatio |
|
| 1398 | | | | | n/json;q=1.0;versi |
|
| 1399 | | | | | on=2.0,\*/\*;q=0.2 |
|
| 1400 | | | | | |
|
| 1401 | | | | | ` <./example/YXBwb |
|
| 1402 | | | | | GljYXRpb24vUm9sZXM |
|
| 1403 | | | | | reG1sO3E9MS4wO2NoY |
|
| 1404 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 1405 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 1406 | | | | | C94bWw7cT0xLjA7dmV |
|
| 1407 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 1408 | | | | | application/Roles |
|
| 1409 | | | | | +xml;q=1.0;charset |
|
| 1410 | | | | | =utf-8;version=2.0 |
|
| 1411 | | | | | ,text/xml;q=1.0;ve |
|
| 1412 | | | | | rsion=2.0 |
|
| 1413 | +--------------------+--------------------+--------------------+--------------------+
|
| 1414 | | | GET | /authz/roles/perm/ | GetRolesByPerm |
|
| 1415 | | | | :type/:instance/:a | |
|
| 1416 | | | | ction | Find all Roles |
|
| 1417 | | | | | containing the |
|
| 1418 | | | | | given |
|
| 1419 | | | | | Permission.Permiss |
|
| 1420 | | | | | ion |
|
| 1421 | | | | | consists of: |
|
| 1422 | | | | | |
|
| 1423 | | | | | - type - a |
|
| 1424 | | | | | Namespace |
|
| 1425 | | | | | qualified |
|
| 1426 | | | | | identifier |
|
| 1427 | | | | | specifying what |
|
| 1428 | | | | | kind of |
|
| 1429 | | | | | resource is |
|
| 1430 | | | | | being protected |
|
| 1431 | | | | | - instance - a |
|
| 1432 | | | | | key, possibly |
|
| 1433 | | | | | multi-dimension |
|
| 1434 | | | | | al, |
|
| 1435 | | | | | that identifies |
|
| 1436 | | | | | a specific |
|
| 1437 | | | | | instance of the |
|
| 1438 | | | | | type |
|
| 1439 | | | | | - action - what |
|
| 1440 | | | | | kind of action |
|
| 1441 | | | | | is allowed |
|
| 1442 | | | | | |
|
| 1443 | | | | | Notes: instance |
|
| 1444 | | | | | and action can be |
|
| 1445 | | | | | an \* |
|
| 1446 | | | | | |
|
| 1447 | | | | | You must have |
|
| 1448 | | | | | permission to see |
|
| 1449 | | | | | any given role |
|
| 1450 | | | | | |
|
| 1451 | | | | | -------------- |
|
| 1452 | | | | | |
|
| 1453 | | | | | Parameters |
|
| 1454 | | | | | |
|
| 1455 | | | | | type : string |
|
| 1456 | | | | | (Required) |
|
| 1457 | | | | | |
|
| 1458 | | | | | instance : string |
|
| 1459 | | | | | (Required) |
|
| 1460 | | | | | |
|
| 1461 | | | | | action : string |
|
| 1462 | | | | | (Required) |
|
| 1463 | | | | | |
|
| 1464 | | | | | Expected HTTP Code |
|
| 1465 | | | | | |
|
| 1466 | | | | | 200 |
|
| 1467 | | | | | |
|
| 1468 | | | | | Explicit HTTP |
|
| 1469 | | | | | Error Codes |
|
| 1470 | | | | | |
|
| 1471 | | | | | 404, 406 |
|
| 1472 | | | | | |
|
| 1473 | | | | | Accept: |
|
| 1474 | | | | | |
|
| 1475 | | | | | ` <./example/YXBwb |
|
| 1476 | | | | | GljYXRpb24vUm9sZXM |
|
| 1477 | | | | | ranNvbjtxPTEuMDtja |
|
| 1478 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 1479 | | | | | lcnNpb249Mi4wLGFwc |
|
| 1480 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 1481 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 1482 | | | | | j0yLjAsKi8qO3E9MS4 |
|
| 1483 | | | | | w>`__\ application |
|
| 1484 | | | | | /Roles+json;q=1.0; |
|
| 1485 | | | | | charset=utf-8;vers |
|
| 1486 | | | | | ion=2.0,applicatio |
|
| 1487 | | | | | n/json;q=1.0;versi |
|
| 1488 | | | | | on=2.0,\*/\*;q=1.0 |
|
| 1489 | | | | | |
|
| 1490 | | | | | ` <./example/YXBwb |
|
| 1491 | | | | | GljYXRpb24vUm9sZXM |
|
| 1492 | | | | | reG1sO3E9MS4wO2NoY |
|
| 1493 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 1494 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 1495 | | | | | C94bWw7cT0xLjA7dmV |
|
| 1496 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 1497 | | | | | application/Roles |
|
| 1498 | | | | | +xml;q=1.0;charset |
|
| 1499 | | | | | =utf-8;version=2.0 |
|
| 1500 | | | | | ,text/xml;q=1.0;ve |
|
| 1501 | | | | | rsion=2.0 |
|
| 1502 | +--------------------+--------------------+--------------------+--------------------+
|
| 1503 | | | GET | /authz/roles/user/ | GetRolesByUser |
|
| 1504 | | | | :name | |
|
| 1505 | | | | | List all Roles |
|
| 1506 | | | | | that match user |
|
| 1507 | | | | | :name |
|
| 1508 | | | | | |
|
| 1509 | | | | | 'user' must be |
|
| 1510 | | | | | expressed as full |
|
| 1511 | | | | | identity (ex: |
|
| 1512 | | | | | id@full.domain.com |
|
| 1513 | | | | | ) |
|
| 1514 | | | | | |
|
| 1515 | | | | | Note: You must |
|
| 1516 | | | | | have permission to |
|
| 1517 | | | | | see any given role |
|
| 1518 | | | | | |
|
| 1519 | | | | | -------------- |
|
| 1520 | | | | | |
|
| 1521 | | | | | Parameters |
|
| 1522 | | | | | |
|
| 1523 | | | | | name : string |
|
| 1524 | | | | | (Required) |
|
| 1525 | | | | | |
|
| 1526 | | | | | Expected HTTP Code |
|
| 1527 | | | | | |
|
| 1528 | | | | | 200 |
|
| 1529 | | | | | |
|
| 1530 | | | | | Explicit HTTP |
|
| 1531 | | | | | Error Codes |
|
| 1532 | | | | | |
|
| 1533 | | | | | 404, 406 |
|
| 1534 | | | | | |
|
| 1535 | | | | | Accept: |
|
| 1536 | | | | | |
|
| 1537 | | | | | ` <./example/YXBwb |
|
| 1538 | | | | | GljYXRpb24vUm9sZXM |
|
| 1539 | | | | | ranNvbjtxPTEuMDtja |
|
| 1540 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 1541 | | | | | lcnNpb249Mi4wLGFwc |
|
| 1542 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 1543 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 1544 | | | | | j0yLjAsKi8qO3E9MS4 |
|
| 1545 | | | | | w>`__\ application |
|
| 1546 | | | | | /Roles+json;q=1.0; |
|
| 1547 | | | | | charset=utf-8;vers |
|
| 1548 | | | | | ion=2.0,applicatio |
|
| 1549 | | | | | n/json;q=1.0;versi |
|
| 1550 | | | | | on=2.0,\*/\*;q=1.0 |
|
| 1551 | | | | | |
|
| 1552 | | | | | ` <./example/YXBwb |
|
| 1553 | | | | | GljYXRpb24vUm9sZXM |
|
| 1554 | | | | | reG1sO3E9MS4wO2NoY |
|
| 1555 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 1556 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 1557 | | | | | C94bWw7cT0xLjA7dmV |
|
| 1558 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 1559 | | | | | application/Roles |
|
| 1560 | | | | | +xml;q=1.0;charset |
|
| 1561 | | | | | =utf-8;version=2.0 |
|
| 1562 | | | | | ,text/xml;q=1.0;ve |
|
| 1563 | | | | | rsion=2.0 |
|
| 1564 | +--------------------+--------------------+--------------------+--------------------+
|
| 1565 | | | POST | /authz/userRole | Request User Role |
|
| 1566 | | | | | Access |
|
| 1567 | | | | | |
|
| 1568 | | | | | Create a UserRole |
|
| 1569 | | | | | relationship (add |
|
| 1570 | | | | | User to Role) |
|
| 1571 | | | | | |
|
| 1572 | | | | | A UserRole is an |
|
| 1573 | | | | | object |
|
| 1574 | | | | | Representation of |
|
| 1575 | | | | | membership of a |
|
| 1576 | | | | | Role for limited |
|
| 1577 | | | | | time. |
|
| 1578 | | | | | |
|
| 1579 | | | | | If a shorter |
|
| 1580 | | | | | amount of time for |
|
| 1581 | | | | | Role ownership is |
|
| 1582 | | | | | required, use the |
|
| 1583 | | | | | 'End' field. |
|
| 1584 | | | | | |
|
| 1585 | | | | | \*\* Note: Owners |
|
| 1586 | | | | | of Namespaces will |
|
| 1587 | | | | | be required to |
|
| 1588 | | | | | revalidate users |
|
| 1589 | | | | | in these roles |
|
| 1590 | | | | | |
|
| 1591 | | | | | before Expirations |
|
| 1592 | | | | | expire. Namespace |
|
| 1593 | | | | | owners will be |
|
| 1594 | | | | | notified by email. |
|
| 1595 | | | | | |
|
| 1596 | | | | | Expected HTTP Code |
|
| 1597 | | | | | |
|
| 1598 | | | | | 201 |
|
| 1599 | | | | | |
|
| 1600 | | | | | Explicit HTTP |
|
| 1601 | | | | | Error Codes |
|
| 1602 | | | | | |
|
| 1603 | | | | | 403, 404, 406, 409 |
|
| 1604 | | | | | |
|
| 1605 | | | | | ContentType: |
|
| 1606 | | | | | |
|
| 1607 | | | | | ` <./example/YXBwb |
|
| 1608 | | | | | GljYXRpb24vVXNlclJ |
|
| 1609 | | | | | vbGVSZXF1ZXN0K2pzb |
|
| 1610 | | | | | 247cT0xLjA7Y2hhcnN |
|
| 1611 | | | | | ldD11dGYtODt2ZXJza |
|
| 1612 | | | | | W9uPTIuMCxhcHBsaWN |
|
| 1613 | | | | | hdGlvbi9qc29uO3E9M |
|
| 1614 | | | | | S4wO3ZlcnNpb249Mi4 |
|
| 1615 | | | | | wLCovKjtxPTEuMA==> |
|
| 1616 | | | | | `__\ application/U |
|
| 1617 | | | | | serRoleRequest+jso |
|
| 1618 | | | | | n;q=1.0;charset=ut |
|
| 1619 | | | | | f-8;version=2.0,ap |
|
| 1620 | | | | | plication/json;q=1 |
|
| 1621 | | | | | .0;version=2.0,\*/ |
|
| 1622 | | | | | \*;q=1.0 |
|
| 1623 | | | | | |
|
| 1624 | | | | | ` <./example/YXBwb |
|
| 1625 | | | | | GljYXRpb24vVXNlclJ |
|
| 1626 | | | | | vbGVSZXF1ZXN0K3htb |
|
| 1627 | | | | | DtxPTEuMDtjaGFyc2V |
|
| 1628 | | | | | 0PXV0Zi04O3ZlcnNpb |
|
| 1629 | | | | | 249Mi4wLHRleHQveG1 |
|
| 1630 | | | | | sO3E9MS4wO3ZlcnNpb |
|
| 1631 | | | | | 249Mi4w>`__\ appli |
|
| 1632 | | | | | cation/UserRoleReq |
|
| 1633 | | | | | uest+xml;q=1.0;cha |
|
| 1634 | | | | | rset=utf-8;version |
|
| 1635 | | | | | =2.0,text/xml;q=1. |
|
| 1636 | | | | | 0;version=2.0 |
|
| 1637 | +--------------------+--------------------+--------------------+--------------------+
|
| 1638 | | | GET | /authz/userRole/:u | Get if User is In |
|
| 1639 | | | | ser/:role | Role |
|
| 1640 | | | | | |
|
| 1641 | | | | | Returns the User |
|
| 1642 | | | | | (with Expiration |
|
| 1643 | | | | | date from listed |
|
| 1644 | | | | | User/Role) if it |
|
| 1645 | | | | | exists |
|
| 1646 | | | | | |
|
| 1647 | | | | | -------------- |
|
| 1648 | | | | | |
|
| 1649 | | | | | Parameters |
|
| 1650 | | | | | |
|
| 1651 | | | | | user : string |
|
| 1652 | | | | | (Required) |
|
| 1653 | | | | | |
|
| 1654 | | | | | role : string |
|
| 1655 | | | | | (Required) |
|
| 1656 | | | | | |
|
| 1657 | | | | | Expected HTTP Code |
|
| 1658 | | | | | |
|
| 1659 | | | | | 200 |
|
| 1660 | | | | | |
|
| 1661 | | | | | Explicit HTTP |
|
| 1662 | | | | | Error Codes |
|
| 1663 | | | | | |
|
| 1664 | | | | | 403, 404, 406 |
|
| 1665 | | | | | |
|
| 1666 | | | | | Accept: |
|
| 1667 | | | | | |
|
| 1668 | | | | | ` <./example/YXBwb |
|
| 1669 | | | | | GljYXRpb24vVXNlcnM |
|
| 1670 | | | | | ranNvbjtxPTEuMDtja |
|
| 1671 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 1672 | | | | | lcnNpb249Mi4wLGFwc |
|
| 1673 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 1674 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 1675 | | | | | j0yLjAsKi8qO3E9MS4 |
|
| 1676 | | | | | w>`__\ application |
|
| 1677 | | | | | /Users+json;q=1.0; |
|
| 1678 | | | | | charset=utf-8;vers |
|
| 1679 | | | | | ion=2.0,applicatio |
|
| 1680 | | | | | n/json;q=1.0;versi |
|
| 1681 | | | | | on=2.0,\*/\*;q=1.0 |
|
| 1682 | | | | | |
|
| 1683 | | | | | ` <./example/YXBwb |
|
| 1684 | | | | | GljYXRpb24vVXNlcnM |
|
| 1685 | | | | | reG1sO3E9MS4wO2NoY |
|
| 1686 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 1687 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 1688 | | | | | C94bWw7cT0xLjA7dmV |
|
| 1689 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 1690 | | | | | application/Users |
|
| 1691 | | | | | +xml;q=1.0;charset |
|
| 1692 | | | | | =utf-8;version=2.0 |
|
| 1693 | | | | | ,text/xml;q=1.0;ve |
|
| 1694 | | | | | rsion=2.0 |
|
| 1695 | +--------------------+--------------------+--------------------+--------------------+
|
| 1696 | | | DELETE | /authz/userRole/:u | Delete User Role |
|
| 1697 | | | | ser/:role | |
|
| 1698 | | | | | Remove Role :role |
|
| 1699 | | | | | from User :user. |
|
| 1700 | | | | | |
|
| 1701 | | | | | -------------- |
|
| 1702 | | | | | |
|
| 1703 | | | | | Parameters |
|
| 1704 | | | | | |
|
| 1705 | | | | | user : string |
|
| 1706 | | | | | (Required) |
|
| 1707 | | | | | |
|
| 1708 | | | | | role : string |
|
| 1709 | | | | | (Required) |
|
| 1710 | | | | | |
|
| 1711 | | | | | Expected HTTP Code |
|
| 1712 | | | | | |
|
| 1713 | | | | | 200 |
|
| 1714 | | | | | |
|
| 1715 | | | | | Explicit HTTP |
|
| 1716 | | | | | Error Codes |
|
| 1717 | | | | | |
|
| 1718 | | | | | 403, 404, 406 |
|
| 1719 | | | | | |
|
| 1720 | | | | | ContentType: |
|
| 1721 | | | | | |
|
| 1722 | | | | | ` <./example/YXBwb |
|
| 1723 | | | | | GljYXRpb24vVm9pZCt |
|
| 1724 | | | | | qc29uO3E9MS4wO2NoY |
|
| 1725 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 1726 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 1727 | | | | | GljYXRpb24vanNvbjt |
|
| 1728 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 1729 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 1730 | | | | | =>`__\ application |
|
| 1731 | | | | | /Void+json;q=1.0;c |
|
| 1732 | | | | | harset=utf-8;versi |
|
| 1733 | | | | | on=2.0,application |
|
| 1734 | | | | | /json;q=1.0;versio |
|
| 1735 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 1736 | | | | | |
|
| 1737 | | | | | ` <./example/YXBwb |
|
| 1738 | | | | | GljYXRpb24vVm9pZCt |
|
| 1739 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 1740 | | | | | nNldD11dGYtODt2ZXJ |
|
| 1741 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 1742 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 1743 | | | | | zaW9uPTIuMA==>`__\ |
|
| 1744 | | | | | application/Void+ |
|
| 1745 | | | | | xml;q=1.0;charset= |
|
| 1746 | | | | | utf-8;version=2.0, |
|
| 1747 | | | | | text/xml;q=1.0;ver |
|
| 1748 | | | | | sion=2.0 |
|
| 1749 | +--------------------+--------------------+--------------------+--------------------+
|
| 1750 | | | PUT | /authz/userRole/ex | Extend Expiration |
|
| 1751 | | | | tend/:user/:role | |
|
| 1752 | | | | | ContentType: |
|
| 1753 | | | | | |
|
| 1754 | | | | | ` <./example/YXBwb |
|
| 1755 | | | | | GljYXRpb24vVm9pZCt |
|
| 1756 | | | | | qc29uO3E9MS4wO2NoY |
|
| 1757 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 1758 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 1759 | | | | | GljYXRpb24vanNvbjt |
|
| 1760 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 1761 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 1762 | | | | | =>`__\ application |
|
| 1763 | | | | | /Void+json;q=1.0;c |
|
| 1764 | | | | | harset=utf-8;versi |
|
| 1765 | | | | | on=2.0,application |
|
| 1766 | | | | | /json;q=1.0;versio |
|
| 1767 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 1768 | | | | | |
|
| 1769 | | | | | ` <./example/YXBwb |
|
| 1770 | | | | | GljYXRpb24vVm9pZCt |
|
| 1771 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 1772 | | | | | nNldD11dGYtODt2ZXJ |
|
| 1773 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 1774 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 1775 | | | | | zaW9uPTIuMA==>`__\ |
|
| 1776 | | | | | application/Void+ |
|
| 1777 | | | | | xml;q=1.0;charset= |
|
| 1778 | | | | | utf-8;version=2.0, |
|
| 1779 | | | | | text/xml;q=1.0;ver |
|
| 1780 | | | | | sion=2.0 |
|
| 1781 | +--------------------+--------------------+--------------------+--------------------+
|
| 1782 | | | PUT | /authz/userRole/ro | Update Users for a |
|
| 1783 | | | | le | role |
|
| 1784 | | | | | |
|
| 1785 | | | | | Set a Role's users |
|
| 1786 | | | | | to the users |
|
| 1787 | | | | | specified in the |
|
| 1788 | | | | | UserRoleRequest |
|
| 1789 | | | | | object. |
|
| 1790 | | | | | |
|
| 1791 | | | | | WARNING: Users |
|
| 1792 | | | | | supplied will be |
|
| 1793 | | | | | the ONLY users |
|
| 1794 | | | | | attached to this |
|
| 1795 | | | | | role |
|
| 1796 | | | | | |
|
| 1797 | | | | | If no users are |
|
| 1798 | | | | | supplied, role's |
|
| 1799 | | | | | users are reset. |
|
| 1800 | | | | | |
|
| 1801 | | | | | Expected HTTP Code |
|
| 1802 | | | | | |
|
| 1803 | | | | | 200 |
|
| 1804 | | | | | |
|
| 1805 | | | | | Explicit HTTP |
|
| 1806 | | | | | Error Codes |
|
| 1807 | | | | | |
|
| 1808 | | | | | 403, 404, 406 |
|
| 1809 | | | | | |
|
| 1810 | | | | | ContentType: |
|
| 1811 | | | | | |
|
| 1812 | | | | | ` <./example/YXBwb |
|
| 1813 | | | | | GljYXRpb24vVXNlclJ |
|
| 1814 | | | | | vbGVSZXF1ZXN0K2pzb |
|
| 1815 | | | | | 247cT0xLjA7Y2hhcnN |
|
| 1816 | | | | | ldD11dGYtODt2ZXJza |
|
| 1817 | | | | | W9uPTIuMCxhcHBsaWN |
|
| 1818 | | | | | hdGlvbi9qc29uO3E9M |
|
| 1819 | | | | | S4wO3ZlcnNpb249Mi4 |
|
| 1820 | | | | | wLCovKjtxPTEuMA==> |
|
| 1821 | | | | | `__\ application/U |
|
| 1822 | | | | | serRoleRequest+jso |
|
| 1823 | | | | | n;q=1.0;charset=ut |
|
| 1824 | | | | | f-8;version=2.0,ap |
|
| 1825 | | | | | plication/json;q=1 |
|
| 1826 | | | | | .0;version=2.0,\*/ |
|
| 1827 | | | | | \*;q=1.0 |
|
| 1828 | | | | | |
|
| 1829 | | | | | ` <./example/YXBwb |
|
| 1830 | | | | | GljYXRpb24vVXNlclJ |
|
| 1831 | | | | | vbGVSZXF1ZXN0K3htb |
|
| 1832 | | | | | DtxPTEuMDtjaGFyc2V |
|
| 1833 | | | | | 0PXV0Zi04O3ZlcnNpb |
|
| 1834 | | | | | 249Mi4wLHRleHQveG1 |
|
| 1835 | | | | | sO3E9MS4wO3ZlcnNpb |
|
| 1836 | | | | | 249Mi4w>`__\ appli |
|
| 1837 | | | | | cation/UserRoleReq |
|
| 1838 | | | | | uest+xml;q=1.0;cha |
|
| 1839 | | | | | rset=utf-8;version |
|
| 1840 | | | | | =2.0,text/xml;q=1. |
|
| 1841 | | | | | 0;version=2.0 |
|
| 1842 | +--------------------+--------------------+--------------------+--------------------+
|
| 1843 | | | PUT | /authz/userRole/us | Update Roles for a |
|
| 1844 | | | | er | user |
|
| 1845 | | | | | |
|
| 1846 | | | | | Set a User's roles |
|
| 1847 | | | | | to the roles |
|
| 1848 | | | | | specified in the |
|
| 1849 | | | | | UserRoleRequest |
|
| 1850 | | | | | object. |
|
| 1851 | | | | | |
|
| 1852 | | | | | WARNING: Roles |
|
| 1853 | | | | | supplied will be |
|
| 1854 | | | | | the ONLY roles |
|
| 1855 | | | | | attached to this |
|
| 1856 | | | | | user |
|
| 1857 | | | | | |
|
| 1858 | | | | | If no roles are |
|
| 1859 | | | | | supplied, user's |
|
| 1860 | | | | | roles are reset. |
|
| 1861 | | | | | |
|
| 1862 | | | | | Expected HTTP Code |
|
| 1863 | | | | | |
|
| 1864 | | | | | 200 |
|
| 1865 | | | | | |
|
| 1866 | | | | | Explicit HTTP |
|
| 1867 | | | | | Error Codes |
|
| 1868 | | | | | |
|
| 1869 | | | | | 403, 404, 406 |
|
| 1870 | | | | | |
|
| 1871 | | | | | ContentType: |
|
| 1872 | | | | | |
|
| 1873 | | | | | ` <./example/YXBwb |
|
| 1874 | | | | | GljYXRpb24vVXNlclJ |
|
| 1875 | | | | | vbGVSZXF1ZXN0K2pzb |
|
| 1876 | | | | | 247cT0xLjA7Y2hhcnN |
|
| 1877 | | | | | ldD11dGYtODt2ZXJza |
|
| 1878 | | | | | W9uPTIuMCxhcHBsaWN |
|
| 1879 | | | | | hdGlvbi9qc29uO3E9M |
|
| 1880 | | | | | S4wO3ZlcnNpb249Mi4 |
|
| 1881 | | | | | wLCovKjtxPTEuMA==> |
|
| 1882 | | | | | `__\ application/U |
|
| 1883 | | | | | serRoleRequest+jso |
|
| 1884 | | | | | n;q=1.0;charset=ut |
|
| 1885 | | | | | f-8;version=2.0,ap |
|
| 1886 | | | | | plication/json;q=1 |
|
| 1887 | | | | | .0;version=2.0,\*/ |
|
| 1888 | | | | | \*;q=1.0 |
|
| 1889 | | | | | |
|
| 1890 | | | | | ` <./example/YXBwb |
|
| 1891 | | | | | GljYXRpb24vVXNlclJ |
|
| 1892 | | | | | vbGVSZXF1ZXN0K3htb |
|
| 1893 | | | | | DtxPTEuMDtjaGFyc2V |
|
| 1894 | | | | | 0PXV0Zi04O3ZlcnNpb |
|
| 1895 | | | | | 249Mi4wLHRleHQveG1 |
|
| 1896 | | | | | sO3E9MS4wO3ZlcnNpb |
|
| 1897 | | | | | 249Mi4w>`__\ appli |
|
| 1898 | | | | | cation/UserRoleReq |
|
| 1899 | | | | | uest+xml;q=1.0;cha |
|
| 1900 | | | | | rset=utf-8;version |
|
| 1901 | | | | | =2.0,text/xml;q=1. |
|
| 1902 | | | | | 0;version=2.0 |
|
| 1903 | +--------------------+--------------------+--------------------+--------------------+
|
| 1904 | | | GET | /authz/userRoles/r | Get UserRoles by |
|
| 1905 | | | | ole/:role | Role |
|
| 1906 | | | | | |
|
| 1907 | | | | | List all Users |
|
| 1908 | | | | | that are attached |
|
| 1909 | | | | | to Role specified |
|
| 1910 | | | | | in :role |
|
| 1911 | | | | | |
|
| 1912 | | | | | -------------- |
|
| 1913 | | | | | |
|
| 1914 | | | | | Parameters |
|
| 1915 | | | | | |
|
| 1916 | | | | | role : string |
|
| 1917 | | | | | (Required) |
|
| 1918 | | | | | |
|
| 1919 | | | | | Expected HTTP Code |
|
| 1920 | | | | | |
|
| 1921 | | | | | 200 |
|
| 1922 | | | | | |
|
| 1923 | | | | | Explicit HTTP |
|
| 1924 | | | | | Error Codes |
|
| 1925 | | | | | |
|
| 1926 | | | | | 404, 406 |
|
| 1927 | | | | | |
|
| 1928 | | | | | Accept: |
|
| 1929 | | | | | |
|
| 1930 | | | | | ` <./example/YXBwb |
|
| 1931 | | | | | GljYXRpb24vVXNlclJ |
|
| 1932 | | | | | vbGVzK2pzb247cT0xL |
|
| 1933 | | | | | jA7Y2hhcnNldD11dGY |
|
| 1934 | | | | | tODt2ZXJzaW9uPTIuM |
|
| 1935 | | | | | CxhcHBsaWNhdGlvbi9 |
|
| 1936 | | | | | qc29uO3E9MS4wO3Zlc |
|
| 1937 | | | | | nNpb249Mi4wLCovKjt |
|
| 1938 | | | | | xPTAuMg==>`__\ app |
|
| 1939 | | | | | lication/UserRoles |
|
| 1940 | | | | | +json;q=1.0;charse |
|
| 1941 | | | | | t=utf-8;version=2. |
|
| 1942 | | | | | 0,application/json |
|
| 1943 | | | | | ;q=1.0;version=2.0 |
|
| 1944 | | | | | ,\*/\*;q=0.2 |
|
| 1945 | | | | | |
|
| 1946 | | | | | ` <./example/YXBwb |
|
| 1947 | | | | | GljYXRpb24vVXNlclJ |
|
| 1948 | | | | | vbGVzK3htbDtxPTEuM |
|
| 1949 | | | | | DtjaGFyc2V0PXV0Zi0 |
|
| 1950 | | | | | 4O3ZlcnNpb249Mi4wL |
|
| 1951 | | | | | HRleHQveG1sO3E9MS4 |
|
| 1952 | | | | | wO3ZlcnNpb249Mi4w> |
|
| 1953 | | | | | `__\ application/U |
|
| 1954 | | | | | serRoles+xml;q=1.0 |
|
| 1955 | | | | | ;charset=utf-8;ver |
|
| 1956 | | | | | sion=2.0,text/xml; |
|
| 1957 | | | | | q=1.0;version=2.0 |
|
| 1958 | +--------------------+--------------------+--------------------+--------------------+
|
| 1959 | | | GET | /authz/userRoles/u | Get UserRoles by |
|
| 1960 | | | | ser/:user | User |
|
| 1961 | | | | | |
|
| 1962 | | | | | List all UserRoles |
|
| 1963 | | | | | for :user |
|
| 1964 | | | | | |
|
| 1965 | | | | | -------------- |
|
| 1966 | | | | | |
|
| 1967 | | | | | Parameters |
|
| 1968 | | | | | |
|
| 1969 | | | | | role : string |
|
| 1970 | | | | | (Required) |
|
| 1971 | | | | | |
|
| 1972 | | | | | Expected HTTP Code |
|
| 1973 | | | | | |
|
| 1974 | | | | | 200 |
|
| 1975 | | | | | |
|
| 1976 | | | | | Explicit HTTP |
|
| 1977 | | | | | Error Codes |
|
| 1978 | | | | | |
|
| 1979 | | | | | 404, 406 |
|
| 1980 | | | | | |
|
| 1981 | | | | | Accept: |
|
| 1982 | | | | | |
|
| 1983 | | | | | ` <./example/YXBwb |
|
| 1984 | | | | | GljYXRpb24vVXNlclJ |
|
| 1985 | | | | | vbGVzK2pzb247cT0xL |
|
| 1986 | | | | | jA7Y2hhcnNldD11dGY |
|
| 1987 | | | | | tODt2ZXJzaW9uPTIuM |
|
| 1988 | | | | | CxhcHBsaWNhdGlvbi9 |
|
| 1989 | | | | | qc29uO3E9MS4wO3Zlc |
|
| 1990 | | | | | nNpb249Mi4wLCovKjt |
|
| 1991 | | | | | xPTAuMg==>`__\ app |
|
| 1992 | | | | | lication/UserRoles |
|
| 1993 | | | | | +json;q=1.0;charse |
|
| 1994 | | | | | t=utf-8;version=2. |
|
| 1995 | | | | | 0,application/json |
|
| 1996 | | | | | ;q=1.0;version=2.0 |
|
| 1997 | | | | | ,\*/\*;q=0.2 |
|
| 1998 | | | | | |
|
| 1999 | | | | | ` <./example/YXBwb |
|
| 2000 | | | | | GljYXRpb24vVXNlclJ |
|
| 2001 | | | | | vbGVzK3htbDtxPTEuM |
|
| 2002 | | | | | DtjaGFyc2V0PXV0Zi0 |
|
| 2003 | | | | | 4O3ZlcnNpb249Mi4wL |
|
| 2004 | | | | | HRleHQveG1sO3E9MS4 |
|
| 2005 | | | | | wO3ZlcnNpb249Mi4w> |
|
| 2006 | | | | | `__\ application/U |
|
| 2007 | | | | | serRoles+xml;q=1.0 |
|
| 2008 | | | | | ;charset=utf-8;ver |
|
| 2009 | | | | | sion=2.0,text/xml; |
|
| 2010 | | | | | q=1.0;version=2.0 |
|
| 2011 | +--------------------+--------------------+--------------------+--------------------+
|
| 2012 | | NAMESPACE | POST | /authz/ns | Create a Namespace |
|
| 2013 | | | | | |
|
| 2014 | | | | | Namespace consists |
|
| 2015 | | | | | of: |
|
| 2016 | | | | | |
|
| 2017 | | | | | - name - What you |
|
| 2018 | | | | | want to call |
|
| 2019 | | | | | this Namespace |
|
| 2020 | | | | | - responsible(s) |
|
| 2021 | | | | | - Person(s) who |
|
| 2022 | | | | | receive |
|
| 2023 | | | | | Notifications |
|
| 2024 | | | | | and approves |
|
| 2025 | | | | | Requests |
|
| 2026 | | | | | |
|
| 2027 | | | | | regarding this |
|
| 2028 | | | | | Namespace. |
|
| 2029 | | | | | Companies have |
|
| 2030 | | | | | Policies as to |
|
| 2031 | | | | | who may take on |
|
| 2032 | | | | | |
|
| 2033 | | | | | this |
|
| 2034 | | | | | Responsibility. |
|
| 2035 | | | | | Separate |
|
| 2036 | | | | | multiple |
|
| 2037 | | | | | identities with |
|
| 2038 | | | | | commas |
|
| 2039 | | | | | |
|
| 2040 | | | | | - admin(s) - |
|
| 2041 | | | | | Person(s) who |
|
| 2042 | | | | | are allowed to |
|
| 2043 | | | | | make changes on |
|
| 2044 | | | | | the namespace, |
|
| 2045 | | | | | |
|
| 2046 | | | | | including |
|
| 2047 | | | | | creating Roles, |
|
| 2048 | | | | | Permissions and |
|
| 2049 | | | | | Credentials. |
|
| 2050 | | | | | Separate |
|
| 2051 | | | | | multiple |
|
| 2052 | | | | | |
|
| 2053 | | | | | identities with |
|
| 2054 | | | | | commas |
|
| 2055 | | | | | |
|
| 2056 | | | | | Note: Namespaces |
|
| 2057 | | | | | are dot-delimited |
|
| 2058 | | | | | (i.e. |
|
| 2059 | | | | | com.myCompany.myAp |
|
| 2060 | | | | | p) |
|
| 2061 | | | | | and must be |
|
| 2062 | | | | | |
|
| 2063 | | | | | created with |
|
| 2064 | | | | | parent credentials |
|
| 2065 | | | | | (i.e. To create |
|
| 2066 | | | | | com.myCompany.myAp |
|
| 2067 | | | | | p, |
|
| 2068 | | | | | you must |
|
| 2069 | | | | | |
|
| 2070 | | | | | be an admin of |
|
| 2071 | | | | | com.myCompany or |
|
| 2072 | | | | | com |
|
| 2073 | | | | | |
|
| 2074 | | | | | Expected HTTP Code |
|
| 2075 | | | | | |
|
| 2076 | | | | | 201 |
|
| 2077 | | | | | |
|
| 2078 | | | | | Explicit HTTP |
|
| 2079 | | | | | Error Codes |
|
| 2080 | | | | | |
|
| 2081 | | | | | 403, 404, 406, 409 |
|
| 2082 | | | | | |
|
| 2083 | | | | | ContentType: |
|
| 2084 | | | | | |
|
| 2085 | | | | | ` <./example/YXBwb |
|
| 2086 | | | | | GljYXRpb24vTnNSZXF |
|
| 2087 | | | | | 1ZXN0K2pzb247cT0xL |
|
| 2088 | | | | | jA7Y2hhcnNldD11dGY |
|
| 2089 | | | | | tODt2ZXJzaW9uPTIuM |
|
| 2090 | | | | | CxhcHBsaWNhdGlvbi9 |
|
| 2091 | | | | | qc29uO3E9MS4wO3Zlc |
|
| 2092 | | | | | nNpb249Mi4wLCovKjt |
|
| 2093 | | | | | xPTEuMA==>`__\ app |
|
| 2094 | | | | | lication/NsRequest |
|
| 2095 | | | | | +json;q=1.0;charse |
|
| 2096 | | | | | t=utf-8;version=2. |
|
| 2097 | | | | | 0,application/json |
|
| 2098 | | | | | ;q=1.0;version=2.0 |
|
| 2099 | | | | | ,\*/\*;q=1.0 |
|
| 2100 | | | | | |
|
| 2101 | | | | | ` <./example/YXBwb |
|
| 2102 | | | | | GljYXRpb24vTnNSZXF |
|
| 2103 | | | | | 1ZXN0K3htbDtxPTEuM |
|
| 2104 | | | | | DtjaGFyc2V0PXV0Zi0 |
|
| 2105 | | | | | 4O3ZlcnNpb249Mi4wL |
|
| 2106 | | | | | HRleHQveG1sO3E9MS4 |
|
| 2107 | | | | | wO3ZlcnNpb249Mi4w> |
|
| 2108 | | | | | `__\ application/N |
|
| 2109 | | | | | sRequest+xml;q=1.0 |
|
| 2110 | | | | | ;charset=utf-8;ver |
|
| 2111 | | | | | sion=2.0,text/xml; |
|
| 2112 | | | | | q=1.0;version=2.0 |
|
| 2113 | +--------------------+--------------------+--------------------+--------------------+
|
| 2114 | | | PUT | /authz/ns | Set a Description |
|
| 2115 | | | | | for a Namespace |
|
| 2116 | | | | | |
|
| 2117 | | | | | Replace the |
|
| 2118 | | | | | Current |
|
| 2119 | | | | | Description of a |
|
| 2120 | | | | | Namespace with a |
|
| 2121 | | | | | new one |
|
| 2122 | | | | | |
|
| 2123 | | | | | Expected HTTP Code |
|
| 2124 | | | | | |
|
| 2125 | | | | | 200 |
|
| 2126 | | | | | |
|
| 2127 | | | | | Explicit HTTP |
|
| 2128 | | | | | Error Codes |
|
| 2129 | | | | | |
|
| 2130 | | | | | 403, 404, 406 |
|
| 2131 | | | | | |
|
| 2132 | | | | | ContentType: |
|
| 2133 | | | | | |
|
| 2134 | | | | | ` <./example/YXBwb |
|
| 2135 | | | | | GljYXRpb24vTnNSZXF |
|
| 2136 | | | | | 1ZXN0K2pzb247cT0xL |
|
| 2137 | | | | | jA7Y2hhcnNldD11dGY |
|
| 2138 | | | | | tODt2ZXJzaW9uPTIuM |
|
| 2139 | | | | | CxhcHBsaWNhdGlvbi9 |
|
| 2140 | | | | | qc29uO3E9MS4wO3Zlc |
|
| 2141 | | | | | nNpb249Mi4wLCovKjt |
|
| 2142 | | | | | xPTEuMA==>`__\ app |
|
| 2143 | | | | | lication/NsRequest |
|
| 2144 | | | | | +json;q=1.0;charse |
|
| 2145 | | | | | t=utf-8;version=2. |
|
| 2146 | | | | | 0,application/json |
|
| 2147 | | | | | ;q=1.0;version=2.0 |
|
| 2148 | | | | | ,\*/\*;q=1.0 |
|
| 2149 | | | | | |
|
| 2150 | | | | | ` <./example/YXBwb |
|
| 2151 | | | | | GljYXRpb24vTnNSZXF |
|
| 2152 | | | | | 1ZXN0K3htbDtxPTEuM |
|
| 2153 | | | | | DtjaGFyc2V0PXV0Zi0 |
|
| 2154 | | | | | 4O3ZlcnNpb249Mi4wL |
|
| 2155 | | | | | HRleHQveG1sO3E9MS4 |
|
| 2156 | | | | | wO3ZlcnNpb249Mi4w> |
|
| 2157 | | | | | `__\ application/N |
|
| 2158 | | | | | sRequest+xml;q=1.0 |
|
| 2159 | | | | | ;charset=utf-8;ver |
|
| 2160 | | | | | sion=2.0,text/xml; |
|
| 2161 | | | | | q=1.0;version=2.0 |
|
| 2162 | +--------------------+--------------------+--------------------+--------------------+
|
| 2163 | | | DELETE | /authz/ns/:ns | Delete a Namespace |
|
| 2164 | | | | | |
|
| 2165 | | | | | Delete the |
|
| 2166 | | | | | Namespace :ns. |
|
| 2167 | | | | | Namespaces cannot |
|
| 2168 | | | | | normally be |
|
| 2169 | | | | | deleted when there |
|
| 2170 | | | | | |
|
| 2171 | | | | | are still |
|
| 2172 | | | | | credentials |
|
| 2173 | | | | | associated with |
|
| 2174 | | | | | them, but they can |
|
| 2175 | | | | | be deleted by |
|
| 2176 | | | | | setting |
|
| 2177 | | | | | |
|
| 2178 | | | | | the "force" |
|
| 2179 | | | | | property. To do |
|
| 2180 | | | | | this: Add |
|
| 2181 | | | | | 'force=true' as a |
|
| 2182 | | | | | query parameter |
|
| 2183 | | | | | |
|
| 2184 | | | | | WARNING: Using |
|
| 2185 | | | | | force will delete |
|
| 2186 | | | | | all credentials |
|
| 2187 | | | | | attached to this |
|
| 2188 | | | | | namespace. Use |
|
| 2189 | | | | | with care. |
|
| 2190 | | | | | |
|
| 2191 | | | | | if the "force" |
|
| 2192 | | | | | property is set to |
|
| 2193 | | | | | 'force=move', then |
|
| 2194 | | | | | Permissions and |
|
| 2195 | | | | | Roles are not |
|
| 2196 | | | | | deleted,but are |
|
| 2197 | | | | | retained, and |
|
| 2198 | | | | | assigned to the |
|
| 2199 | | | | | Parent Namespace. |
|
| 2200 | | | | | 'force=move' is |
|
| 2201 | | | | | not permitted at |
|
| 2202 | | | | | or below |
|
| 2203 | | | | | Application Scope |
|
| 2204 | | | | | |
|
| 2205 | | | | | -------------- |
|
| 2206 | | | | | |
|
| 2207 | | | | | Parameters |
|
| 2208 | | | | | |
|
| 2209 | | | | | ns : string |
|
| 2210 | | | | | (Required) |
|
| 2211 | | | | | |
|
| 2212 | | | | | Expected HTTP Code |
|
| 2213 | | | | | |
|
| 2214 | | | | | 200 |
|
| 2215 | | | | | |
|
| 2216 | | | | | Explicit HTTP |
|
| 2217 | | | | | Error Codes |
|
| 2218 | | | | | |
|
| 2219 | | | | | 403, 404, 424 |
|
| 2220 | | | | | |
|
| 2221 | | | | | ContentType: |
|
| 2222 | | | | | |
|
| 2223 | | | | | ` <./example/YXBwb |
|
| 2224 | | | | | GljYXRpb24vVm9pZCt |
|
| 2225 | | | | | qc29uO3E9MS4wO2NoY |
|
| 2226 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 2227 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 2228 | | | | | GljYXRpb24vanNvbjt |
|
| 2229 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 2230 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 2231 | | | | | =>`__\ application |
|
| 2232 | | | | | /Void+json;q=1.0;c |
|
| 2233 | | | | | harset=utf-8;versi |
|
| 2234 | | | | | on=2.0,application |
|
| 2235 | | | | | /json;q=1.0;versio |
|
| 2236 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 2237 | | | | | |
|
| 2238 | | | | | ` <./example/YXBwb |
|
| 2239 | | | | | GljYXRpb24vVm9pZCt |
|
| 2240 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 2241 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2242 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 2243 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 2244 | | | | | zaW9uPTIuMA==>`__\ |
|
| 2245 | | | | | application/Void+ |
|
| 2246 | | | | | xml;q=1.0;charset= |
|
| 2247 | | | | | utf-8;version=2.0, |
|
| 2248 | | | | | text/xml;q=1.0;ver |
|
| 2249 | | | | | sion=2.0 |
|
| 2250 | +--------------------+--------------------+--------------------+--------------------+
|
| 2251 | | | POST | /authz/ns/:ns/admi | Add an Admin to a |
|
| 2252 | | | | n/:id | Namespace |
|
| 2253 | | | | | |
|
| 2254 | | | | | Add an Identity |
|
| 2255 | | | | | :id to the list of |
|
| 2256 | | | | | Admins for the |
|
| 2257 | | | | | Namespace :ns |
|
| 2258 | | | | | |
|
| 2259 | | | | | Note: :id must be |
|
| 2260 | | | | | fully qualified |
|
| 2261 | | | | | |
|
| 2262 | | | | | |
|
| 2263 | | | | | -------------- |
|
| 2264 | | | | | |
|
| 2265 | | | | | Parameters |
|
| 2266 | | | | | |
|
| 2267 | | | | | ns : string |
|
| 2268 | | | | | (Required) |
|
| 2269 | | | | | |
|
| 2270 | | | | | id : string |
|
| 2271 | | | | | (Required) |
|
| 2272 | | | | | |
|
| 2273 | | | | | Expected HTTP Code |
|
| 2274 | | | | | |
|
| 2275 | | | | | 201 |
|
| 2276 | | | | | |
|
| 2277 | | | | | Explicit HTTP |
|
| 2278 | | | | | Error Codes |
|
| 2279 | | | | | |
|
| 2280 | | | | | 403, 404, 406, 409 |
|
| 2281 | | | | | |
|
| 2282 | | | | | ContentType: |
|
| 2283 | | | | | |
|
| 2284 | | | | | ` <./example/YXBwb |
|
| 2285 | | | | | GljYXRpb24vVm9pZCt |
|
| 2286 | | | | | qc29uO3E9MS4wO2NoY |
|
| 2287 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 2288 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 2289 | | | | | GljYXRpb24vanNvbjt |
|
| 2290 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 2291 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 2292 | | | | | =>`__\ application |
|
| 2293 | | | | | /Void+json;q=1.0;c |
|
| 2294 | | | | | harset=utf-8;versi |
|
| 2295 | | | | | on=2.0,application |
|
| 2296 | | | | | /json;q=1.0;versio |
|
| 2297 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 2298 | | | | | |
|
| 2299 | | | | | ` <./example/YXBwb |
|
| 2300 | | | | | GljYXRpb24vVm9pZCt |
|
| 2301 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 2302 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2303 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 2304 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 2305 | | | | | zaW9uPTIuMA==>`__\ |
|
| 2306 | | | | | application/Void+ |
|
| 2307 | | | | | xml;q=1.0;charset= |
|
| 2308 | | | | | utf-8;version=2.0, |
|
| 2309 | | | | | text/xml;q=1.0;ver |
|
| 2310 | | | | | sion=2.0 |
|
| 2311 | +--------------------+--------------------+--------------------+--------------------+
|
| 2312 | | | DELETE | /authz/ns/:ns/admi | Remove an Admin |
|
| 2313 | | | | n/:id | from a Namespace |
|
| 2314 | | | | | |
|
| 2315 | | | | | Remove an Identity |
|
| 2316 | | | | | :id from the list |
|
| 2317 | | | | | of Admins for the |
|
| 2318 | | | | | Namespace :ns |
|
| 2319 | | | | | |
|
| 2320 | | | | | Note: :id must be |
|
| 2321 | | | | | fully qualified |
|
| 2322 | | | | | |
|
| 2323 | | | | | |
|
| 2324 | | | | | -------------- |
|
| 2325 | | | | | |
|
| 2326 | | | | | Parameters |
|
| 2327 | | | | | |
|
| 2328 | | | | | ns : string |
|
| 2329 | | | | | (Required) |
|
| 2330 | | | | | |
|
| 2331 | | | | | id : string |
|
| 2332 | | | | | (Required) |
|
| 2333 | | | | | |
|
| 2334 | | | | | Expected HTTP Code |
|
| 2335 | | | | | |
|
| 2336 | | | | | 200 |
|
| 2337 | | | | | |
|
| 2338 | | | | | Explicit HTTP |
|
| 2339 | | | | | Error Codes |
|
| 2340 | | | | | |
|
| 2341 | | | | | 403, 404 |
|
| 2342 | | | | | |
|
| 2343 | | | | | ContentType: |
|
| 2344 | | | | | |
|
| 2345 | | | | | ` <./example/YXBwb |
|
| 2346 | | | | | GljYXRpb24vVm9pZCt |
|
| 2347 | | | | | qc29uO3E9MS4wO2NoY |
|
| 2348 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 2349 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 2350 | | | | | GljYXRpb24vanNvbjt |
|
| 2351 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 2352 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 2353 | | | | | =>`__\ application |
|
| 2354 | | | | | /Void+json;q=1.0;c |
|
| 2355 | | | | | harset=utf-8;versi |
|
| 2356 | | | | | on=2.0,application |
|
| 2357 | | | | | /json;q=1.0;versio |
|
| 2358 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 2359 | | | | | |
|
| 2360 | | | | | ` <./example/YXBwb |
|
| 2361 | | | | | GljYXRpb24vVm9pZCt |
|
| 2362 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 2363 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2364 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 2365 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 2366 | | | | | zaW9uPTIuMA==>`__\ |
|
| 2367 | | | | | application/Void+ |
|
| 2368 | | | | | xml;q=1.0;charset= |
|
| 2369 | | | | | utf-8;version=2.0, |
|
| 2370 | | | | | text/xml;q=1.0;ver |
|
| 2371 | | | | | sion=2.0 |
|
| 2372 | +--------------------+--------------------+--------------------+--------------------+
|
| 2373 | | | DELETE | /authz/ns/:ns/attr | delete an |
|
| 2374 | | | | ib/:key | Attribute from a |
|
| 2375 | | | | | Namespace |
|
| 2376 | | | | | |
|
| 2377 | | | | | Delete an |
|
| 2378 | | | | | attribute in the |
|
| 2379 | | | | | Namespace |
|
| 2380 | | | | | |
|
| 2381 | | | | | You must be given |
|
| 2382 | | | | | direct permission |
|
| 2383 | | | | | for key by AAF |
|
| 2384 | | | | | |
|
| 2385 | | | | | -------------- |
|
| 2386 | | | | | |
|
| 2387 | | | | | Parameters |
|
| 2388 | | | | | |
|
| 2389 | | | | | ns : string |
|
| 2390 | | | | | (Required) |
|
| 2391 | | | | | |
|
| 2392 | | | | | key : string |
|
| 2393 | | | | | (Required) |
|
| 2394 | | | | | |
|
| 2395 | | | | | Expected HTTP Code |
|
| 2396 | | | | | |
|
| 2397 | | | | | 200 |
|
| 2398 | | | | | |
|
| 2399 | | | | | Explicit HTTP |
|
| 2400 | | | | | Error Codes |
|
| 2401 | | | | | |
|
| 2402 | | | | | 403, 404 |
|
| 2403 | | | | | |
|
| 2404 | | | | | ContentType: |
|
| 2405 | | | | | |
|
| 2406 | | | | | ` <./example/YXBwb |
|
| 2407 | | | | | GljYXRpb24vVm9pZCt |
|
| 2408 | | | | | qc29uO3E9MS4wO2NoY |
|
| 2409 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 2410 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 2411 | | | | | GljYXRpb24vanNvbjt |
|
| 2412 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 2413 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 2414 | | | | | =>`__\ application |
|
| 2415 | | | | | /Void+json;q=1.0;c |
|
| 2416 | | | | | harset=utf-8;versi |
|
| 2417 | | | | | on=2.0,application |
|
| 2418 | | | | | /json;q=1.0;versio |
|
| 2419 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 2420 | | | | | |
|
| 2421 | | | | | ` <./example/YXBwb |
|
| 2422 | | | | | GljYXRpb24vVm9pZCt |
|
| 2423 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 2424 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2425 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 2426 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 2427 | | | | | zaW9uPTIuMA==>`__\ |
|
| 2428 | | | | | application/Void+ |
|
| 2429 | | | | | xml;q=1.0;charset= |
|
| 2430 | | | | | utf-8;version=2.0, |
|
| 2431 | | | | | text/xml;q=1.0;ver |
|
| 2432 | | | | | sion=2.0 |
|
| 2433 | +--------------------+--------------------+--------------------+--------------------+
|
| 2434 | | | POST | /authz/ns/:ns/attr | Add an Attribute |
|
| 2435 | | | | ib/:key/:value | from a Namespace |
|
| 2436 | | | | | |
|
| 2437 | | | | | Create an |
|
| 2438 | | | | | attribute in the |
|
| 2439 | | | | | Namespace |
|
| 2440 | | | | | |
|
| 2441 | | | | | You must be given |
|
| 2442 | | | | | direct permission |
|
| 2443 | | | | | for key by AAF |
|
| 2444 | | | | | |
|
| 2445 | | | | | -------------- |
|
| 2446 | | | | | |
|
| 2447 | | | | | Parameters |
|
| 2448 | | | | | |
|
| 2449 | | | | | ns : string |
|
| 2450 | | | | | (Required) |
|
| 2451 | | | | | |
|
| 2452 | | | | | key : string |
|
| 2453 | | | | | (Required) |
|
| 2454 | | | | | |
|
| 2455 | | | | | value : string |
|
| 2456 | | | | | (Required) |
|
| 2457 | | | | | |
|
| 2458 | | | | | Expected HTTP Code |
|
| 2459 | | | | | |
|
| 2460 | | | | | 201 |
|
| 2461 | | | | | |
|
| 2462 | | | | | Explicit HTTP |
|
| 2463 | | | | | Error Codes |
|
| 2464 | | | | | |
|
| 2465 | | | | | 403, 404, 406, 409 |
|
| 2466 | | | | | |
|
| 2467 | | | | | ContentType: |
|
| 2468 | | | | | |
|
| 2469 | | | | | ` <./example/YXBwb |
|
| 2470 | | | | | GljYXRpb24vVm9pZCt |
|
| 2471 | | | | | qc29uO3E9MS4wO2NoY |
|
| 2472 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 2473 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 2474 | | | | | GljYXRpb24vanNvbjt |
|
| 2475 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 2476 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 2477 | | | | | =>`__\ application |
|
| 2478 | | | | | /Void+json;q=1.0;c |
|
| 2479 | | | | | harset=utf-8;versi |
|
| 2480 | | | | | on=2.0,application |
|
| 2481 | | | | | /json;q=1.0;versio |
|
| 2482 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 2483 | | | | | |
|
| 2484 | | | | | ` <./example/YXBwb |
|
| 2485 | | | | | GljYXRpb24vVm9pZCt |
|
| 2486 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 2487 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2488 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 2489 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 2490 | | | | | zaW9uPTIuMA==>`__\ |
|
| 2491 | | | | | application/Void+ |
|
| 2492 | | | | | xml;q=1.0;charset= |
|
| 2493 | | | | | utf-8;version=2.0, |
|
| 2494 | | | | | text/xml;q=1.0;ver |
|
| 2495 | | | | | sion=2.0 |
|
| 2496 | +--------------------+--------------------+--------------------+--------------------+
|
| 2497 | | | PUT | /authz/ns/:ns/attr | update an |
|
| 2498 | | | | ib/:key/:value | Attribute from a |
|
| 2499 | | | | | Namespace |
|
| 2500 | | | | | |
|
| 2501 | | | | | Update Value on an |
|
| 2502 | | | | | existing attribute |
|
| 2503 | | | | | in the Namespace |
|
| 2504 | | | | | |
|
| 2505 | | | | | You must be given |
|
| 2506 | | | | | direct permission |
|
| 2507 | | | | | for key by AAF |
|
| 2508 | | | | | |
|
| 2509 | | | | | -------------- |
|
| 2510 | | | | | |
|
| 2511 | | | | | Parameters |
|
| 2512 | | | | | |
|
| 2513 | | | | | ns : string |
|
| 2514 | | | | | (Required) |
|
| 2515 | | | | | |
|
| 2516 | | | | | key : string |
|
| 2517 | | | | | (Required) |
|
| 2518 | | | | | |
|
| 2519 | | | | | Expected HTTP Code |
|
| 2520 | | | | | |
|
| 2521 | | | | | 200 |
|
| 2522 | | | | | |
|
| 2523 | | | | | Explicit HTTP |
|
| 2524 | | | | | Error Codes |
|
| 2525 | | | | | |
|
| 2526 | | | | | 403, 404 |
|
| 2527 | | | | | |
|
| 2528 | | | | | ContentType: |
|
| 2529 | | | | | |
|
| 2530 | | | | | ` <./example/YXBwb |
|
| 2531 | | | | | GljYXRpb24vVm9pZCt |
|
| 2532 | | | | | qc29uO3E9MS4wO2NoY |
|
| 2533 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 2534 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 2535 | | | | | GljYXRpb24vanNvbjt |
|
| 2536 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 2537 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 2538 | | | | | =>`__\ application |
|
| 2539 | | | | | /Void+json;q=1.0;c |
|
| 2540 | | | | | harset=utf-8;versi |
|
| 2541 | | | | | on=2.0,application |
|
| 2542 | | | | | /json;q=1.0;versio |
|
| 2543 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 2544 | | | | | |
|
| 2545 | | | | | ` <./example/YXBwb |
|
| 2546 | | | | | GljYXRpb24vVm9pZCt |
|
| 2547 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 2548 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2549 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 2550 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 2551 | | | | | zaW9uPTIuMA==>`__\ |
|
| 2552 | | | | | application/Void+ |
|
| 2553 | | | | | xml;q=1.0;charset= |
|
| 2554 | | | | | utf-8;version=2.0, |
|
| 2555 | | | | | text/xml;q=1.0;ver |
|
| 2556 | | | | | sion=2.0 |
|
| 2557 | +--------------------+--------------------+--------------------+--------------------+
|
| 2558 | | | POST | /authz/ns/:ns/resp | Add a Responsible |
|
| 2559 | | | | onsible/:id | Identity to a |
|
| 2560 | | | | | Namespace |
|
| 2561 | | | | | |
|
| 2562 | | | | | Add an Identity |
|
| 2563 | | | | | :id to the list of |
|
| 2564 | | | | | Responsibles for |
|
| 2565 | | | | | the Namespace :ns |
|
| 2566 | | | | | |
|
| 2567 | | | | | Note: :id must be |
|
| 2568 | | | | | fully qualified |
|
| 2569 | | | | | |
|
| 2570 | | | | | |
|
| 2571 | | | | | -------------- |
|
| 2572 | | | | | |
|
| 2573 | | | | | Parameters |
|
| 2574 | | | | | |
|
| 2575 | | | | | ns : string |
|
| 2576 | | | | | (Required) |
|
| 2577 | | | | | |
|
| 2578 | | | | | id : string |
|
| 2579 | | | | | (Required) |
|
| 2580 | | | | | |
|
| 2581 | | | | | Expected HTTP Code |
|
| 2582 | | | | | |
|
| 2583 | | | | | 201 |
|
| 2584 | | | | | |
|
| 2585 | | | | | Explicit HTTP |
|
| 2586 | | | | | Error Codes |
|
| 2587 | | | | | |
|
| 2588 | | | | | 403, 404, 406, 409 |
|
| 2589 | | | | | |
|
| 2590 | | | | | ContentType: |
|
| 2591 | | | | | |
|
| 2592 | | | | | ` <./example/YXBwb |
|
| 2593 | | | | | GljYXRpb24vVm9pZCt |
|
| 2594 | | | | | qc29uO3E9MS4wO2NoY |
|
| 2595 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 2596 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 2597 | | | | | GljYXRpb24vanNvbjt |
|
| 2598 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 2599 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 2600 | | | | | =>`__\ application |
|
| 2601 | | | | | /Void+json;q=1.0;c |
|
| 2602 | | | | | harset=utf-8;versi |
|
| 2603 | | | | | on=2.0,application |
|
| 2604 | | | | | /json;q=1.0;versio |
|
| 2605 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 2606 | | | | | |
|
| 2607 | | | | | ` <./example/YXBwb |
|
| 2608 | | | | | GljYXRpb24vVm9pZCt |
|
| 2609 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 2610 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2611 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 2612 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 2613 | | | | | zaW9uPTIuMA==>`__\ |
|
| 2614 | | | | | application/Void+ |
|
| 2615 | | | | | xml;q=1.0;charset= |
|
| 2616 | | | | | utf-8;version=2.0, |
|
| 2617 | | | | | text/xml;q=1.0;ver |
|
| 2618 | | | | | sion=2.0 |
|
| 2619 | +--------------------+--------------------+--------------------+--------------------+
|
| 2620 | | | DELETE | /authz/ns/:ns/resp | Remove a |
|
| 2621 | | | | onsible/:id | Responsible |
|
| 2622 | | | | | Identity from |
|
| 2623 | | | | | Namespace |
|
| 2624 | | | | | |
|
| 2625 | | | | | Remove an Identity |
|
| 2626 | | | | | :id to the list of |
|
| 2627 | | | | | Responsibles for |
|
| 2628 | | | | | the Namespace :ns |
|
| 2629 | | | | | |
|
| 2630 | | | | | Note: :id must be |
|
| 2631 | | | | | fully qualified |
|
| 2632 | | | | | |
|
| 2633 | | | | | |
|
| 2634 | | | | | Note: A namespace |
|
| 2635 | | | | | must have at least |
|
| 2636 | | | | | 1 responsible |
|
| 2637 | | | | | party |
|
| 2638 | | | | | |
|
| 2639 | | | | | -------------- |
|
| 2640 | | | | | |
|
| 2641 | | | | | Parameters |
|
| 2642 | | | | | |
|
| 2643 | | | | | ns : string |
|
| 2644 | | | | | (Required) |
|
| 2645 | | | | | |
|
| 2646 | | | | | id : string |
|
| 2647 | | | | | (Required) |
|
| 2648 | | | | | |
|
| 2649 | | | | | Expected HTTP Code |
|
| 2650 | | | | | |
|
| 2651 | | | | | 200 |
|
| 2652 | | | | | |
|
| 2653 | | | | | Explicit HTTP |
|
| 2654 | | | | | Error Codes |
|
| 2655 | | | | | |
|
| 2656 | | | | | 403, 404 |
|
| 2657 | | | | | |
|
| 2658 | | | | | ContentType: |
|
| 2659 | | | | | |
|
| 2660 | | | | | ` <./example/YXBwb |
|
| 2661 | | | | | GljYXRpb24vVm9pZCt |
|
| 2662 | | | | | qc29uO3E9MS4wO2NoY |
|
| 2663 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 2664 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 2665 | | | | | GljYXRpb24vanNvbjt |
|
| 2666 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 2667 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 2668 | | | | | =>`__\ application |
|
| 2669 | | | | | /Void+json;q=1.0;c |
|
| 2670 | | | | | harset=utf-8;versi |
|
| 2671 | | | | | on=2.0,application |
|
| 2672 | | | | | /json;q=1.0;versio |
|
| 2673 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 2674 | | | | | |
|
| 2675 | | | | | ` <./example/YXBwb |
|
| 2676 | | | | | GljYXRpb24vVm9pZCt |
|
| 2677 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 2678 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2679 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 2680 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 2681 | | | | | zaW9uPTIuMA==>`__\ |
|
| 2682 | | | | | application/Void+ |
|
| 2683 | | | | | xml;q=1.0;charset= |
|
| 2684 | | | | | utf-8;version=2.0, |
|
| 2685 | | | | | text/xml;q=1.0;ver |
|
| 2686 | | | | | sion=2.0 |
|
| 2687 | +--------------------+--------------------+--------------------+--------------------+
|
| 2688 | | | GET | /authz/ns/attrib/: | get Ns Key List |
|
| 2689 | | | | key | From Attribute |
|
| 2690 | | | | | |
|
| 2691 | | | | | Read Attributes |
|
| 2692 | | | | | for Namespace |
|
| 2693 | | | | | |
|
| 2694 | | | | | -------------- |
|
| 2695 | | | | | |
|
| 2696 | | | | | Parameters |
|
| 2697 | | | | | |
|
| 2698 | | | | | key : string |
|
| 2699 | | | | | (Required) |
|
| 2700 | | | | | |
|
| 2701 | | | | | Expected HTTP Code |
|
| 2702 | | | | | |
|
| 2703 | | | | | 200 |
|
| 2704 | | | | | |
|
| 2705 | | | | | Explicit HTTP |
|
| 2706 | | | | | Error Codes |
|
| 2707 | | | | | |
|
| 2708 | | | | | 403, 404 |
|
| 2709 | | | | | |
|
| 2710 | | | | | Accept: |
|
| 2711 | | | | | |
|
| 2712 | | | | | ` <./example/YXBwb |
|
| 2713 | | | | | GljYXRpb24vS2V5cyt |
|
| 2714 | | | | | qc29uO3E9MS4wO2NoY |
|
| 2715 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 2716 | | | | | yc2lvbj0yLjAsYXBwb |
|
| 2717 | | | | | GljYXRpb24vanNvbjt |
|
| 2718 | | | | | xPTEuMDt2ZXJzaW9uP |
|
| 2719 | | | | | TIuMCwqLyo7cT0xLjA |
|
| 2720 | | | | | =>`__\ application |
|
| 2721 | | | | | /Keys+json;q=1.0;c |
|
| 2722 | | | | | harset=utf-8;versi |
|
| 2723 | | | | | on=2.0,application |
|
| 2724 | | | | | /json;q=1.0;versio |
|
| 2725 | | | | | n=2.0,\*/\*;q=1.0 |
|
| 2726 | | | | | |
|
| 2727 | | | | | ` <./example/YXBwb |
|
| 2728 | | | | | GljYXRpb24vS2V5cyt |
|
| 2729 | | | | | 4bWw7cT0xLjA7Y2hhc |
|
| 2730 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2731 | | | | | zaW9uPTIuMCx0ZXh0L |
|
| 2732 | | | | | 3htbDtxPTEuMDt2ZXJ |
|
| 2733 | | | | | zaW9uPTIuMA==>`__\ |
|
| 2734 | | | | | application/Keys+ |
|
| 2735 | | | | | xml;q=1.0;charset= |
|
| 2736 | | | | | utf-8;version=2.0, |
|
| 2737 | | | | | text/xml;q=1.0;ver |
|
| 2738 | | | | | sion=2.0 |
|
| 2739 | +--------------------+--------------------+--------------------+--------------------+
|
| 2740 | | | GET | /authz/nss/:id | Return Information |
|
| 2741 | | | | | about Namespaces |
|
| 2742 | | | | | |
|
| 2743 | | | | | Lists the |
|
| 2744 | | | | | Admin(s), |
|
| 2745 | | | | | Responsible |
|
| 2746 | | | | | Party(s), Role(s), |
|
| 2747 | | | | | Permission(s) |
|
| 2748 | | | | | |
|
| 2749 | | | | | Credential(s) and |
|
| 2750 | | | | | Expiration of |
|
| 2751 | | | | | Credential(s) in |
|
| 2752 | | | | | Namespace :id |
|
| 2753 | | | | | |
|
| 2754 | | | | | -------------- |
|
| 2755 | | | | | |
|
| 2756 | | | | | Parameters |
|
| 2757 | | | | | |
|
| 2758 | | | | | id : string |
|
| 2759 | | | | | (Required) |
|
| 2760 | | | | | |
|
| 2761 | | | | | Expected HTTP Code |
|
| 2762 | | | | | |
|
| 2763 | | | | | 200 |
|
| 2764 | | | | | |
|
| 2765 | | | | | Explicit HTTP |
|
| 2766 | | | | | Error Codes |
|
| 2767 | | | | | |
|
| 2768 | | | | | 404, 406 |
|
| 2769 | | | | | |
|
| 2770 | | | | | Accept: |
|
| 2771 | | | | | |
|
| 2772 | | | | | ` <./example/YXBwb |
|
| 2773 | | | | | GljYXRpb24vTnNzK2p |
|
| 2774 | | | | | zb247cT0xLjA7Y2hhc |
|
| 2775 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2776 | | | | | zaW9uPTIuMCxhcHBsa |
|
| 2777 | | | | | WNhdGlvbi9qc29uO3E |
|
| 2778 | | | | | 9MS4wO3ZlcnNpb249M |
|
| 2779 | | | | | i4wLCovKjtxPTEuMA= |
|
| 2780 | | | | | =>`__\ application |
|
| 2781 | | | | | /Nss+json;q=1.0;ch |
|
| 2782 | | | | | arset=utf-8;versio |
|
| 2783 | | | | | n=2.0,application/ |
|
| 2784 | | | | | json;q=1.0;version |
|
| 2785 | | | | | =2.0,\*/\*;q=1.0 |
|
| 2786 | | | | | |
|
| 2787 | | | | | ` <./example/YXBwb |
|
| 2788 | | | | | GljYXRpb24vTnNzK3h |
|
| 2789 | | | | | tbDtxPTEuMDtjaGFyc |
|
| 2790 | | | | | 2V0PXV0Zi04O3ZlcnN |
|
| 2791 | | | | | pb249Mi4wLHRleHQve |
|
| 2792 | | | | | G1sO3E9MS4wO3ZlcnN |
|
| 2793 | | | | | pb249Mi4w>`__\ app |
|
| 2794 | | | | | lication/Nss+xml;q |
|
| 2795 | | | | | =1.0;charset=utf-8 |
|
| 2796 | | | | | ;version=2.0,text/ |
|
| 2797 | | | | | xml;q=1.0;version= |
|
| 2798 | | | | | 2.0 |
|
| 2799 | +--------------------+--------------------+--------------------+--------------------+
|
| 2800 | | | GET | /authz/nss/admin/: | Return Namespaces |
|
| 2801 | | | | user | where User is an |
|
| 2802 | | | | | Admin |
|
| 2803 | | | | | |
|
| 2804 | | | | | Accept: |
|
| 2805 | | | | | |
|
| 2806 | | | | | ` <./example/YXBwb |
|
| 2807 | | | | | GljYXRpb24vTnNzK2p |
|
| 2808 | | | | | zb247cT0xLjA7Y2hhc |
|
| 2809 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2810 | | | | | zaW9uPTIuMCxhcHBsa |
|
| 2811 | | | | | WNhdGlvbi9qc29uO3E |
|
| 2812 | | | | | 9MS4wO3ZlcnNpb249M |
|
| 2813 | | | | | i4wLCovKjtxPTEuMA= |
|
| 2814 | | | | | =>`__\ application |
|
| 2815 | | | | | /Nss+json;q=1.0;ch |
|
| 2816 | | | | | arset=utf-8;versio |
|
| 2817 | | | | | n=2.0,application/ |
|
| 2818 | | | | | json;q=1.0;version |
|
| 2819 | | | | | =2.0,\*/\*;q=1.0 |
|
| 2820 | | | | | |
|
| 2821 | | | | | ` <./example/YXBwb |
|
| 2822 | | | | | GljYXRpb24vTnNzK3h |
|
| 2823 | | | | | tbDtxPTEuMDtjaGFyc |
|
| 2824 | | | | | 2V0PXV0Zi04O3ZlcnN |
|
| 2825 | | | | | pb249Mi4wLHRleHQve |
|
| 2826 | | | | | G1sO3E9MS4wO3ZlcnN |
|
| 2827 | | | | | pb249Mi4w>`__\ app |
|
| 2828 | | | | | lication/Nss+xml;q |
|
| 2829 | | | | | =1.0;charset=utf-8 |
|
| 2830 | | | | | ;version=2.0,text/ |
|
| 2831 | | | | | xml;q=1.0;version= |
|
| 2832 | | | | | 2.0 |
|
| 2833 | +--------------------+--------------------+--------------------+--------------------+
|
| 2834 | | | GET | /authz/nss/childre | Return Child |
|
| 2835 | | | | n/:id | Namespaces |
|
| 2836 | | | | | |
|
| 2837 | | | | | Lists all Child |
|
| 2838 | | | | | Namespaces of |
|
| 2839 | | | | | Namespace :id |
|
| 2840 | | | | | |
|
| 2841 | | | | | Note: This is not |
|
| 2842 | | | | | a cached read |
|
| 2843 | | | | | |
|
| 2844 | | | | | -------------- |
|
| 2845 | | | | | |
|
| 2846 | | | | | Parameters |
|
| 2847 | | | | | |
|
| 2848 | | | | | id : string |
|
| 2849 | | | | | (Required) |
|
| 2850 | | | | | |
|
| 2851 | | | | | Expected HTTP Code |
|
| 2852 | | | | | |
|
| 2853 | | | | | 200 |
|
| 2854 | | | | | |
|
| 2855 | | | | | Explicit HTTP |
|
| 2856 | | | | | Error Codes |
|
| 2857 | | | | | |
|
| 2858 | | | | | 403, 404 |
|
| 2859 | | | | | |
|
| 2860 | | | | | Accept: |
|
| 2861 | | | | | |
|
| 2862 | | | | | ` <./example/YXBwb |
|
| 2863 | | | | | GljYXRpb24vTnNzK2p |
|
| 2864 | | | | | zb247cT0xLjA7Y2hhc |
|
| 2865 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2866 | | | | | zaW9uPTIuMCxhcHBsa |
|
| 2867 | | | | | WNhdGlvbi9qc29uO3E |
|
| 2868 | | | | | 9MS4wO3ZlcnNpb249M |
|
| 2869 | | | | | i4wLCovKjtxPTEuMA= |
|
| 2870 | | | | | =>`__\ application |
|
| 2871 | | | | | /Nss+json;q=1.0;ch |
|
| 2872 | | | | | arset=utf-8;versio |
|
| 2873 | | | | | n=2.0,application/ |
|
| 2874 | | | | | json;q=1.0;version |
|
| 2875 | | | | | =2.0,\*/\*;q=1.0 |
|
| 2876 | | | | | |
|
| 2877 | | | | | ` <./example/YXBwb |
|
| 2878 | | | | | GljYXRpb24vTnNzK3h |
|
| 2879 | | | | | tbDtxPTEuMDtjaGFyc |
|
| 2880 | | | | | 2V0PXV0Zi04O3ZlcnN |
|
| 2881 | | | | | pb249Mi4wLHRleHQve |
|
| 2882 | | | | | G1sO3E9MS4wO3ZlcnN |
|
| 2883 | | | | | pb249Mi4w>`__\ app |
|
| 2884 | | | | | lication/Nss+xml;q |
|
| 2885 | | | | | =1.0;charset=utf-8 |
|
| 2886 | | | | | ;version=2.0,text/ |
|
| 2887 | | | | | xml;q=1.0;version= |
|
| 2888 | | | | | 2.0 |
|
| 2889 | +--------------------+--------------------+--------------------+--------------------+
|
| 2890 | | | GET | /authz/nss/either/ | Return Namespaces |
|
| 2891 | | | | :user | where User Admin |
|
| 2892 | | | | | or Owner |
|
| 2893 | | | | | |
|
| 2894 | | | | | Accept: |
|
| 2895 | | | | | |
|
| 2896 | | | | | ` <./example/YXBwb |
|
| 2897 | | | | | GljYXRpb24vTnNzK2p |
|
| 2898 | | | | | zb247cT0xLjA7Y2hhc |
|
| 2899 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2900 | | | | | zaW9uPTIuMCxhcHBsa |
|
| 2901 | | | | | WNhdGlvbi9qc29uO3E |
|
| 2902 | | | | | 9MS4wO3ZlcnNpb249M |
|
| 2903 | | | | | i4wLCovKjtxPTAuOA= |
|
| 2904 | | | | | =>`__\ application |
|
| 2905 | | | | | /Nss+json;q=1.0;ch |
|
| 2906 | | | | | arset=utf-8;versio |
|
| 2907 | | | | | n=2.0,application/ |
|
| 2908 | | | | | json;q=1.0;version |
|
| 2909 | | | | | =2.0,\*/\*;q=0.8 |
|
| 2910 | | | | | |
|
| 2911 | | | | | ` <./example/YXBwb |
|
| 2912 | | | | | GljYXRpb24vTnNzK3h |
|
| 2913 | | | | | tbDtxPTEuMDtjaGFyc |
|
| 2914 | | | | | 2V0PXV0Zi04O3ZlcnN |
|
| 2915 | | | | | pb249Mi4wLHRleHQve |
|
| 2916 | | | | | G1sO3E9MS4wO3ZlcnN |
|
| 2917 | | | | | pb249Mi4w>`__\ app |
|
| 2918 | | | | | lication/Nss+xml;q |
|
| 2919 | | | | | =1.0;charset=utf-8 |
|
| 2920 | | | | | ;version=2.0,text/ |
|
| 2921 | | | | | xml;q=1.0;version= |
|
| 2922 | | | | | 2.0 |
|
| 2923 | +--------------------+--------------------+--------------------+--------------------+
|
| 2924 | | | GET | /authz/nss/respons | Return Namespaces |
|
| 2925 | | | | ible/:user | where User is |
|
| 2926 | | | | | Responsible |
|
| 2927 | | | | | |
|
| 2928 | | | | | Accept: |
|
| 2929 | | | | | |
|
| 2930 | | | | | ` <./example/YXBwb |
|
| 2931 | | | | | GljYXRpb24vTnNzK2p |
|
| 2932 | | | | | zb247cT0xLjA7Y2hhc |
|
| 2933 | | | | | nNldD11dGYtODt2ZXJ |
|
| 2934 | | | | | zaW9uPTIuMCxhcHBsa |
|
| 2935 | | | | | WNhdGlvbi9qc29uO3E |
|
| 2936 | | | | | 9MS4wO3ZlcnNpb249M |
|
| 2937 | | | | | i4wLCovKjtxPTEuMA= |
|
| 2938 | | | | | =>`__\ application |
|
| 2939 | | | | | /Nss+json;q=1.0;ch |
|
| 2940 | | | | | arset=utf-8;versio |
|
| 2941 | | | | | n=2.0,application/ |
|
| 2942 | | | | | json;q=1.0;version |
|
| 2943 | | | | | =2.0,\*/\*;q=1.0 |
|
| 2944 | | | | | |
|
| 2945 | | | | | ` <./example/YXBwb |
|
| 2946 | | | | | GljYXRpb24vTnNzK3h |
|
| 2947 | | | | | tbDtxPTEuMDtjaGFyc |
|
| 2948 | | | | | 2V0PXV0Zi04O3ZlcnN |
|
| 2949 | | | | | pb249Mi4wLHRleHQve |
|
| 2950 | | | | | G1sO3E9MS4wO3ZlcnN |
|
| 2951 | | | | | pb249Mi4w>`__\ app |
|
| 2952 | | | | | lication/Nss+xml;q |
|
| 2953 | | | | | =1.0;charset=utf-8 |
|
| 2954 | | | | | ;version=2.0,text/ |
|
| 2955 | | | | | xml;q=1.0;version= |
|
| 2956 | | | | | 2.0 |
|
| 2957 | +--------------------+--------------------+--------------------+--------------------+
|
| 2958 | | USER | GET | /authn/basicAuth | Is given BasicAuth |
|
| 2959 | | | | | valid? |
|
| 2960 | | | | | |
|
| 2961 | | | | | !!!! DEPRECATED |
|
| 2962 | | | | | without X509 |
|
| 2963 | | | | | Authentication |
|
| 2964 | | | | | STOP USING THIS |
|
| 2965 | | | | | API BY DECEMBER |
|
| 2966 | | | | | 2017, or use |
|
| 2967 | | | | | Certificates !!!! |
|
| 2968 | | | | | Use |
|
| 2969 | | | | | /authn/validate |
|
| 2970 | | | | | instead Note: |
|
| 2971 | | | | | Validate a |
|
| 2972 | | | | | Password using |
|
| 2973 | | | | | BasicAuth Base64 |
|
| 2974 | | | | | encoded Header. |
|
| 2975 | | | | | This HTTP/S call |
|
| 2976 | | | | | is intended as a |
|
| 2977 | | | | | fast User/Password |
|
| 2978 | | | | | lookup for |
|
| 2979 | | | | | Security |
|
| 2980 | | | | | Frameworks, and |
|
| 2981 | | | | | responds 200 if it |
|
| 2982 | | | | | passes BasicAuth |
|
| 2983 | | | | | security, and 403 |
|
| 2984 | | | | | if it does not. |
|
| 2985 | | | | | |
|
| 2986 | | | | | Expected HTTP Code |
|
| 2987 | | | | | |
|
| 2988 | | | | | 200 |
|
| 2989 | | | | | |
|
| 2990 | | | | | Explicit HTTP |
|
| 2991 | | | | | Error Codes |
|
| 2992 | | | | | |
|
| 2993 | | | | | 403 |
|
| 2994 | | | | | |
|
| 2995 | | | | | Accept: |
|
| 2996 | | | | | |
|
| 2997 | | | | | text/plain |
|
| 2998 | +--------------------+--------------------+--------------------+--------------------+
|
| 2999 | | | POST | /authn/validate | Is given |
|
| 3000 | | | | | Credential valid? |
|
| 3001 | | | | | |
|
| 3002 | | | | | Validate a |
|
| 3003 | | | | | Credential given a |
|
| 3004 | | | | | Credential |
|
| 3005 | | | | | Structure. This is |
|
| 3006 | | | | | a more |
|
| 3007 | | | | | comprehensive |
|
| 3008 | | | | | validation, can do |
|
| 3009 | | | | | more than |
|
| 3010 | | | | | BasicAuth as |
|
| 3011 | | | | | Credential types |
|
| 3012 | | | | | exp |
|
| 3013 | | | | | |
|
| 3014 | | | | | Expected HTTP Code |
|
| 3015 | | | | | |
|
| 3016 | | | | | 200 |
|
| 3017 | | | | | |
|
| 3018 | | | | | Explicit HTTP |
|
| 3019 | | | | | Error Codes |
|
| 3020 | | | | | |
|
| 3021 | | | | | 403 |
|
| 3022 | | | | | |
|
| 3023 | | | | | ContentType: |
|
| 3024 | | | | | |
|
| 3025 | | | | | ` <./example/YXBwb |
|
| 3026 | | | | | GljYXRpb24vQ3JlZFJ |
|
| 3027 | | | | | lcXVlc3QranNvbjtxP |
|
| 3028 | | | | | TEuMDtjaGFyc2V0PXV |
|
| 3029 | | | | | 0Zi04O3ZlcnNpb249M |
|
| 3030 | | | | | i4wLGFwcGxpY2F0aW9 |
|
| 3031 | | | | | uL2pzb247cT0xLjA7d |
|
| 3032 | | | | | mVyc2lvbj0yLjAsKi8 |
|
| 3033 | | | | | qO3E9MS4w>`__\ app |
|
| 3034 | | | | | lication/CredReque |
|
| 3035 | | | | | st+json;q=1.0;char |
|
| 3036 | | | | | set=utf-8;version= |
|
| 3037 | | | | | 2.0,application/js |
|
| 3038 | | | | | on;q=1.0;version=2 |
|
| 3039 | | | | | .0,\*/\*;q=1.0 |
|
| 3040 | | | | | |
|
| 3041 | | | | | ` <./example/YXBwb |
|
| 3042 | | | | | GljYXRpb24vQ3JlZFJ |
|
| 3043 | | | | | lcXVlc3QreG1sO3E9M |
|
| 3044 | | | | | S4wO2NoYXJzZXQ9dXR |
|
| 3045 | | | | | mLTg7dmVyc2lvbj0yL |
|
| 3046 | | | | | jAsdGV4dC94bWw7cT0 |
|
| 3047 | | | | | xLjA7dmVyc2lvbj0yL |
|
| 3048 | | | | | jA=>`__\ applicati |
|
| 3049 | | | | | on/CredRequest+xml |
|
| 3050 | | | | | ;q=1.0;charset=utf |
|
| 3051 | | | | | -8;version=2.0,tex |
|
| 3052 | | | | | t/xml;q=1.0;versio |
|
| 3053 | | | | | n=2.0 |
|
| 3054 | +--------------------+--------------------+--------------------+--------------------+
|
| 3055 | | | GET | /authz/users/:user | Get if User is In |
|
| 3056 | | | | /:role | Role |
|
| 3057 | | | | | |
|
| 3058 | | | | | Accept: |
|
| 3059 | | | | | |
|
| 3060 | | | | | ` <./example/YXBwb |
|
| 3061 | | | | | GljYXRpb24vVXNlcnM |
|
| 3062 | | | | | ranNvbjtxPTEuMDtja |
|
| 3063 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 3064 | | | | | lcnNpb249Mi4wLGFwc |
|
| 3065 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 3066 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 3067 | | | | | j0yLjAsKi8qO3E9MS4 |
|
| 3068 | | | | | w>`__\ application |
|
| 3069 | | | | | /Users+json;q=1.0; |
|
| 3070 | | | | | charset=utf-8;vers |
|
| 3071 | | | | | ion=2.0,applicatio |
|
| 3072 | | | | | n/json;q=1.0;versi |
|
| 3073 | | | | | on=2.0,\*/\*;q=1.0 |
|
| 3074 | | | | | |
|
| 3075 | | | | | ` <./example/YXBwb |
|
| 3076 | | | | | GljYXRpb24vVXNlcnM |
|
| 3077 | | | | | reG1sO3E9MS4wO2NoY |
|
| 3078 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 3079 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 3080 | | | | | C94bWw7cT0xLjA7dmV |
|
| 3081 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 3082 | | | | | application/Users |
|
| 3083 | | | | | +xml;q=1.0;charset |
|
| 3084 | | | | | =utf-8;version=2.0 |
|
| 3085 | | | | | ,text/xml;q=1.0;ve |
|
| 3086 | | | | | rsion=2.0 |
|
| 3087 | +--------------------+--------------------+--------------------+--------------------+
|
| 3088 | | | GET | /authz/users/perm/ | Get Users By |
|
| 3089 | | | | :type/:instance/:a | Permission |
|
| 3090 | | | | ction | |
|
| 3091 | | | | | List all Users |
|
| 3092 | | | | | that have |
|
| 3093 | | | | | Permission |
|
| 3094 | | | | | specified by :type |
|
| 3095 | | | | | :instance :action |
|
| 3096 | | | | | |
|
| 3097 | | | | | -------------- |
|
| 3098 | | | | | |
|
| 3099 | | | | | Parameters |
|
| 3100 | | | | | |
|
| 3101 | | | | | type : string |
|
| 3102 | | | | | (Required) |
|
| 3103 | | | | | |
|
| 3104 | | | | | instance : string |
|
| 3105 | | | | | (Required) |
|
| 3106 | | | | | |
|
| 3107 | | | | | action : string |
|
| 3108 | | | | | (Required) |
|
| 3109 | | | | | |
|
| 3110 | | | | | Expected HTTP Code |
|
| 3111 | | | | | |
|
| 3112 | | | | | 200 |
|
| 3113 | | | | | |
|
| 3114 | | | | | Explicit HTTP |
|
| 3115 | | | | | Error Codes |
|
| 3116 | | | | | |
|
| 3117 | | | | | 404, 406 |
|
| 3118 | | | | | |
|
| 3119 | | | | | Accept: |
|
| 3120 | | | | | |
|
| 3121 | | | | | ` <./example/YXBwb |
|
| 3122 | | | | | GljYXRpb24vVXNlcnM |
|
| 3123 | | | | | ranNvbjtxPTEuMDtja |
|
| 3124 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 3125 | | | | | lcnNpb249Mi4wLGFwc |
|
| 3126 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 3127 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 3128 | | | | | j0yLjAsKi8qO3E9MS4 |
|
| 3129 | | | | | w>`__\ application |
|
| 3130 | | | | | /Users+json;q=1.0; |
|
| 3131 | | | | | charset=utf-8;vers |
|
| 3132 | | | | | ion=2.0,applicatio |
|
| 3133 | | | | | n/json;q=1.0;versi |
|
| 3134 | | | | | on=2.0,\*/\*;q=1.0 |
|
| 3135 | | | | | |
|
| 3136 | | | | | ` <./example/YXBwb |
|
| 3137 | | | | | GljYXRpb24vVXNlcnM |
|
| 3138 | | | | | reG1sO3E9MS4wO2NoY |
|
| 3139 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 3140 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 3141 | | | | | C94bWw7cT0xLjA7dmV |
|
| 3142 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 3143 | | | | | application/Users |
|
| 3144 | | | | | +xml;q=1.0;charset |
|
| 3145 | | | | | =utf-8;version=2.0 |
|
| 3146 | | | | | ,text/xml;q=1.0;ve |
|
| 3147 | | | | | rsion=2.0 |
|
| 3148 | +--------------------+--------------------+--------------------+--------------------+
|
| 3149 | | | GET | /authz/users/role/ | Get Users By Role |
|
| 3150 | | | | :role | |
|
| 3151 | | | | | Returns the User |
|
| 3152 | | | | | (with Expiration |
|
| 3153 | | | | | date from listed |
|
| 3154 | | | | | User/Role) if it |
|
| 3155 | | | | | exists |
|
| 3156 | | | | | |
|
| 3157 | | | | | -------------- |
|
| 3158 | | | | | |
|
| 3159 | | | | | Parameters |
|
| 3160 | | | | | |
|
| 3161 | | | | | user : string |
|
| 3162 | | | | | (Required) |
|
| 3163 | | | | | |
|
| 3164 | | | | | role : string |
|
| 3165 | | | | | (Required) |
|
| 3166 | | | | | |
|
| 3167 | | | | | Expected HTTP Code |
|
| 3168 | | | | | |
|
| 3169 | | | | | 200 |
|
| 3170 | | | | | |
|
| 3171 | | | | | Explicit HTTP |
|
| 3172 | | | | | Error Codes |
|
| 3173 | | | | | |
|
| 3174 | | | | | 403, 404, 406 |
|
| 3175 | | | | | |
|
| 3176 | | | | | Accept: |
|
| 3177 | | | | | |
|
| 3178 | | | | | ` <./example/YXBwb |
|
| 3179 | | | | | GljYXRpb24vVXNlcnM |
|
| 3180 | | | | | ranNvbjtxPTEuMDtja |
|
| 3181 | | | | | GFyc2V0PXV0Zi04O3Z |
|
| 3182 | | | | | lcnNpb249Mi4wLGFwc |
|
| 3183 | | | | | GxpY2F0aW9uL2pzb24 |
|
| 3184 | | | | | 7cT0xLjA7dmVyc2lvb |
|
| 3185 | | | | | j0yLjAsKi8qO3E9MC4 |
|
| 3186 | | | | | y>`__\ application |
|
| 3187 | | | | | /Users+json;q=1.0; |
|
| 3188 | | | | | charset=utf-8;vers |
|
| 3189 | | | | | ion=2.0,applicatio |
|
| 3190 | | | | | n/json;q=1.0;versi |
|
| 3191 | | | | | on=2.0,\*/\*;q=0.2 |
|
| 3192 | | | | | |
|
| 3193 | | | | | ` <./example/YXBwb |
|
| 3194 | | | | | GljYXRpb24vVXNlcnM |
|
| 3195 | | | | | reG1sO3E9MS4wO2NoY |
|
| 3196 | | | | | XJzZXQ9dXRmLTg7dmV |
|
| 3197 | | | | | yc2lvbj0yLjAsdGV4d |
|
| 3198 | | | | | C94bWw7cT0xLjA7dmV |
|
| 3199 | | | | | yc2lvbj0yLjA=>`__\ |
|
| 3200 | | | | | application/Users |
|
| 3201 | | | | | +xml;q=1.0;charset |
|
| 3202 | | | | | =utf-8;version=2.0 |
|
| 3203 | | | | | ,text/xml;q=1.0;ve |
|
| 3204 | | | | | rsion=2.0 |
|
| 3205 | +--------------------+--------------------+--------------------+--------------------+
|
| 3206 |
|