Soup.AuthManager¶

Subclasses:	None

Methods¶

Inherited:	GObject.Object (37), Soup.SessionFeature (5)
Structs:	GObject.ObjectClass (5)

	`clear_cached_credentials` ()
	`use_auth` (uri, auth)

Virtual Methods¶

Inherited:	GObject.Object (7), Soup.SessionFeature (8)

do_authenticate (msg, auth, retrying)

Properties¶

None

Signals¶

Inherited:	GObject.Object (1)

Name	Short Description
`authenticate`	Emitted when the manager requires the application to provide authentication credentials.

Fields¶

Inherited:	GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Soup.AuthManager(**kwargs)¶

Bases:	`GObject.Object`, `Soup.SessionFeature`
Abstract:	No
Structure:	`Soup.AuthManagerClass`

clear_cached_credentials()¶: Clear all credentials cached by self

New in version 2.58.

use_auth(uri, auth)¶

Parameters:	uri (`Soup.URI`) – the `Soup.URI` under which auth is to be used auth (`Soup.Auth`) – the `Soup.Auth` to use

Records that auth is to be used under uri, as though a WWW-Authenticate header had been received at that URI. This can be used to “preload” self’s auth cache, to avoid an extra HTTP round trip in the case where you know ahead of time that a 401 response will be returned.

This is only useful for authentication types where the initial Authorization header does not depend on any additional information from the server. (Eg, Basic or NTLM, but not Digest.)

New in version 2.42.

do_authenticate(msg, auth, retrying) virtual¶

Parameters:	msg (`Soup.Message`) – auth (`Soup.Auth`) – retrying (`bool`) –

Signal Details¶

Soup.AuthManager.signals.authenticate(auth_manager, msg, auth, retrying)¶

Signal Name:	`authenticate`
Flags:	`RUN_FIRST`
Parameters:	auth_manager (`Soup.AuthManager`) – The object which received the signal msg (`Soup.Message`) – the `Soup.Message` being sent auth (`Soup.Auth`) – the `Soup.Auth` to authenticate retrying (`bool`) – `True` if this is the second (or later) attempt

Emitted when the manager requires the application to provide authentication credentials.

Soup.Session connects to this signal and emits its own Soup.Session ::authenticate signal when it is emitted, so you shouldn’t need to use this signal directly.