Revision d29f0371 docs/astakos-api-guide.rst

b/docs/astakos-api-guide.rst
314 314
Fallback call which receives the user token or the user uuid/token pair and
315 315
returns back the token as well as information about the token holder and the
316 316
services he/she can access.
317
If not request body is provided (the request content length is missing or
318
equals to 0) the response contains only non authentication protected
319
information (the service catalog).
317 320

  
318 321
========================================= =========  ==================
319 322
Uri                                       Method     Description
......
361 364
::
362 365

  
363 366
    {"access": {
367
        "token": {
368
            "expires": "2013-06-19T15:23:59.975572+00:00",
369
            "id": "CDEe2k0T/HdiJWBMMbHyOA==",
370
            "tenant": {
371
                "id": "c18088be-16b1-4263-8180-043c54e22903",
372
                "name": "Firstname Lastname"
373
            }
374
        },
364 375
        "serviceCatalog": [
365
           {"SNF:uiURL": "https://node2.example.com/ui/",
366
            "endpoints": [{
367
                "publicURL": "https://object-store.example.synnefo.org/pithos/public/v2.0",
368
                "versionId": "v2.0"}],
369
            "endpoints_links": [],
370
            "name": "pithos_public",
371
            "type": "public"},
372
           {"SNF:uiURL": "https://node2.example.com/ui/",
373
            "endpoints": [{
374
                "publicURL": "https://object-store.example.synnefo.org/pithos/object-store/v1",
375
                "versionId": "v1"}],
376
            "endpoints_links": [],
377
            "name": "pithos_object-store",
378
            "type": "object-store"},
379
           {"SNF:uiURL": "https://node2.example.com/ui/",
380
            "endpoints": [{
381
                "publicURL": "https://object-store.example.synnefo.org/pithos/ui",
382
                "versionId": ""}],
383
            "endpoints_links": [],
384
            "name": "pithos_ui",
385
            "type": "pithos_ui"},
386
           {"SNF:uiURL": "http://localhost:8080",
387
            "endpoints": [{
388
                "publicURL": "https://accounts.example.synnefo.org/ui/v1.0",
389
                "versionId": "v1.0"}],
390
            "endpoints_links": [],
391
            "name": "astakos_ui",
392
            "type": "astakos_ui"},
393
           {"SNF:uiURL": "http://localhost:8080",
394
            "endpoints": [{
395
                "publicURL": "https://accounts.example.synnefo.org/account/v1.0",
396
                "versionId": "v1.0"}],
397
            "endpoints_links": [],
398
            "name": "astakos_account",
399
            "type": "account"},
400
           {"SNF:uiURL": "http://localhost:8080",
401
            "endpoints": [{
402
                "publicURL": "https://accounts.example.synnefo.org/identity/v2.0",
403
                "versionId": "v2.0"}],
404
            "endpoints_links": [],
405
            "name": "astakos_identity",
406
            "type": "identity"}],
407
      "token": {
408
          "expires": "2013-06-19T15:23:59.975572+00:00",
409
           "id": "CDEe2k0T/HdiJWBMMbHyOA",
410
           "tenant": {"id": "c18088be-16b1-4263-8180-043c54e22903",
411
            "name": "Firstname Lastname"}},
412
      "user": {
413
          "id": "c18088be-16b1-4263-8180-043c54e22903",
414
           "name": "Firstname Lastname",
415
           "roles": [{"id": 1, "name": "default"},
416
           "roles_links": []}}}
376
            {"endpoints_links": [],
377
             "endpoints": [{
378
                "SNF:uiURL": "https://accounts.example.synnefo.org/ui",
379
                "versionId": "v1.0",
380
                "publicURL": "https://accounts.example.synnefo.org/account/v1.0"}],
381
             "type": "account",
382
             "name": "astakos_account"},
383
            {"endpoints_links": [],
384
             "endpoints": [{
385
                 "SNF:uiURL": "https://accounts.example.synnefo.org/ui",
386
                 "versionId": "v2.0",
387
                 "publicURL": "https://accounts.example.synnefo.org/account/v2.0"}],
388
             "type": "identity",
389
             "name": "astakos_identity"},
390
            {"endpoints_links": [],
391
             "endpoints": [{
392
                 "SNF:uiURL": "https://cyclades.example.synnefo.org/ui",
393
                 "versionId": "v2.0",
394
                 "publicURL": "https://cyclades.example.synnefo.org/cyclades/compute/v2.0"}],
395
             "type": "compute",
396
             "name": "cyclades_compute"},
397
            {"endpoints_links": [],
398
             "endpoints": [{
399
                 "SNF:uiURL": "https://cyclades.example.synnefo.org/ui",
400
                 "versionId": "v1.0",
401
                 "publicURL": "https://cyclades.example.synnefo.org/cyclades/vmapi/v1.0"}],
402
             "type": "cyclades_vmapi",
403
             "name": "cyclades_vmapi"},
404
            {"endpoints_links": [],
405
             "endpoints": [{
406
                 "SNF:uiURL": "https://cyclades.example.synnefo.org/ui",
407
                 "versionId": "v1.0",
408
                 "publicURL": "https://cyclades.example.synnefo.org/cyclades/image/v1.0"}],
409
             "type": "image",
410
             "name": "cyclades_plankton"},
411
            {"endpoints_links": [],
412
             "endpoints": [{
413
                 "SNF:uiURL": "https://object-store.example.synnefo.org/ui",
414
                 "versionId": "v2.0",
415
                 "publicURL": "https://object-store.example.synnefo.org/pithos/public/v2.0"}],
416
             "type": "public",
417
             "name": "pithos_public"},
418
            {"endpoints_links": [],
419
             "endpoints": [{
420
                 "SNF:uiURL": "https://object-store.example.synnefo.org/ui",
421
                 "versionId": "v1",
422
                 "publicURL": "https://object-store.example.synnefo.org/pithos/object-store/v1"}],
423
             "type": "object-store",
424
             "name": "pithos_object-store"}],
