> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# oauth1_auth

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

<div id="class-xdkoauth1_authoauth1">
  ### `class xdk.oauth1_auth.OAuth1`
</div>

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

#### パラメータ

<ParamField path="path.api_key" type="str" />

<ParamField path="path.api_secret" type="str" />

<ParamField path="path.callback" type="str" />

<ParamField path="path.access_token" type="str or None" default="None" />

<ParamField path="path.access_token_secret" type="str or None" default="None" />

<div id="__init__">
  ### `__init__`
</div>

OAuth1 認証を初期化します。

<div id="parameters">
  #### パラメーター
</div>

<ParamField path="path.api_key" type="str">
  API Key（Consumer Key）。
</ParamField>

<ParamField path="path.api_secret" type="str">
  API Secret（Consumer Secret）。
</ParamField>

<ParamField path="path.callback" type="str">
  OAuth フロー用のコールバック URL。
</ParamField>

<ParamField path="path.access_token" type="str or None" default="None">
  Access Token（既に取得済みの場合）。
</ParamField>

<ParamField path="path.access_token_secret" type="str or None" default="None">
  Access Token Secret（既に取得済みの場合）。
</ParamField>

<div id="build_request_header">
  ### `build_request_header`
</div>

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

#### パラメータ

<ParamField path="path.method" type="str">
  HTTP メソッド (GET、POST など)。
</ParamField>

<ParamField path="path.url" type="str">
  リクエスト URL（クエリパラメータを含む場合があります）。
</ParamField>

<ParamField path="body.body" type="str" default="''">
  リクエストボディ（フォームエンコード形式の文字列、または空）。
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`str`

<div id="get_access_token">
  ### `get_access_token`
</div>

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

<div id="parameters">
  #### パラメーター
</div>

<ParamField path="path.verifier" type="str">
  コールバックまたは PIN から取得した OAuth verifier。
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`OAuth1AccessToken`

<div id="get_authorization_url">
  ### `get_authorization_url`
</div>

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

<div id="parameters">
  #### パラメーター
</div>

<ParamField path="path.login_with_x" type="bool" default="False">
  「Log in with X」フローを使用するかどうかを指定します。
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`str`

<div id="get_request_token">
  ### `get_request_token`
</div>

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

<div id="returns">
  #### 戻り値
</div>

`OAuth1RequestToken`

<div id="start_oauth_flow">
  ### `start_oauth_flow`
</div>

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

<div id="parameters">
  #### パラメーター
</div>

<ParamField path="path.login_with_x" type="bool" default="False">
  「Log in with X」フローを使用するかどうかを示します。
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`str`

<div id="class-xdkoauth1_authoauth1accesstoken">
  ### `class xdk.oauth1_auth.OAuth1AccessToken`
</div>

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

#### パラメータ

<ParamField path="path.access_token" type="str" />

<ParamField path="path.access_token_secret" type="str" />

<div id="__init__">
  ### `__init__`
</div>

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

#### パラメータ

<ParamField path="path.access_token" type="str">
  アクセストークン。
</ParamField>

<ParamField path="path.access_token_secret" type="str">
  アクセストークンシークレット。
</ParamField>

<div id="class-xdkoauth1_authoauth1requesttoken">
  ### `class xdk.oauth1_auth.OAuth1RequestToken`
</div>

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

#### パラメータ

<ParamField path="path.oauth_token" type="str" />

<ParamField path="path.oauth_token_secret" type="str" />

<div id="__init__">
  ### `__init__`
</div>

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

#### パラメータ

<ParamField path="path.oauth_token" type="str">
  OAuth トークン。
</ParamField>

<ParamField path="path.oauth_token_secret" type="str">
  OAuth トークンのシークレット。
</ParamField>