API Documentation for PasswordAuthenticator

cbhank · March 1, 2020, 5:05pm

Hello. Recently I’ve been getting into the python API but I noticed that there doesn’t seem to be raw API documentation for PasswordAuthenticator. I specifically needed to know what the names of the arguments to the constructor were so I could **kwargs it up in my script. I finally found it by reading the code here:

github.com

couchbase/couchbase-python-client/blob/0d6d7bc3a4c765739de97789c6eb93a9425976cc/couchbase_core/cluster.py#L433


        else:
            result.update(self.get_cred_not_bucket())
        return result


    def supports_tls(self):
        return True
    def supports_non_tls(self):
        return True




class PasswordAuthenticator(Authenticator):
    def __init__(self, username, password, cert_path=None):
        """
        This class uses a single credential pair of username and password, and
        is designed to be used either with cluster management operations or
        with Couchbase 5.0 style usernames with role based access control.


        For older cluster versions, or if you are only using a bucket's "SASL"
        password, use :class:`~.ClassicAuthenticator`


        :param username:

But ideally I shouldn’t have to dig through that to find what I need. Can you add this to the readthedocs site for the API?

ellis.breen · March 2, 2020, 6:08pm

Certainly, apologies for the accidental removal of this from our docs index.

cbhank · March 3, 2020, 2:23am

No problem thanks for the reply!

Topic		Replies	Views
Authentication in the PHP SDK & documentation Sources PHP SDK	4	2360	March 8, 2017
Trying to use Python to connect via TLS to Couchbase Server Python SDK	10	5084	December 31, 2019
Python 4.1.1 SDK and connecting to Servers with version less than 6.6 Python SDK connections	5	1462	March 27, 2023
Connecting to 6.0.0 Community with Python SDK3.0.0b3 Python SDK	11	2246	August 14, 2020
Data Insert on Single Node Down Couchbase Server sdk , python	9	461	December 10, 2023

API Documentation for PasswordAuthenticator

Related topics