メインコンテンツへスキップ
このモジュールは、安全な認可フローのための OAuth2 PKCE（Proof Key for Code Exchange）認証機能を提供します。コードベリファイアの生成、トークンの管理、自動トークン更新といった機能を備えています。

​
class xdk.oauth2_auth.OAuth2PKCEAuth

X API 用の OAuth2 PKCE 認証を行うクラスです。

​
パラメータ

​
path.base_url
str
デフォルト:"'https://api.x.com'"
​
path.authorization_base_url
str
デフォルト:"'https://x.com/i'"
​
path.client_id
str or None
デフォルト:"None"
​
path.client_secret
str or None
デフォルト:"None"
​
path.redirect_uri
str or None
デフォルト:"None"
​
path.token
Dict[str, Any] or None
デフォルト:"None"
​
path.scope
str or List[str] or None
デフォルト:"None"

​
__init__

OAuth 2.0 PKCE 認証を初期化します。

​
Parameters

​
path.base_url
str
デフォルト:"'https://api.x.com'"
X API のトークンエンドポイント用のベース URL（デフォルトは https://api.x.com）。
​
path.authorization_base_url
str
デフォルト:"'https://x.com/i'"
OAuth2 認可用のベース URL（デフォルトは https://x.com/i）。
​
path.client_id
str or None
デフォルト:"None"
X API 用のクライアント ID。
​
path.client_secret
str or None
デフォルト:"None"
X API 用のクライアントシークレット。
​
path.redirect_uri
str or None
デフォルト:"None"
OAuth2 認可用のリダイレクト URI。
​
path.token
Dict[str, Any] or None
デフォルト:"None"
既存の OAuth2 トークンの辞書オブジェクト（存在する場合）。
​
path.scope
str or List[str] or None
デフォルト:"None"
OAuth2 の認可スコープを指定する、スペース区切りの文字列または文字列のリスト。

​
exchange_code

認可コードをトークンに交換します（TypeScript API と対応しています）。

​
パラメーター

​
path.code
str
コールバックで受け取った認可コード。
​
path.code_verifier
str or None
デフォルト:"None"
省略可能なコードベリファイア（指定しない場合は保存済みのベリファイアを使用します）。

​
戻り値

Dictstr, Any

​
fetch_token

認可レスポンス URL からトークンを取得します（レガシーなメソッドで、内部的に exchange_code を使用します）。

​
パラメーター

​
path.authorization_response
str
認可後に受信した完全なコールバック URL

​
戻り値

Dictstr, Any

​
get_authorization_url

OAuth2 PKCE フローの認可 URL を取得します。

​
パラメーター

​
path.state
str or None
デフォルト:"None"
セキュリティ向上のためのオプションの state パラメーターです。

​
戻り値

str

​
get_code_challenge

現在のコードチャレンジ（PKCE 用）を取得します。 :returns: 現在のコードチャレンジ。設定されていない場合は None を返します。 :rtype: Optional[str]

​
戻り値

str | None

​
get_code_verifier

現在のコードベリファイア（PKCE 用）を取得します。 :returns: 現在のコードベリファイア。設定されていない場合は None を返します。 :rtype: Optional[str]

​
戻り値

str | None

​
is_token_expired

トークンの有効期限が切れているかどうかを確認します。 :returns: トークンの有効期限が切れている場合は True、そうでない場合は False を返します。 :rtype: bool

​
戻り値

bool

​
refresh_token

アクセストークンを更新します。 :returns: 更新されたトークンを格納した辞書 :rtype: Dict[str, Any]

​
戻り値

Dictstr, Any

​
set_pkce_parameters

PKCE のパラメータを手動で設定します。

​
パラメーター

​
path.code_verifier
str
使用する code verifier。
​
path.code_challenge
str or None
デフォルト:"None"
オプションの code challenge（指定しない場合は自動生成されます）。