Reorganize api-ref: v3-ext federation assertion.inc
Reorganize as per the documentation session at PTG: https://etherpad.openstack.org/p/queens-ptg-keystone-doc-cleanup Change-Id: I93e90e42bd1d384353c258d71a651b82f151bcc8
This commit is contained in:
@@ -7,8 +7,6 @@ Generate a SAML assertion
|
|||||||
|
|
||||||
.. rest_method:: POST /v3/auth/OS-FEDERATION/saml2
|
.. rest_method:: POST /v3/auth/OS-FEDERATION/saml2
|
||||||
|
|
||||||
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/saml2``
|
|
||||||
|
|
||||||
A user may generate a SAML assertion document based on the scoped token that is
|
A user may generate a SAML assertion document based on the scoped token that is
|
||||||
used in the request.
|
used in the request.
|
||||||
|
|
||||||
@@ -17,15 +15,20 @@ Request Parameters:
|
|||||||
To generate a SAML assertion, a user must provides a scoped token ID and
|
To generate a SAML assertion, a user must provides a scoped token ID and
|
||||||
Service Provider ID in the request body.
|
Service Provider ID in the request body.
|
||||||
|
|
||||||
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/saml2``
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_parameters:: federation/assertion/parameters.yaml
|
.. rest_parameters:: federation/assertion/parameters.yaml
|
||||||
|
|
||||||
- auth: auth
|
- auth: auth
|
||||||
|
|
||||||
Request Example
|
Example
|
||||||
---------------
|
~~~~~~~
|
||||||
|
|
||||||
.. literalinclude:: federation/assertion/samples/saml-assertion-request.json
|
.. literalinclude:: federation/assertion/samples/saml-assertion-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
@@ -39,13 +42,16 @@ client is finally authenticated.
|
|||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_parameters:: federation/assertion/parameters.yaml
|
.. rest_parameters:: federation/assertion/parameters.yaml
|
||||||
|
|
||||||
- Headers: headers
|
- Headers: headers
|
||||||
- xml: saml_xml
|
- xml: saml_xml
|
||||||
|
|
||||||
Response Example
|
Example
|
||||||
----------------
|
~~~~~~~
|
||||||
|
|
||||||
.. literalinclude:: federation/assertion/samples/saml-assertion-response.xml
|
.. literalinclude:: federation/assertion/samples/saml-assertion-response.xml
|
||||||
:language: xml
|
:language: xml
|
||||||
@@ -58,8 +64,6 @@ Generate an ECP wrapped SAML assertion
|
|||||||
|
|
||||||
.. rest_method:: POST /v3/auth/OS-FEDERATION/saml2/ecp
|
.. rest_method:: POST /v3/auth/OS-FEDERATION/saml2/ecp
|
||||||
|
|
||||||
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/saml2/ecp``
|
|
||||||
|
|
||||||
A user may generate a SAML assertion document to work with the
|
A user may generate a SAML assertion document to work with the
|
||||||
*Enhanced Client or Proxy* (ECP) profile based on the scoped token that is
|
*Enhanced Client or Proxy* (ECP) profile based on the scoped token that is
|
||||||
used in the request.
|
used in the request.
|
||||||
@@ -69,15 +73,20 @@ Request Parameters:
|
|||||||
To generate an ECP wrapped SAML assertion, a user must provides a scoped token
|
To generate an ECP wrapped SAML assertion, a user must provides a scoped token
|
||||||
ID and Service Provider ID in the request body.
|
ID and Service Provider ID in the request body.
|
||||||
|
|
||||||
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/saml2/ecp``
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_parameters:: federation/assertion/parameters.yaml
|
.. rest_parameters:: federation/assertion/parameters.yaml
|
||||||
|
|
||||||
- auth: auth
|
- auth: auth
|
||||||
|
|
||||||
Request Example
|
Example
|
||||||
---------------
|
~~~~~~~
|
||||||
|
|
||||||
.. literalinclude:: federation/assertion/samples/ecp-saml-assertion-request.json
|
.. literalinclude:: federation/assertion/samples/ecp-saml-assertion-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
@@ -91,13 +100,16 @@ client is finally authenticated.
|
|||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_parameters:: federation/assertion/parameters.yaml
|
.. rest_parameters:: federation/assertion/parameters.yaml
|
||||||
|
|
||||||
- Headers: headers
|
- Headers: headers
|
||||||
- xml: saml_xml
|
- xml: saml_xml
|
||||||
|
|
||||||
Response Example
|
Example
|
||||||
----------------
|
~~~~~~~
|
||||||
|
|
||||||
.. literalinclude:: federation/assertion/samples/ecp-saml-assertion-response.xml
|
.. literalinclude:: federation/assertion/samples/ecp-saml-assertion-response.xml
|
||||||
:language: xml
|
:language: xml
|
||||||
@@ -108,24 +120,27 @@ Retrieve Metadata properties
|
|||||||
|
|
||||||
.. rest_method:: GET /v3/OS-FEDERATION/saml2/metadata
|
.. rest_method:: GET /v3/OS-FEDERATION/saml2/metadata
|
||||||
|
|
||||||
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/metadata``
|
|
||||||
|
|
||||||
A user may retrieve Metadata about an Identity Service acting as an Identity
|
A user may retrieve Metadata about an Identity Service acting as an Identity
|
||||||
Provider.
|
Provider.
|
||||||
|
|
||||||
The response will be a full document with Metadata properties. Note that for
|
The response will be a full document with Metadata properties. Note that for
|
||||||
readability, this example certificate has been truncated.
|
readability, this example certificate has been truncated.
|
||||||
|
|
||||||
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/metadata``
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_parameters:: federation/assertion/parameters.yaml
|
.. rest_parameters:: federation/assertion/parameters.yaml
|
||||||
|
|
||||||
- Headers: headers
|
- Headers: headers
|
||||||
- xml: metadata_xml
|
- xml: metadata_xml
|
||||||
|
|
||||||
Response Example
|
Example
|
||||||
----------------
|
~~~~~~~
|
||||||
|
|
||||||
.. literalinclude:: federation/assertion/samples/metadata-response.xml
|
.. literalinclude:: federation/assertion/samples/metadata-response.xml
|
||||||
:language: xml
|
:language: xml
|
||||||
|
Reference in New Issue
Block a user