Update saslauth added ver. Add SaslAuth to API docs.

This commit is contained in:
Adam Holmberg
2015-01-26 15:21:05 -06:00
parent 3db158951c
commit 98e0e3259e
2 changed files with 13 additions and 4 deletions

View File

@@ -130,7 +130,9 @@ class PlainTextAuthenticator(Authenticator):
class SaslAuthProvider(AuthProvider):
"""
An :class:`~.AuthProvider` for Kerberos authenticators
An :class:`~.AuthProvider` supporting general SASL auth mechanisms
Suitable for GSSAPI or other SASL mechanisms
Example usage::
@@ -144,7 +146,7 @@ class SaslAuthProvider(AuthProvider):
auth_provider = SaslAuthProvider(**sasl_kwargs)
cluster = Cluster(auth_provider=auth_provider)
.. versionadded:: 2.1.3-post
.. versionadded:: 2.1.4
"""
def __init__(self, **sasl_kwargs):
@@ -157,9 +159,10 @@ class SaslAuthProvider(AuthProvider):
class SaslAuthenticator(Authenticator):
"""
An :class:`~.Authenticator` that works with DSE's KerberosAuthenticator.
A pass-through :class:`~.Authenticator` using the third party package
'pure-sasl' for authentication
.. versionadded:: 2.1.3-post
.. versionadded:: 2.1.4
"""
def __init__(self, host, service, mechanism='GSSAPI', **sasl_kwargs):

View File

@@ -14,3 +14,9 @@
.. autoclass:: PlainTextAuthenticator
:members:
.. autoclass:: SaslAuthProvider
:members:
.. autoclass:: SaslAuthenticator
:members: