From 6bac0a1bae7bbbc7e4a7b17294a73b39db0c94f8 Mon Sep 17 00:00:00 2001 From: Suramya Shah Date: Fri, 23 Feb 2018 12:11:24 +0530 Subject: [PATCH] Consolidate oauth1.rst Consolidate from configuration.rst into oauth1.rst. Change-Id: I866e147935e5847a2feb66d61d45ef4241eb38cd --- doc/source/admin/index.rst | 1 + doc/source/admin/oauth1.rst | 36 ++++++++++++++++++++++++++++++++++ doc/source/configuration.rst | 38 ------------------------------------ 3 files changed, 37 insertions(+), 38 deletions(-) create mode 100644 doc/source/admin/oauth1.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index b719bb35a1..a1e9b7fcbc 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -41,3 +41,4 @@ command-line client. identity-credential-encryption.rst endpoint-filtering.rst health-check-middleware.rst + oauth1.rst diff --git a/doc/source/admin/oauth1.rst b/doc/source/admin/oauth1.rst new file mode 100644 index 0000000000..256dfbaabf --- /dev/null +++ b/doc/source/admin/oauth1.rst @@ -0,0 +1,36 @@ +OAuth1 1.0a +=========== + +The OAuth 1.0a feature provides the ability for Identity users to delegate +roles to third party consumers via the OAuth 1.0a specification. + +To enable OAuth1: + +1. Add the oauth1 driver to the ``[oauth1]`` section in ``keystone.conf``. For + example: + +.. code-block:: ini + + [oauth1] + driver = sql + +2. Add the ``oauth1`` authentication method to the ``[auth]`` section in + ``keystone.conf``: + +.. code-block:: ini + + [auth] + methods = external,password,token,oauth1 + +3. If deploying under Apache httpd with ``mod_wsgi``, set the + `WSGIPassAuthorization` to allow the OAuth Authorization headers to pass + through `mod_wsgi`. For example, add the following to the keystone virtual + host file: + +.. code-block:: ini + + WSGIPassAuthorization On + +See `API Specification for OAuth 1.0a `_ for the details of +API definition. \ No newline at end of file diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 740b301af8..3ca545b7ba 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -393,44 +393,6 @@ SSL A secure deployment should have keystone running in a web server (such as Apache httpd), or behind an SSL terminator. - -OAuth1 1.0a -=========== - -The OAuth 1.0a feature provides the ability for Identity users to delegate -roles to third party consumers via the OAuth 1.0a specification. - -To enable OAuth1: - -1. Add the oauth1 driver to the ``[oauth1]`` section in ``keystone.conf``. For - example: - -.. code-block:: ini - - [oauth1] - driver = sql - -2. Add the ``oauth1`` authentication method to the ``[auth]`` section in - ``keystone.conf``: - -.. code-block:: ini - - [auth] - methods = external,password,token,oauth1 - -3. If deploying under Apache httpd with ``mod_wsgi``, set the - `WSGIPassAuthorization` to allow the OAuth Authorization headers to pass - through `mod_wsgi`. For example, add the following to the keystone virtual - host file: - -.. code-block:: ini - - WSGIPassAuthorization On - -See `API Specification for OAuth 1.0a `_ for the details of -API definition. - Limiting list return size =========================