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,[](constQUrl&verificationUrl, constQString&userCode, constQUrl&completeVerificationUrl) {if(completeVerificationUrl.isValid()) {// 認証サーバが、 URLパラメータの一部として // 必要なデータを既に含む 完全なURLを提供した場合 、 // そのURLを使用することを選択できる。            qDebug() << "Complete verification uri:" << completeVerificationUrl;
        }else{// 認証サーバーは検証URLのみを提供したので、それを使用する。            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();

メンバー関数ドキュメント

QOAuth2DeviceAuthorizationFlow::QOAuth2DeviceAuthorizationFlow()

QOAuth2DeviceAuthorizationFlow オブジェクトを構築する。

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

親オブジェクトparent を持つ QOAuth2DeviceAuthorizationFlow オブジェクトを構築する。

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

parent を親として QOAuth2DeviceAuthorizationFlow オブジェクトを構築し、manager をネットワークアクセスマネージャとして設定する。

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

QOAuth2DeviceAuthorizationFlow インスタンスを破棄します。

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

このシグナルは、ユーザが認可を完了すべきときに発行される。

認可サーバーがcompleteVerificationUrl を提供している場合、ユーザーはそのURLにナビゲートできる。このURLには、必要なuserCode 、その他必要なパラメータが含まれている。

あるいは、ユーザはverificationUrl に移動し、userCode を手動で入力する必要がある。

Device Flow Usageも参照のこと 。

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

再インプリメント：QAbstractOAuth::grant().

Device Grant RFC に記述されている認可フローを開始する。

フローは以下のステップで構成される：

• 認可サーバーへの認可リクエスト
• ユーザがアクセスを認可する。authorizeWithUserCode() を参照。
• ユーザが認可を受諾または拒否するまで（またはコードが期限切れになるまで）、認可サーバをポーリングする。
• アプリケーションへの結果通知（granted()とQAbstractOAuth::requestFailed()を参照）

フローは、認証からトークンのポーリングまで自動的に進行します。

この関数を呼び出すと、以前の認証データはリセットされます。

authorizeWithUserCode()、granted()、QAbstractOAuth::requestFailed()、polling 、startTokenPolling()、stopTokenPolling()、Device Flow Usageも参照 。

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

この関数はトークンのリフレッシュ要求を送信する。

リフレッシュ要求が正常に開始された場合、ステータスはQAbstractOAuth::Status::RefreshingToken に設定される。そうでない場合、requestFailed() シグナルが発行され、ステータスは変更されない。isPolling がtrue の間はトークンをリフレッシュできません。

トークンのリフレッシュ処理が既に進行中の場合、この関数は何の効果も持たない。

トークンのリフレッシュに失敗し、アクセストークンが存在する場合、ステータスはQAbstractOAuth::Status::Granted に設定され、アクセストークンが存在しない場合はQAbstractOAuth::Status::NotAuthenticated に設定されます。

この関数は Qt 6.9 で導入されました。

QAbstractOAuth::requestFailed() およびQAbstractOAuth2::refreshTokens()も参照してください 。

[slot] bool QOAuth2DeviceAuthorizationFlow::startTokenPolling()

トークンのポーリングを開始する。開始が成功した（またはすでにアクティブだった）場合はtrue を返し、そうでない場合はfalse を返す。

一般的な使用例では、この関数を呼び出す必要はない。grant （）呼び出しの結果、認証要求が完了すると、ポーリングが自動的に開始される。

この関数は、認可フロー全体を再開することなく、トークンのポー リングを少し後で再開する(再試行する)必要がある場合に有用である。例えば、ネットワーク接続が一時的に切断された場合などである。

ポーリング間隔は認可サーバによって定義され、通常5秒である。最初のポーリング要求は、最初の間隔が経過した時点で送信される。

polling 、stopTokenPolling()、Device Flow Usageも参照のこと 。

[slot] void QOAuth2DeviceAuthorizationFlow::stopTokenPolling()

トークンのポーリングを停止します。未処理の可能性のあるポーリング要求はすべて静かに破棄される。

polling およびstartTokenPolling()も参照のこと 。