PySide6.QtNetworkAuth.QOAuth2AuthorizationCodeFlow

class QOAuth2AuthorizationCodeFlow

The QOAuth2AuthorizationCodeFlow class provides an implementation of the Authorization Code Grant flow. More…

Inheritance diagram of PySide6.QtNetworkAuth.QOAuth2AuthorizationCodeFlow

Synopsis

Properties

  • accessTokenUrlᅟ - This property holds the URL used to convert the temporary code received during the authorization response

Methods

Slots

Signals

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

This class implements the Authorization Code Grant flow, which is used both to obtain and to refresh access tokens. It is a redirection-based flow so the user will need access to a web browser.

As a redirection-based flow this class requires a proper reply handler to be set. See Qt OAuth2 Overview , QOAuthHttpServerReplyHandler , and QOAuthUriSchemeReplyHandler .

class PkceMethod

List of available Proof Key for Code Exchange (PKCE) methods .

PKCE is a security measure to mitigate the risk of authorization code interception attacks . As such it is relevant for OAuth2 “Authorization Code” flow (grant) and in particular with native applications.

PKCE inserts additional parameters into authorization and access token requests. With the help of these parameters the authorization server is able to verify that an access token request originates from the same entity that issued the authorization request.

Constant

Description

QOAuth2AuthorizationCodeFlow.PkceMethod.None_

PKCE is not used.

QOAuth2AuthorizationCodeFlow.PkceMethod.Plain

The Plain PKCE method is used. Use this only if it is not possible to use S256. With Plain method the code challenge equals to the code verifier .

QOAuth2AuthorizationCodeFlow.PkceMethod.S256

The S256 PKCE method is used. This is the default and the recommended method for native applications. With the S256 method the code challenge is a base64url-encoded value of the SHA-256 of the code verifier.

See also

setPkceMethod() pkceMethod()

Added in version 6.8.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property accessTokenUrlᅟ: QUrl

This property holds This property holds the URL used to convert the temporary code received during the authorization response..

See also: Access Token Request

Access functions:
__init__([parent=None])
Parameters:

parent – QObject

Constructs a QOAuth2AuthorizationCodeFlow object with parent object parent.

__init__(manager[, parent=None])
Parameters:

Constructs a QOAuth2AuthorizationCodeFlow object using parent as parent and sets manager as the network access manager.

__init__(clientIdentifier, manager[, parent=None])
Parameters:

Constructs a QOAuth2AuthorizationCodeFlow object using parent as parent and sets manager as the network access manager. The client identifier is set to clientIdentifier.

__init__(authorizationUrl, accessTokenUrl, manager[, parent=None])
Parameters:

Constructs a QOAuth2AuthorizationCodeFlow object using parent as parent and sets manager as the network access manager. The authenticate URL is set to authenticateUrl and the access token URL is set to accessTokenUrl.

__init__(clientIdentifier, authorizationUrl, accessTokenUrl, manager[, parent=None])
Parameters:

Constructs a QOAuth2AuthorizationCodeFlow object using parent as parent and sets manager as the network access manager. The client identifier is set to clientIdentifier the authenticate URL is set to authenticateUrl and the access token URL is set to accessTokenUrl.

accessTokenUrl()
Return type:

QUrl

Returns the URL used to request the access token.

Getter of property accessTokenUrlᅟ .

accessTokenUrlChanged(accessTokenUrl)
Parameters:

accessTokenUrl – QUrl

Notification signal of property accessTokenUrlᅟ .

buildAuthenticateUrl([parameters={}])
Parameters:

parameters – .QMultiMapQString,QVariant

Return type:

QUrl

Generates an authentication URL to be used in the Authorization Request using parameters.

pkceMethod()
Return type:

PkceMethod

Returns the current PKCE method.

refreshAccessToken()

Call this function to refresh the token. Access tokens are not permanent. After a time specified along with the access token when it was obtained, the access token will become invalid.

If refreshing the token fails and an access token exists, the status is set to Granted , and to NotAuthenticated otherwise.

requestAccessToken(code)
Parameters:

code – str

Requests an access token from the received code. The code is received as a response when the user completes a successful authentication in the browser.

setAccessTokenUrl(accessTokenUrl)
Parameters:

accessTokenUrl – QUrl

Sets the URL used to request the access token to accessTokenUrl.

See also

accessTokenUrl()

Setter of property accessTokenUrlᅟ .

setPkceMethod(method[, length=43])
Parameters:

Sets the current PKCE method to method.

Optionally, the length parameter can be used to set the length of the code_verifier. The value must be between 43 and 128 bytes. The ‘code verifier’ itself is random-generated by the library.