Class: QgsCredentials

class qgis.core.QgsCredentials

Bases: sip.wrapper

Constructor for QgsCredentials.

Interface for requesting credentials in QGIS in GUI independent way. This class provides abstraction of a dialog for requesting credentials to the user. By default QgsCredentials will be used if not overridden with other credential creator function.

QGIS application uses QgsCredentialDialog class for displaying a dialog to the user.

Object deletes itself when it’s not needed anymore. Children should use signal destroyed() to be notified of the deletion

Enums

Methods

get Requests credentials for the specified realm.
getMasterPassword
instance retrieves instance
lock Lock the instance against access from multiple threads.
mutex Returns pointer to mutex
put Stores the correct username and password for the specified realm.
request request a password
requestMasterPassword request a master password
setInstance register instance
unlock Unlock the instance after being locked.

Signals

Attributes

get(self, realm: str, username: str, password: str, message: str = '') → Tuple[bool, str, str]

Requests credentials for the specified realm.

If existing credentials exist for the given realm, these will be returned. Otherwise the credential handler will prompt for the correct username and password.

The retrieved or user-entered details will be stored in username and password.

Optionally, a specific message can be used to advise users of the context for the credentials request.

Note

This method will not automatically store the newly obtained credentials. Callers must manually call put() after verifying that the obtained credentials are correct.

See also

put()

getMasterPassword(self, password: str, stored: bool = False) → Tuple[bool, str]
instance() → QgsCredentials

retrieves instance

lock(self)

Lock the instance against access from multiple threads. This does not really lock access to get/put methds, it will just prevent other threads to lock the instance and continue the execution. When the class is used from non-GUI threads, they should call lock() before the get/put calls to avoid race conditions.

Deprecated since version since: QGIS 3.4 - mutex locking is automatically handled

mutex(self) → QMutex

Returns pointer to mutex

Deprecated since version since: QGIS 3.4 - mutex locking is automatically handled

put(self, realm: str, username: str, password: str)

Stores the correct username and password for the specified realm.

These values will be used for all future calls to get() for the same realm, without requesting users to re-enter them. It is the caller’s responsibility to ensure that only valid username and password combinations are used with this method.

See also

get()

request(self, realm: str, username: str, password: str, message: str = '') → Tuple[bool, str, str]

request a password

requestMasterPassword(self, password: str, stored: bool = False) → Tuple[bool, str]

request a master password

setInstance(self, instance: QgsCredentials)

register instance

unlock(self)

Unlock the instance after being locked.

Deprecated since version since: QGIS 3.4 - mutex locking is automatically handled