QAbstractOAuth

The QAbstractOAuth class is the base of all implementations of OAuth authentication methods. More

Inheritance diagram of PySide6.QtNetworkAuth.QAbstractOAuth

Inherited by: QOAuth1, QAbstractOAuth2, QOAuth2AuthorizationCodeFlow

Synopsis

Functions

Virtual functions

Signals

Static functions

Detailed Description

The class defines the basic interface of the OAuth authentication classes. By inheriting this class, you can create custom authentication methods for different web services.

It also contains some functions to ease the process of implementing different authentication flows.

class PySide6.QtNetworkAuth.QAbstractOAuth
PySide6.QtNetworkAuth.QAbstractOAuth.Status

Indicates the current authentication status.

Constant

Description

QAbstractOAuth.Status.NotAuthenticated

No token has been retrieved.

QAbstractOAuth.Status.TemporaryCredentialsReceived

Temporary credentials have been received, this status is used in some OAuth authetication methods.

QAbstractOAuth.Status.Granted

Token credentials have been received and authenticated calls are allowed.

QAbstractOAuth.Status.RefreshingToken

New token credentials have been requested.

PySide6.QtNetworkAuth.QAbstractOAuth.Stage

Identifies an authentication stage. It’s passed to a modifyParametersFunction so that it can make different changes to parameters at each call to it during the process of authentication.

Constant

Description

QAbstractOAuth.Stage.RequestingTemporaryCredentials

Preparing the temporary credentials request.

QAbstractOAuth.Stage.RequestingAuthorization

Preparing the authorization grant URL.

QAbstractOAuth.Stage.RequestingAccessToken

Preparing the token request.

QAbstractOAuth.Stage.RefreshingAccessToken

Preparing the access token refresh.

PySide6.QtNetworkAuth.QAbstractOAuth.Error

Indicates the latest received error.

Constant

Description

QAbstractOAuth.Error.NoError

No error has ocurred.

QAbstractOAuth.Error.NetworkError

Failed to connect to the server.

QAbstractOAuth.Error.ServerError

The server answered the request with an error.

QAbstractOAuth.Error.OAuthTokenNotFoundError

The server’s response to a token request provided no token identifier.

QAbstractOAuth.Error.OAuthTokenSecretNotFoundError

The server’s response to a token request provided no token secret.

QAbstractOAuth.Error.OAuthCallbackNotVerified

The authorization server has not verified the supplied callback URI in the request. This usually happens when the provided callback does not match with the callback supplied during client registration.

PySide6.QtNetworkAuth.QAbstractOAuth.ContentType

Indicates the MIME Content-Type of the POST methods in authenticated calls.

Constant

Description

QAbstractOAuth.ContentType.WwwFormUrlEncoded

Uses application/x-www-form-urlencoded format.

QAbstractOAuth.ContentType.Json

Uses application/json format.

PySide6.QtNetworkAuth.QAbstractOAuth.authorizationUrl()
Return type

PySide6.QtCore.QUrl

This property holds This property holds the URL used to request the Resource Owner Authorization as described in: The OAuth 1.0 Protocol: Resource Owner Authorization .

PySide6.QtNetworkAuth.QAbstractOAuth.authorizationUrlChanged(url)
Parameters

urlPySide6.QtCore.QUrl

PySide6.QtNetworkAuth.QAbstractOAuth.authorizeWithBrowser(url)
Parameters

urlPySide6.QtCore.QUrl

PySide6.QtNetworkAuth.QAbstractOAuth.callback()
Return type

str

Returns the current callback string corresponding to the current reply handler. The returned string is the string sent to the server to specify the callback URI, or the word identifying the alternative method in headless devices.

PySide6.QtNetworkAuth.QAbstractOAuth.clientIdentifier()
Return type

str

PySide6.QtNetworkAuth.QAbstractOAuth.clientIdentifierChanged(clientIdentifier)
Parameters

clientIdentifier – str

PySide6.QtNetworkAuth.QAbstractOAuth.contentType()
Return type

ContentType

This property holds The Content-Type to use when sending authorization parameters..

This property controls how parameters are formatted when sent with a POST request. A suitable header is also added.

PySide6.QtNetworkAuth.QAbstractOAuth.contentTypeChanged(contentType)
Parameters

contentTypeContentType

PySide6.QtNetworkAuth.QAbstractOAuth.deleteResource(url[, parameters=QVariantMap()])
Parameters
Return type

PySide6.QtNetwork.QNetworkReply

Sends an authenticated DELETE request and returns a new QNetworkReply . The url and parameters are used to create the request.

See also: Hypertext Transfer Protocol – HTTP/1.1: DELETE

PySide6.QtNetworkAuth.QAbstractOAuth.extraTokens()
Return type

This property holds This property holds the extra tokens received from the server..

PySide6.QtNetworkAuth.QAbstractOAuth.extraTokensChanged(tokens)
Parameters

tokens

PySide6.QtNetworkAuth.QAbstractOAuth.finished(reply)
Parameters

replyPySide6.QtNetwork.QNetworkReply

static PySide6.QtNetworkAuth.QAbstractOAuth.generateRandomString(length)
Parameters

lengthquint8

Return type

PySide6.QtCore.QByteArray

Generates a random string which could be used as state or nonce. The parameter length determines the size of the generated string.

See also: The OAuth 1.0 Protocol: Nonce and Timestamp .