425
         "user": {
426
             "roles_links": [],
427
             "id": "c18088be-16b1-4263-8180-043c54e22903",
428
             "roles": [{"id": 1, "name": "default"}],
429
             "name": "Firstname Lastname"}}}
417 430

  
418 431
Example xml response:
419 432

  
......
423 436

  
424 437
    <access xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
425 438
        xmlns="http://docs.openstack.org/identity/api/v2.0">
426
        <token id="CDEe2k0T/HdiJWBMMbHyOA" expires="2013-06-19T15:23:59.975572+00:00">
439
        <token id="CDEe2k0T/HdiJWBMMbHyOA==" expires="2013-06-19T15:23:59.975572+00:00">
427 440
            <tenant id="c18088be-16b1-4263-8180-043c54e22903" name="Firstname Lastname" />
428 441
        </token>
429 442
        <user id="c18088be-16b1-4263-8180-043c54e22903" name="Firstname Lastname">
......
432 445
            </roles>
433 446
        </user>
434 447
        <serviceCatalog>
435
            <service type="public" name="pithos_public" SNF:uiURL="">
436
                    <endpoint
437
                            versionId="v2.0"
438
                            publicURL="https://object-store.example.synnefo.org/pithos/public/v2.0"
448
            <service type="account" name="astakos_account">
449
                <endpoint  SNF:uiURL="https://accounts.example.synnefo.org/ui"  versionId="v1.0"  publicURL="https://accounts.example.synnefo.org/account/v1.0"  />
439 450
            </service>
440
            <service type="object-store" name="pithos_object-store" SNF:uiURL="">
441
                    <endpoint
442
                            versionId="v1"
443
                            publicURL="https://object-store.example.synnefo.org/pithos/object-store/v1"
451
            <service type="identity" name="astakos_identity">
452
                <endpoint  SNF:uiURL="https://accounts.example.synnefo.org/ui"  versionId="v2.0"  publicURL="https://accounts.example.synnefo.org/account/v2.0"  />
444 453
            </service>
445
            <service type="pithos_ui" name="pithos_ui" SNF:uiURL="">
446
                    <endpoint
447
                            versionId=""
448
                            publicURL="https://object-store.example.synnefo.org/pithos/ui"
454
            <service type="compute" name="cyclades_compute">
455
                <endpoint  SNF:uiURL="https://cyclades.example.synnefo.org/ui"  versionId="v2.0"  publicURL="https://cyclades.example.synnefo.org/cyclades/compute/v2.0"  />
449 456
            </service>
450
            <service type="astakos_ui" name="astakos_ui" SNF:uiURL="">
451
                    <endpoint
452
                            versionId="v1.0"
453
                            publicURL="https://accounts.example.synnefo.org/ui/v1.0"
457
            <service type="cyclades_vmapi" name="cyclades_vmapi">
458
                <endpoint  SNF:uiURL="https://cyclades.example.synnefo.org/ui"  versionId="v1.0"  publicURL="https://cyclades.example.synnefo.org/cyclades/vmapi/v1.0"  />
454 459
            </service>
455
            <service type="account" name="astakos_account" SNF:uiURL="">
456
                    <endpoint
457
                            versionId="v1.0"
458
                            publicURL="https://accounts.example.synnefo.org/account/v1.0"
460
            <service type="image" name="cyclades_plankton">
461
                <endpoint  SNF:uiURL="https://cyclades.example.synnefo.org/ui"  versionId="v1.0"  publicURL="https://cyclades.example.synnefo.org/cyclades/image/v1.0"  />
459 462
            </service>
460
            <service type="identity" name="astakos_identity" SNF:uiURL="">
461
                    <endpoint
462
                            versionId="v2.0"
463
                            publicURL="https://accounts.example.synnefo.org/identity/v2.0"
463
            <service type="public" name="pithos_public">
464
                <endpoint  SNF:uiURL="https://object-store.example.synnefo.org/ui"  versionId="v2.0"  publicURL="https://object-store.example.synnefo.org/pithos/public/v2.0"  />
464 465
            </service>
466
            <service type="object-store" name="pithos_object-store">
467
                <endpoint  SNF:uiURL="https://object-store.example.synnefo.org/ui"  versionId="v1"  publicURL="https://object-store.example.synnefo.org/pithos/object-store/v1"  /> </service>
465 468
        </serviceCatalog>
466 469
    </access>
467 470

  

Also available in: Unified diff