openstack/python-keystoneclient
Code Issues Proposed changes

Document the auth plugins that are loadable by name

Browse Source 
These are the plugins that will be available for use by auth_token
middleware and other services as they adopt sessions.

There needs to be a good way to document the config parameters that each
plugin exposes, because these are not necessarily the same as what are
available via __init__.

Change-Id: I4ad8ea89381be7571c8a30a6fcd9162c259eb581
This commit is contained in:
Jamie Lennox
2014-12-15 11:30:59 +10:00
parent 9eec63c3b6
commit 354c1f4e27
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -119,6 +119,22 @@ access token's key and secret. For example::
>>> s = session.Session(auth=a)
Loading Plugins by Name
=======================
In auth_token middleware and for some service to service communication it is
possible to specify a plugin to load via name. The authentication options that
are available are then specific to the plugin that you specified. Currently the
authentication plugins that are available in `keystoneclient` are:
- password: :py:class:`keystoneclient.auth.identity.generic.Password`
- token: :py:class:`keystoneclient.auth.identity.generic.Token`
- v2password: :py:class:`keystoneclient.auth.identity.v2.Password`
- v2token: :py:class:`keystoneclient.auth.identity.v2.Token`
- v3password: :py:class:`keystoneclient.auth.identity.v3.Password`
- v3token: :py:class:`keystoneclient.auth.identity.v3.Token`
Creating Authentication Plugins
===============================