oauth1_auth

このモジュールは、安全な認可フローのための OAuth 1.0a 認証機能を提供します。リクエストトークンの生成、認可 URL の生成、アクセストークンの交換、および OAuth 1.0a シグネチャの生成を行います。

class xdk.oauth1_auth.OAuth1

X API 向けの OAuth1 認証ハンドラーです。

パラメータ

path.api_key · str

path.api_secret · str

path.callback · str

path.access_token · str or None · デフォルト: "None"

path.access_token_secret · str or None · デフォルト: "None"

__init__

OAuth1 認証を初期化します。

パラメーター

path.api_key · str

API Key（Consumer Key）。

path.api_secret · str

API Secret（Consumer Secret）。

path.callback · str

OAuth フロー用のコールバック URL。

path.access_token · str or None · デフォルト: "None"

Access Token（既に取得済みの場合）。

path.access_token_secret · str or None · デフォルト: "None"

Access Token Secret（既に取得済みの場合）。

build_request_header

API リクエスト用の OAuth1 認可ヘッダーを生成します。

パラメータ

path.method · str

HTTP メソッド (GET、POST など)。

path.url · str

リクエスト URL（クエリパラメータを含む場合があります）。

body.body · str · デフォルト: "''"

リクエストボディ（フォームエンコード形式の文字列、または空）。

戻り値

str

get_access_token

verifier をアクセストークンに交換します。

パラメーター

path.verifier · str

コールバックまたは PIN から取得した OAuth verifier。

戻り値

OAuth1AccessToken

get_authorization_url

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

パラメーター

path.login_with_x · bool · デフォルト: "False"

「Log in with X」フローを使用するかどうかを指定します。

戻り値

str

get_request_token

OAuth1 フローを開始するためのリクエストトークンを取得します。 :returns: oauth_token と oauth_token_secret を含むリクエストトークンを返します。 :rtype: OAuth1RequestToken

戻り値

OAuth1RequestToken

start_oauth_flow

OAuth1 フローを開始するための補助メソッドです。

パラメーター

path.login_with_x · bool · デフォルト: "False"

「Log in with X」フローを使用するかどうかを示します。

戻り値

str

class xdk.oauth1_auth.OAuth1AccessToken

OAuth1 アクセストークンのレスポンス。

パラメータ

path.access_token · str

path.access_token_secret · str

__init__

OAuth1 アクセストークンを初期化します。

パラメータ

path.access_token · str

アクセストークン。

path.access_token_secret · str

アクセストークンシークレット。

class xdk.oauth1_auth.OAuth1RequestToken

OAuth1 リクエストトークンのレスポンス。

パラメータ

path.oauth_token · str

path.oauth_token_secret · str

__init__

OAuth1 のリクエストトークンを初期化します。

パラメータ

path.oauth_token · str

OAuth トークン。

path.oauth_token_secret · str

OAuth トークンのシークレット。