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パラメータの一部として既に含まれている 場合は 、
            // それを使用することもできます
            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()も参照してください 。