Class: QgsAuthConfigSelect

Selector widget for authentication configs.

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Methods

clearMessage	Clear and hide small message bar
configId	Gets the authentication config id for the resource
setConfigId	Sets the authentication config id for the resource
setDataProviderKey	Sets key of layer provider, if applicable
showMessage	Show a small message bar with a close button

Signals

selectedConfigIdChanged	Emitted when authentication config is changed or missing
selectedConfigIdRemoved	Emitted when authentication config is removed

class qgis.gui.QgsAuthConfigSelect

Bases: QWidget

__init__(parent: QWidget | None = None, dataprovider: str | None = '')

Create a dialog for setting an associated authentication config, either from existing configs, or creating/removing them from auth database

Parameters:

• parent (Optional[QWidget] = None) – Parent widget

• dataprovider (Optional[str] = '') – The key of the calling layer provider, if applicable

clearMessage(self)

Clear and hide small message bar

configId(self) → str

Gets the authentication config id for the resource

Return type:

str

signal selectedConfigIdChanged(authcfg: str)

Emitted when authentication config is changed or missing

Parameters:

authcfg (str)

signal selectedConfigIdRemoved(authcfg: str)

Emitted when authentication config is removed

Parameters:

authcfg (str)

setConfigId(self, authcfg: str | None)

Sets the authentication config id for the resource

Parameters:

authcfg (Optional[str])

setDataProviderKey(self, key: str | None)

Sets key of layer provider, if applicable

Parameters:

key (Optional[str])

showMessage(self, msg: str | None)

Show a small message bar with a close button

Parameters:

msg (Optional[str])