QOAuth2DeviceAuthorizationFlow Class

m_deviceFlow.setAuthorizationUrl(QUrl(authorizationUrl));
m_deviceFlow.setTokenUrl(QUrl(accessTokenUrl));
m_deviceFlow.setRequestedScopeTokens({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()) {
            // Wenn der Autorisierungsserver eine vollständige URL bereitgestellt hat,
            // die die erforderlichen Daten bereits als Teil der URL-Parameter enthält,
            // können Sie diese verwenden
            qDebug() << "Complete verification uri:" << completeVerificationUrl;
        } else {
            // Der Autorisierungsserver hat nur eine Verifizierungs-URL bereitgestellt; diese verwenden
            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();

Dokumentation der Member-Funktionen

QOAuth2DeviceAuthorizationFlow::QOAuth2DeviceAuthorizationFlow()

Erstellt ein QOAuth2DeviceAuthorizationFlow-Objekt.

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

Erstellt ein `QOAuth2DeviceAuthorizationFlow`-Objekt mit dem übergeordneten Objekt ` parent`.

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

Erstellt ein `QOAuth2DeviceAuthorizationFlow`-Objekt, wobei ` parent ` als übergeordnetes Objekt verwendet wird, und legt ` manager ` als Netzwerkzugriffsmanager fest.

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

Löscht die Instanz „ QOAuth2DeviceAuthorizationFlow “.

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

Dieses Signal wird ausgegeben, wenn der Benutzer die Autorisierung abschließen soll.

Wenn der Autorisierungsserver completeVerificationUrl bereitgestellt hat, kann der Benutzer zu dieser URL navigieren. Die URL enthält den erforderlichen userCode sowie alle weiteren erforderlichen Parameter.

Alternativ muss der Benutzer zu verificationUrl navigieren und userCode manuell eingeben.

Siehe auch Device Flow Usage.

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

Implementiert neu: QAbstractOAuth::grant().

Startet den Autorisierungsablauf, wie im Device Grant RFC beschrieben.

Der Ablauf besteht aus folgenden Schritten:

• Autorisierungsanfrage an den Autorisierungsserver
• Der Benutzer autorisiert den Zugriff, siehe authorizeWithUserCode()
• Abfrage des Autorisierungsservers, bis der Benutzer die Autorisierung akzeptiert oder abgelehnt hat (oder die Codes ablaufen)
• Meldung des Ergebnisses an die Anwendung (siehe granted() und QAbstractOAuth::requestFailed())

Der Ablauf verläuft automatisch von der Autorisierung zur Abfrage des Tokens.

Durch den Aufruf dieser Funktion werden alle bisherigen Autorisierungsdaten zurückgesetzt.

Siehe auch authorizeWithUserCode(), granted(), QAbstractOAuth::requestFailed(), polling, startTokenPolling(), stopTokenPolling() und Device Flow Usage.

[protected slot, since 6.9] void QOAuth2DeviceAuthorizationFlow::refreshTokensImplementation()

Diese Funktion sendet eine Anfrage zur Aktualisierung des Tokens.

Wurde die Auffrischungsanforderung erfolgreich initiiert, wird der Status auf „ QAbstractOAuth::Status::RefreshingToken “ gesetzt; andernfalls wird das Signal „ requestFailed()“ ausgegeben und der Status bleibt unverändert. Token können nicht aktualisiert werden, solange „ isPolling “ den Status „ true “ hat.

Diese Funktion hat keine Auswirkung, wenn der Token-Aktualisierungsprozess bereits läuft.

Wenn die Aktualisierung des Tokens fehlschlägt und ein Zugriffstoken vorhanden ist, wird der Status auf „ QAbstractOAuth::Status::Granted “ gesetzt; wenn kein Zugriffstoken vorhanden ist, wird er auf „ QAbstractOAuth::Status::NotAuthenticated “ gesetzt.

Diese Funktion wurde in Qt 6.9 eingeführt.

Siehe auch QAbstractOAuth::requestFailed() und QAbstractOAuth2::refreshTokens().

[slot] bool QOAuth2DeviceAuthorizationFlow::startTokenPolling()

Startet die Token-Abfrage. Gibt „ true “ zurück, wenn der Start erfolgreich war (oder bereits aktiv war), andernfalls „ false “.

Der Aufruf dieser Funktion ist in einem typischen Anwendungsfall nicht erforderlich. Sobald die Autorisierungsanfrage abgeschlossen ist – als Ergebnis des Aufrufs von ` grant()` – wird die Abfrage automatisch gestartet.

Diese Funktion kann nützlich sein, wenn die Token-Abfrage etwas später fortgesetzt (erneut versucht) werden muss, ohne den gesamten Autorisierungsablauf neu zu starten. Zum Beispiel im Falle eines vorübergehenden Verlusts der Netzwerkverbindung.

Das Abfrageintervall wird vom Autorisierungsserver festgelegt und beträgt in der Regel 5 Sekunden. Die erste Abfrageanforderung wird gesendet, sobald das erste Intervall abgelaufen ist.

Siehe auch polling, stopTokenPolling() und Device Flow Usage.

[slot] void QOAuth2DeviceAuthorizationFlow::stopTokenPolling()

Beendet die Token-Abfrage. Etwaige noch ausstehende Abfrageanfragen werden ohne Rückmeldung verworfen.

Siehe auch polling und startTokenPolling().