PySide6.QtNetworkAuth.QAbstractOAuth.get(url[, parameters=QVariantMap()])
Parameters
Return type

PySide6.QtNetwork.QNetworkReply

Sends an authenticated GET request and returns a new QNetworkReply . The url and parameters are used to create the request.

See also: Hypertext Transfer Protocol – HTTP/1.1: GET

PySide6.QtNetworkAuth.QAbstractOAuth.grant()

Override this function to implement the corresponding authentication flow in the subclasses. Client code calls this function to start the authentication workflow. This may require user interaction: for example, asking the user’s authorization via a web browser. When the authentication succeeds, it should emit granted() ; this gives notice that credentials are ready to be used in authenticated calls.

PySide6.QtNetworkAuth.QAbstractOAuth.granted()
PySide6.QtNetworkAuth.QAbstractOAuth.head(url[, parameters=QVariantMap()])
Parameters
Return type

PySide6.QtNetwork.QNetworkReply

Sends an authenticated HEAD request and returns a new QNetworkReply . The url and parameters are used to create the request.

See also: Hypertext Transfer Protocol – HTTP/1.1: HEAD

PySide6.QtNetworkAuth.QAbstractOAuth.networkAccessManager()
Return type

PySide6.QtNetwork.QNetworkAccessManager

Returns the current network access manager used to send the requests to the server during authentication flows or to make authentication calls.

See also

setNetworkAccessManager() QNetworkAccessManager

PySide6.QtNetworkAuth.QAbstractOAuth.post(url[, parameters=QVariantMap()])
Parameters
Return type

PySide6.QtNetwork.QNetworkReply

Sends an authenticated POST request and returns a new QNetworkReply . The url and parameters are used to create the request.

See also: Hypertext Transfer Protocol – HTTP/1.1: POST

PySide6.QtNetworkAuth.QAbstractOAuth.prepareRequest(request, verb[, body=QByteArray()])
Parameters

Authorizes the given request by adding a header and body to it required for authenticated requests.

The verb must be a valid HTTP verb and the same as the one that will be used to send the request.

PySide6.QtNetworkAuth.QAbstractOAuth.put(url[, parameters=QVariantMap()])
Parameters
Return type

PySide6.QtNetwork.QNetworkReply

Sends an authenticated PUT request and returns a new QNetworkReply . The url and parameters are used to create the request.

See also: Hypertext Transfer Protocol – HTTP/1.1: PUT

PySide6.QtNetworkAuth.QAbstractOAuth.replyDataReceived(data)
Parameters

dataPySide6.QtCore.QByteArray

PySide6.QtNetworkAuth.QAbstractOAuth.replyHandler()
Return type

PySide6.QtNetworkAuth.QAbstractOAuthReplyHandler

Returns the reply handler currently in use.

PySide6.QtNetworkAuth.QAbstractOAuth.requestFailed(error)
Parameters

errorError

PySide6.QtNetworkAuth.QAbstractOAuth.resourceOwnerAuthorization(url, parameters)
Parameters

Builds the resource owner authorization URL to be used in the web browser: url is used as the base URL and the query is created using parameters. When the URL is ready, the authorizeWithBrowser() signal will be emitted with the generated URL.

PySide6.QtNetworkAuth.QAbstractOAuth.setAuthorizationUrl(url)
Parameters

urlPySide6.QtCore.QUrl

This property holds This property holds the URL used to request the Resource Owner Authorization as described in: The OAuth 1.0 Protocol: Resource Owner Authorization .

PySide6.QtNetworkAuth.QAbstractOAuth.setClientIdentifier(clientIdentifier)
Parameters

clientIdentifier – str

PySide6.QtNetworkAuth.QAbstractOAuth.setContentType(contentType)
Parameters

contentTypeContentType

This property holds The Content-Type to use when sending authorization parameters..

This property controls how parameters are formatted when sent with a POST request. A suitable header is also added.

PySide6.QtNetworkAuth.QAbstractOAuth.setNetworkAccessManager(networkAccessManager)
Parameters

networkAccessManagerPySide6.QtNetwork.QNetworkAccessManager

Sets the network manager to networkAccessManager. QAbstractOAuth does not take ownership of networkAccessManager. If no custom network access manager is set, an internal network access manager is used. This network access manager will be used to make the request to the authentication server and the authenticated request to the web service.

See also

networkAccessManager() QNetworkAccessManager

PySide6.QtNetworkAuth.QAbstractOAuth.setReplyHandler(handler)
Parameters

handlerPySide6.QtNetworkAuth.QAbstractOAuthReplyHandler

Sets the current reply handler to handler.

Note

Does not take ownership of handler.

See also

replyHandler()

PySide6.QtNetworkAuth.QAbstractOAuth.setStatus(status)
Parameters

statusStatus

Sets the current status to status. This method is for use by classes based on QAbstractOAuth .

See also

status()

PySide6.QtNetworkAuth.QAbstractOAuth.setToken(token)
Parameters

token – str

PySide6.QtNetworkAuth.QAbstractOAuth.status()
Return type

Status

This property holds This property holds the current authentication status..

PySide6.QtNetworkAuth.QAbstractOAuth.statusChanged(status)
Parameters

statusStatus

PySide6.QtNetworkAuth.QAbstractOAuth.token()
Return type

str

PySide6.QtNetworkAuth.QAbstractOAuth.tokenChanged(token)
Parameters

token – str