QOAuth2DeviceAuthorizationFlow Class

m_deviceFlow.setAuthorizationUrl(QUrl(authorizationUrl));
m_deviceFlow.setTokenUrl(QUrl(accessTokenUrl));
m_deviceFlow.setRequestedScope({scope});
m_deviceFlow.setClientIdentifier(clientIdentifier);
// The need for a client secret depends on the authorization server
m_deviceFlow.setClientIdentifierSharedKey(clientSecret);

connect(&m_deviceFlow, &QOAuth2DeviceAuthorizationFlow::authorizeWithUserCode, this,
    [](const QUrl &verificationUrl, const QString &userCode, const QUrl &completeVerificationUrl) {
        if (completeVerificationUrl.isValid()) {
            // If the authorization server provided a complete URL
            // that already contains the necessary data as part of the URL parameters,
            // you can choose to use that
            qDebug() << "Complete verification uri:" << completeVerificationUrl;
        } else {
            // Authorization server provided only verification URL; use that
            qDebug() << "Verification uri and usercode:" << verificationUrl << userCode;
        }
    }
);

connect(&m_deviceFlow, &QAbstractOAuth::requestFailed, this, [](QAbstractOAuth::Error error) {
    Q_UNUSED(error);
    // Handle error
});

connect(&m_deviceFlow, &QAbstractOAuth2::serverReportedErrorOccurred, this,
    [](const QString &error, const QString &errorDescription, const QUrl &uri) {
        // Check server reported error details if needed
        Q_UNUSED(error);
        Q_UNUSED(errorDescription);
        Q_UNUSED(uri);
    }
);

connect(&m_deviceFlow, &QAbstractOAuth::granted, this, [this](){
    // Here we use QNetworkRequestFactory to store the access token
    m_api.setBearerToken(m_deviceFlow.token().toLatin1());
});
m_deviceFlow.grant();

Member Function Documentation

QOAuth2DeviceAuthorizationFlow::QOAuth2DeviceAuthorizationFlow()

Constructs a QOAuth2DeviceAuthorizationFlow object.

[explicit] QOAuth2DeviceAuthorizationFlow::QOAuth2DeviceAuthorizationFlow(QObject *parent)

Constructs a QOAuth2DeviceAuthorizationFlow object with parent object parent.

[explicit] QOAuth2DeviceAuthorizationFlow::QOAuth2DeviceAuthorizationFlow(QNetworkAccessManager *manager, QObject *parent = nullptr)

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

[override virtual noexcept] QOAuth2DeviceAuthorizationFlow::~QOAuth2DeviceAuthorizationFlow()

Destroys the QOAuth2DeviceAuthorizationFlow instance.

[signal] void QOAuth2DeviceAuthorizationFlow::authorizeWithUserCode(const QUrl &verificationUrl, const QString &userCode, const QUrl &completeVerificationUrl)

This signal is emitted when user should complete the authorization.

If authorization server has provided completeVerificationUrl, user can navigate to that URL. The URL contains the needed userCode and any other needed parameters.

Alternatively, the user needs to navigate to verificationUrl and enter userCode manually.

See also Device Flow Usage.

[override virtual slot] void QOAuth2DeviceAuthorizationFlow::grant()

Reimplements: QAbstractOAuth::grant().

Starts the authorization flow as described in Device Grant RFC.

The flow consists of following steps:

• Authorization request to the authorization server
• User authorizing the access, see authorizeWithUserCode()
• Polling the authorization server until user has accepted or rejected the authorization (or codes expire)
• Indicating the result to the application (see granted() and QAbstractOAuth::requestFailed())

The flow progresses automatically from authorization to token polling.

Calling this function will reset any previous authorization data.

See also authorizeWithUserCode(), granted(), QAbstractOAuth::requestFailed(), isPolling, startTokenPolling(), stopTokenPolling(), and Device Flow Usage.

[slot] void QOAuth2DeviceAuthorizationFlow::refreshAccessToken()

Call this function to refresh the tokens.

If the refresh request was initiated successfully, the status is set to QAbstractOAuth::Status::RefreshingToken; otherwise the requestFailed() signal is emitted and the status is not changed. Tokens cannot be refreshed while isPolling is true.

This function has no effect if the token refresh process is already in progress.

If refreshing the token fails and an access token exists, the status is set to QAbstractOAuth::Status::Granted, and to QAbstractOAuth::Status::NotAuthenticated if an access token does not exist.

See also QAbstractOAuth::requestFailed().

[slot] bool QOAuth2DeviceAuthorizationFlow::startTokenPolling()

Starts token polling. Returns true if the start was successful (or was already active), and false otherwise.

Calling this function is not necessary in a typical use case. Once the authorization request has completed, as a result of grant() call, the polling is started automatically.

This function can be useful in cases where resuming (retrying) the token polling a bit later is needed, without restarting the whole authorization flow. For example in case of a transient network connectivity loss.

Polling interval is defined by the authorization server, and is typically 5 seconds. First poll request is sent once the first interval has elapsed.

See also isPolling, stopTokenPolling(), and Device Flow Usage.

[slot] void QOAuth2DeviceAuthorizationFlow::stopTokenPolling()

Stops token polling. Any potential outstanding poll requests are silently discarded.

See also isPolling and startTokenPolling().