Add documentation and release note for app creds

Now that we can authenticate with application credentials using ksa,
we should add some documentation and a release note for users.

bp application-credentials

Change-Id: I5584b93a987246f9d527e22a13fb1b13df701822
This commit is contained in:
Lance Bragstad 2018-01-19 17:47:17 +00:00 committed by Colleen Murphy
parent c2ae9e298e
commit 3bd74f28ca
2 changed files with 32 additions and 0 deletions

View File

@ -59,6 +59,8 @@ this V3 defines a number of different
a V3 identity service using Time-Based One-Time Password (TOTP).
- :py:class:`~keystoneauth1.identity.v3.TokenlessAuth`: Authenticate against
a V3 identity service using tokenless authentication.
- :py:class:`~keystoneauth1.identity.v3.ApplicationCredentialMethod`:
Authenticate against a V3 identity service using an application credential.
- :py:class:`~keystoneauth1.extras.kerberos.KerberosMethod`: Authenticate
against a V3 identity service using Kerberos.
@ -179,6 +181,29 @@ access token's key and secret. For example::
>>> s = session.Session(auth=a)
Application Credentials
=======================
There is a specific authentication method for interacting with Identity servers
that support application credential authentication. Since application
credentials are associated to a user on a specific project, some parameters are
not required as they would be with traditional password authentication. The
following method can be used to authenticate for a token using an application
credential::
- :py:class:`~keystoneauth1.identity.v3.ApplicationCredential`:
The following example shows the method usage with a session::
>>> from keystoneauth1 import session
>>> from keystone.identity import v3
>>> auth = v3.ApplicationCredential(
application_credential_secret='application_credential_secret',
application_credential_id='c2872b920853478292623be94b657090'
)
>>> sess = session.Session(auth=auth)
Tokenless Auth
==============

View File

@ -0,0 +1,7 @@
---
features:
- |
[`blueprint application-credentials <https://blueprints.launchpad.net/keystone/+spec/application-credentials>`_]
Support for authentication via an application credential has been added.
Keystoneauth can now be used to authenticate to Identity servers that
support application credentials.