diff options
| author | Jamie Lennox <jamielennox@redhat.com> | 2014-12-15 11:30:59 +1000 |
|---|---|---|
| committer | Jamie Lennox <jamielennox@redhat.com> | 2014-12-17 06:23:52 +1000 |
| commit | 354c1f4e27e08bf776e6d5489359dea76cc7b70c (patch) | |
| tree | 9312dd25c936b47beb5529e7d11c2cc632a7c8b7 /doc | |
| parent | 9eec63c3b64f31759017406227b5110735be60c6 (diff) | |
| download | python-keystoneclient-354c1f4e27e08bf776e6d5489359dea76cc7b70c.tar.gz | |
Document the auth plugins that are loadable by name
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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/authentication-plugins.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/source/authentication-plugins.rst b/doc/source/authentication-plugins.rst index 41f04d8..e90e51b 100644 --- a/doc/source/authentication-plugins.rst +++ b/doc/source/authentication-plugins.rst @@ -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 =============================== |