Class: QgsAuthMethod

Abstract base class for authentication method plugins.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: clearCachedConfig(), description(), displayDescription(), key(), updateMethodConfig()

Class Hierarchy

Base classes

QObject

Abstract Methods

clearCachedConfig	Clear any cached configuration.
description	A non-translated short description representing the auth method for use in debug output and About dialog
displayDescription	Translatable display version of the 'description()'
key	A non-translated short name representing the auth method
updateMethodConfig	Update an authentication configuration in place

Methods

setDataProviders	Sets list of data providers this auth method supports
setExpansions	Sets the support expansions (points in providers where the authentication is injected) of the auth method
setVersion	Sets the version of the auth method (useful for future upgrading)
supportedDataProviders	The data providers that the method supports, allowing for filtering out authcfgs that are not applicable to a given provider, or where the updating code is not currently implemented.
supportedExpansions	Flags that represent the update points (where authentication configurations are expanded) supported by an authentication method.
version	Increment this if method is significantly updated, allow updater code to be written for previously stored authcfg

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsAuthMethod. See the FAQ for more details.

editWidget	Constructs the configuration for the authentication method
updateDataSourceUriItems	Update data source connection items with authentication components
updateNetworkProxy	Update proxy settings with authentication components
updateNetworkReply	Update a network reply with authentication components
updateNetworkRequest	Update a network request with authentication components

Static Methods

authMethodTag

Tag signifying that this is an authentcation method (e.g. for use as title in message log panel output).

Attributes

All
DataSourceUri
GenericDataSourceUri
NetworkProxy
NetworkReply
NetworkRequest

class qgis.core.QgsAuthMethod

Bases: QObject

__init__()

Construct a default authentication method

Note

Non-public since this is an abstract base class

All = 31

DataSourceUri = 4

class Expansion

Bases: int

class Expansions

class Expansions(f: QgsAuthMethod.Expansions | QgsAuthMethod.Expansion)

class Expansions(a0: QgsAuthMethod.Expansions)

Bases: object

GenericDataSourceUri = 8

NetworkProxy = 22

NetworkReply = 2

NetworkRequest = 1

static authMethodTag() → str

Tag signifying that this is an authentcation method (e.g. for use as title in message log panel output)

Return type:

str

abstract clearCachedConfig(self, authcfg: str | None)

Clear any cached configuration. Called when the QgsAuthManager deletes an authentication configuration (authcfg).

Note

It is highly recommended that a cache of authentication components (per requested authcfg) be implemented, to avoid excessive queries on the auth database. Such a cache could be as simple as a QHash or QMap of authcfg -> QgsAuthMethodConfig. See ‘Basic’ auth method plugin for example.

Parameters:

authcfg (Optional[str])

abstract description(self) → str

A non-translated short description representing the auth method for use in debug output and About dialog

Return type:

str

abstract displayDescription(self) → str

Translatable display version of the ‘description()’

Return type:

str

virtual editWidget(self, parent: QWidget | None) → QWidget | None

Constructs the configuration for the authentication method

Added in version 3.22.

Parameters:

parent (Optional[QWidget])

Return type:

Optional[QWidget]

abstract key(self) → str

A non-translated short name representing the auth method

Return type:

str

setDataProviders(self, dataproviders: Iterable[str | None])

Sets list of data providers this auth method supports

Parameters:

dataproviders (Iterable[Optional[str]])

setExpansions(self, expansions: QgsAuthMethod.Expansions | QgsAuthMethod.Expansion)

Sets the support expansions (points in providers where the authentication is injected) of the auth method

Parameters:

expansions (Union[QgsAuthMethod.Expansions, QgsAuthMethod.Expansion])

setVersion(self, version: int)

Sets the version of the auth method (useful for future upgrading)

Parameters:

version (int)

supportedDataProviders(self) → List[str]

The data providers that the method supports, allowing for filtering out authcfgs that are not applicable to a given provider, or where the updating code is not currently implemented.

Return type:

List[str]

supportedExpansions(self) → QgsAuthMethod.Expansions

Flags that represent the update points (where authentication configurations are expanded) supported by an authentication method.

Note

These should directly correlate to existing ‘update*()’ member functions

Return type:

QgsAuthMethod.Expansions

virtual updateDataSourceUriItems(self, connectionItems: Iterable[str | None], authcfg: str | None, dataprovider: str | None = '') → bool

Update data source connection items with authentication components

Parameters:

• connectionItems (Iterable[Optional[str]]) – QStringlist of ‘key=value’ pairs, as utilized in QgsDataSourceUri.connectionInfo()

• authcfg (Optional[str]) – Authentication configuration ID

• dataprovider (Optional[str] = '') – Textual key for a data provider, e.g. ‘postgres’, that allows for custom updater code specific to the provider

Return type:

bool

Returns:

Whether the update succeeded

abstract updateMethodConfig(self, mconfig: QgsAuthMethodConfig)

Update an authentication configuration in place

Note

Useful for updating previously stored authcfgs, when an authentication method has been significantly updated

Parameters:

mconfig (QgsAuthMethodConfig)

virtual updateNetworkProxy(self, proxy: QNetworkProxy, authcfg: str | None, dataprovider: str | None = '') → bool

Update proxy settings with authentication components

Parameters:

• proxy (QNetworkProxy)

• authcfg (Optional[str]) – Authentication configuration ID

• dataprovider (Optional[str] = '') – Textual key for a data provider, e.g. ‘proxy’, that allows for custom updater code specific to the provider

Return type:

bool

Returns:

Whether the update succeeded

virtual updateNetworkReply(self, reply: QNetworkReply | None, authcfg: str | None, dataprovider: str | None = '') → bool

Update a network reply with authentication components

Parameters:

• reply (Optional[QNetworkReply]) – The network reply object to update

• authcfg (Optional[str]) – Authentication configuration ID

• dataprovider (Optional[str] = '') – Textual key for a data provider, e.g. ‘postgres’, that allows for custom updater code specific to the provider

Return type:

bool

Returns:

Whether the update succeeded

virtual updateNetworkRequest(self, request: QNetworkRequest, authcfg: str | None, dataprovider: str | None = '') → bool

Update a network request with authentication components

Parameters:

• request (QNetworkRequest) – The network request to update

• authcfg (Optional[str]) – Authentication configuration ID

• dataprovider (Optional[str] = '') – Textual key for a data provider, e.g. ‘postgres’, that allows for custom updater code specific to the provider

Return type:

bool

Returns:

Whether the update succeeded

version(self) → int

Increment this if method is significantly updated, allow updater code to be written for previously stored authcfg

Return type:

int