Add Proxied OpenStack API 51/87751/2
authorBin Yang <bin.yang@windriver.com>
Wed, 15 May 2019 08:38:04 +0000 (08:38 +0000)
committerBin Yang <bin.yang@windriver.com>
Wed, 15 May 2019 08:58:47 +0000 (08:58 +0000)
Add token API description

Change-Id: Ide1978cd41d611c25de6d3a2d44bc274e9b19949
Issue-ID: MULTICLOUD-283
Signed-off-by: Bin Yang <bin.yang@windriver.com>
docs/MultiCloud-APIv0-Specification.rst
docs/MultiCloud-APIv1-Specification.rst

index ea6f436..a2f0d98 100644 (file)
@@ -2682,3 +2682,106 @@ NA
 204: No content found
 
 400: failed
+
+
+
+
+14. **Proxied OpenStack APIs**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+14.1. **Tokens**
+-------------------------
+
++---------------------+----------------------------------------------------------------------------------------------+
+| **IF Definition**   | **Description**                                                                          |
++=====================+==============================================================================================+
+| URI                 | http://msb.onap.org:80/api/multicloud/v0/{cloud owner}_{region}/identity/v3/auth/tokens|
++---------------------+----------------------------------------------------------------------------------------------+
+| Operation           | POST                                                                                         |
++---------------------+----------------------------------------------------------------------------------------------+
+| Direction           | NSLCM-> MULTICLOUD                                                                           |
++---------------------+----------------------------------------------------------------------------------------------+
+
+14.1.1. **Request**
+>>>>>>>>>>>>>>>>>>>
+
++-----------------+-----------------+-------------------+---------------+-----------------------+
+| **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**       |
++=================+=================+===================+===============+=======================+
+| auth     | O               | 1                 | Object        | Same as OpenStack Identity Tokens API   |
++-----------------+-----------------+-------------------+---------------+-----------------------+
+
+::
+
+    {
+
+    }
+
+14.1.2. **Response**
+>>>>>>>>>>>>>>>>>>>>
+
+
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+| **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**         | **Description**                                      |
++=================+=================+===================+=====================+==============================================================+
+| X-Subject-Token | M               | 1                 | String              | The authentication token in Header                           |
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+| token           | O               | 1                 | Object              | Token response, the same as OpenStack Identity Tokens API    |
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+
+201: Created
+
+401: Unauthorized
+
+403: Forbidden
+
+500: failed
+
+
+::
+
+  Header:
+    X-Subject-Token: a33f3b209e9b471a97fbeab8324a9a45
+
+  Body:
+
+      {
+           "token" : {
+              "user" : {
+                 "domain" : {
+                    "id" : "default",
+                    "name" : "Default"
+                 },
+                 "id" : "9efb043c7629497a8028d7325ca1afb0",
+                 "name" : "admin"
+              },
+              "catalog" : [
+                 {
+                    "type" : "network",
+                    "endpoints" : [
+                       {
+                          "interface" : "public",
+                          "id" : "39583c1508ad4b71b380570a745ee10a",
+                          "url" : "http://172.16.77.10:80/api/multicloud-titaniumcloud/v0/CloudOwner_RegionOne/network",
+                          "region_id" : "RegionOne",
+                          "region" : "RegionOne"
+                       }
+                    ],
+                    "name" : "neutron",
+                    "id" : "99aefcc82a9246f98f8c281e61ffc754"
+                 },
+                 ...
+              ]
+              "project" : {
+                 "name" : "admin",
+                 "id" : "fcca3cc49d5e42caae15459e27103efc",
+                 "domain" : {
+                    "id" : "default",
+                    "name" : "Default"
+                 }
+              },
+              "is_domain" : false,
+              "expires_at" : "2017-09-11T03:52:29.000000Z"
+           }
+      }
+
index dc5c551..4a9f78e 100644 (file)
@@ -2544,3 +2544,103 @@ NA
 404: Not Found
 
 500: Internal Server Error
+
+
+15. **Proxied OpenStack APIs**
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+15.1. **Tokens**
+-------------------------
+
++---------------------+----------------------------------------------------------------------------------------------+
+| **IF Definition**   | **Description**                                                                          |
++=====================+==============================================================================================+
+| URI                 | http://msb.onap.org:80/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/identity/v3/auth/tokens|
++---------------------+----------------------------------------------------------------------------------------------+
+| Operation           | POST                                                                                         |
++---------------------+----------------------------------------------------------------------------------------------+
+| Direction           | NSLCM-> MULTICLOUD                                                                           |
++---------------------+----------------------------------------------------------------------------------------------+
+
+15.1.1. **Request**
+>>>>>>>>>>>>>>>>>>>
+
++-----------------+-----------------+-------------------+---------------+-----------------------+
+| **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**   | **Description**       |
++=================+=================+===================+===============+=======================+
+| auth     | O               | 1                 | Object        | Same as OpenStack Identity Tokens API   |
++-----------------+-----------------+-------------------+---------------+-----------------------+
+
+::
+
+    {
+
+    }
+
+15.1.2. **Response**
+>>>>>>>>>>>>>>>>>>>>
+
+
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+| **Parameter**   | **Qualifier**   | **Cardinality**   | **Content**         | **Description**                                      |
++=================+=================+===================+=====================+==============================================================+
+| X-Subject-Token | M               | 1                 | String              | The authentication token in Header                           |
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+| token           | O               | 1                 | Object              | Token response, the same as OpenStack Identity Tokens API    |
++-----------------+-----------------+-------------------+---------------------+--------------------------------------------------------------+
+
+201: Created
+
+401: Unauthorized
+
+403: Forbidden
+
+500: failed
+
+
+::
+
+  Header:
+    X-Subject-Token: a33f3b209e9b471a97fbeab8324a9a45
+
+  Body:
+
+      {
+           "token" : {
+              "user" : {
+                 "domain" : {
+                    "id" : "default",
+                    "name" : "Default"
+                 },
+                 "id" : "9efb043c7629497a8028d7325ca1afb0",
+                 "name" : "admin"
+              },
+              "catalog" : [
+                 {
+                    "type" : "network",
+                    "endpoints" : [
+                       {
+                          "interface" : "public",
+                          "id" : "39583c1508ad4b71b380570a745ee10a",
+                          "url" : "http://172.16.77.10:80/api/multicloud-titaniumcloud/v1/CloudOwner/RegionOne/network",
+                          "region_id" : "RegionOne",
+                          "region" : "RegionOne"
+                       }
+                    ],
+                    "name" : "neutron",
+                    "id" : "99aefcc82a9246f98f8c281e61ffc754"
+                 },
+                 ...
+              ]
+              "project" : {
+                 "name" : "admin",
+                 "id" : "fcca3cc49d5e42caae15459e27103efc",
+                 "domain" : {
+                    "id" : "default",
+                    "name" : "Default"
+                 }
+              },
+              "is_domain" : false,
+              "expires_at" : "2017-09-11T03:52:29.000000Z"
+           }
+      }

© 2017 ONAP. Copyright © The Linux Foundation ®. All Rights Reserved.
The Linux Foundation has registered trademarks and uses trademarks.
For a list of trademarks of The Linux Foundation, please see our Trademark Usage page.
Linux is a registered trademark of Linus Torvalds.
Privacy Policy and Terms of Use