openstack/python-keystoneclient
Code Issues Proposed changes

Merge "Add docs for how to create an OAuth auth instance"

Browse Source
This commit is contained in:
Jenkins
2014-08-05 08:08:44 +00:00
committed by Gerrit Code Review
parent c0b0009118 18253648d1
commit d0e9dc6c10
1 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/source/authentication-plugins.rst
View File

@@ -99,6 +99,26 @@ endpoint you want to communicate with.
It can be found at :py:class:`keystoneclient.auth.token_endpoint.Token`.
V3 OAuth 1.0a Plugins
---------------------
There also exists a plugin for OAuth 1.0a authentication. We provide a helper
authentication plugin at:
:py:class:`~keystoneclient.v3.contrib.oauth1.auth.OAuth`.
The plugin requires the OAuth consumer's key and secret, as well as the OAuth
access token's key and secret. For example::
>>> from keystoneclient.v3.contrib.oauth1 import auth
>>> from keystoneclient import session
>>> from keystoneclient.v3 import client
>>> a = auth.OAuth('http://my.keystone.com:5000/v3',
... consumer_key=consumer_id,
... consumer_secret=consumer_secret,
... access_key=access_token_key,
... access_secret=access_token_secret)
>>> s = session.Session(auth=a)
Creating Authentication Plugins
===============================