> ## 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

Este módulo proporciona funcionalidad de autenticación OAuth 1.0a para flujos de autorización seguros. Incluye generación de tokens de solicitud, generación de URL de autorización, intercambio de tokens de acceso y generación de firmas OAuth 1.0a.

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

Controlador de autenticación OAuth1 para X API.

<div id="parameters">
  #### Parámetros
</div>

<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>

Inicializa la autenticación OAuth1.

<div id="parameters">
  #### Parámetros
</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">
  URL de retorno para el flujo de OAuth.
</ParamField>

<ParamField path="path.access_token" type="str or None" default="None">
  Access Token (si ya se ha obtenido).
</ParamField>

<ParamField path="path.access_token_secret" type="str or None" default="None">
  Access Token Secret (si ya se ha obtenido).
</ParamField>

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

Crea el encabezado de autorización OAuth1 para las solicitudes a la API.

<div id="parameters">
  #### Parámetros
</div>

<ParamField path="path.method" type="str">
  Método HTTP (GET, POST, etc.).
</ParamField>

<ParamField path="path.url" type="str">
  URL de la solicitud (puede incluir parámetros de consulta).
</ParamField>

<ParamField path="body.body" type="str" default="''">
  Cuerpo de la solicitud (cadena con codificación de formulario o vacío).
</ParamField>

#### Devuelve

`str`

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

Intercambia el verificador por un token de acceso.

<div id="parameters">
  #### Parámetros
</div>

<ParamField path="path.verifier" type="str">
  Código de verificación OAuth del callback o PIN.
</ParamField>

#### Devuelve

`OAuth1AccessToken`

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

Obtén la URL de autorización para el flujo de OAuth1.

<div id="parameters">
  #### Parámetros
</div>

<ParamField path="path.login_with_x" type="bool" default="False">
  Indica si se debe utilizar el flujo «Iniciar sesión con X».
</ParamField>

#### Devuelve

`str`

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

Obtiene un token de solicitud para iniciar el flujo de OAuth1.
:returns: Devuelve un token de solicitud con oauth\_token y oauth\_token\_secret.
:rtype: OAuth1RequestToken

<div id="returns">
  #### Valor devuelto
</div>

`OAuth1RequestToken`

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

Método práctico para iniciar el flujo de OAuth 1.0.

<div id="parameters">
  #### Parámetros
</div>

<ParamField path="path.login_with_x" type="bool" default="False">
  Indica si se debe usar el flujo de «Iniciar sesión con X».
</ParamField>

#### Devuelve

`str`

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

Respuesta del token de acceso de OAuth1.

<div id="parameters">
  #### Parámetros
</div>

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

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

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

Inicializa el token de acceso OAuth1.

<div id="parameters">
  #### Parámetros
</div>

<ParamField path="path.access_token" type="str">
  El token de acceso.
</ParamField>

<ParamField path="path.access_token_secret" type="str">
  El secreto del token de acceso.
</ParamField>

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

Respuesta del token de solicitud de OAuth1.

<div id="parameters">
  #### Parámetros
</div>

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

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

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

Inicializa el token de solicitud para OAuth1.

<div id="parameters">
  #### Parámetros
</div>

<ParamField path="path.oauth_token" type="str">
  El token OAuth.
</ParamField>

<ParamField path="path.oauth_token_secret" type="str">
  El secreto del token OAuth.
</ParamField>
