Browse Source

Merge "Add documentation and release note for app creds"

Zuul 1 year ago
parent
commit
d4a552c2f3

+ 25
- 0
doc/source/authentication-plugins.rst View File

@@ -59,6 +59,8 @@ this V3 defines a number of different
59 59
   a V3 identity service using Time-Based One-Time Password (TOTP).
60 60
 - :py:class:`~keystoneauth1.identity.v3.TokenlessAuth`: Authenticate against
61 61
   a V3 identity service using tokenless authentication.
62
+- :py:class:`~keystoneauth1.identity.v3.ApplicationCredentialMethod`:
63
+  Authenticate against a V3 identity service using an application credential.
62 64
 - :py:class:`~keystoneauth1.extras.kerberos.KerberosMethod`: Authenticate
63 65
   against a V3 identity service using Kerberos.
64 66
 
@@ -179,6 +181,29 @@ access token's key and secret. For example::
179 181
     >>> s = session.Session(auth=a)
180 182
 
181 183
 
184
+Application Credentials
185
+=======================
186
+
187
+There is a specific authentication method for interacting with Identity servers
188
+that support application credential authentication. Since application
189
+credentials are associated to a user on a specific project, some parameters are
190
+not required as they would be with traditional password authentication. The
191
+following method can be used to authenticate for a token using an application
192
+credential::
193
+
194
+- :py:class:`~keystoneauth1.identity.v3.ApplicationCredential`:
195
+
196
+The following example shows the method usage with a session::
197
+
198
+    >>> from keystoneauth1 import session
199
+    >>> from keystone.identity import v3
200
+    >>> auth = v3.ApplicationCredential(
201
+            application_credential_secret='application_credential_secret',
202
+            application_credential_id='c2872b920853478292623be94b657090'
203
+        )
204
+    >>> sess = session.Session(auth=auth)
205
+
206
+
182 207
 Tokenless Auth
183 208
 ==============
184 209
 

+ 7
- 0
releasenotes/notes/bp-application-credentials-416a1f8bb2311e04.yaml View File

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

Loading…
Cancel
Save