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

Ce module fournit des fonctionnalités d’authentification OAuth 1.0a pour des flux
d’autorisation sécurisés. Il gère la génération de jetons de requête, la création d’URL
d’autorisation, l’échange de jetons d’accès et la génération de signatures OAuth 1.

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

Gestionnaire d’authentification OAuth1 pour X API.

<div id="parameters">
  #### Paramètres
</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>

Initialise l’authentification OAuth1.

<div id="parameters">
  #### Paramètres
</div>

<ParamField path="path.api_key" type="str">
  Clé API (Consumer Key).
</ParamField>

<ParamField path="path.api_secret" type="str">
  Secret d’API (Consumer Secret).
</ParamField>

<ParamField path="path.callback" type="str">
  URL de rappel pour le flux OAuth.
</ParamField>

<ParamField path="path.access_token" type="str or None" default="None">
  Access Token (si déjà obtenu).
</ParamField>

<ParamField path="path.access_token_secret" type="str or None" default="None">
  Secret de l’Access Token (si déjà obtenu).
</ParamField>

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

Construit l’en-tête d’autorisation OAuth1 pour les requêtes adressées à l’API.

<div id="parameters">
  #### Paramètres
</div>

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

<ParamField path="path.url" type="str">
  URL de la requête (peut inclure des paramètres de requête).
</ParamField>

<ParamField path="body.body" type="str" default="''">
  Corps de la requête (chaîne encodée de type formulaire ou vide).
</ParamField>

<div id="returns">
  #### Retourne
</div>

`str`

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

Échange le verifier contre un jeton d’accès.

<div id="parameters">
  #### Paramètres
</div>

<ParamField path="path.verifier" type="str">
  Paramètre oauth\_verifier issu du callback ou du code PIN.
</ParamField>

#### Renvoie

`OAuth1AccessToken`

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

Obtenir l’URL d’autorisation pour le flux OAuth1.

<div id="parameters">
  #### Paramètres
</div>

<ParamField path="path.login_with_x" type="bool" default="False">
  Indique s'il faut utiliser le flux d’authentification « Log in with X ».
</ParamField>

#### Renvoie

`str`

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

Récupère un jeton de requête pour initier le flux OAuth1.
:returns: Renvoie un jeton de requête contenant oauth\_token et oauth\_token\_secret.
:rtype: OAuth1RequestToken

<div id="returns">
  #### Retourne
</div>

`OAuth1RequestToken`

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

Méthode utilitaire permettant d'initier le flux OAuth1.

<div id="parameters">
  #### Paramètres
</div>

<ParamField path="path.login_with_x" type="bool" default="False">
  Indique s’il faut utiliser le flux d’authentification « Log in with X ».
</ParamField>

#### Renvoie

`str`

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

Réponse contenant un jeton d'accès OAuth1.

<div id="parameters">
  #### Paramètres
</div>

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

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

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

Initialise le jeton d’accès OAuth1.

<div id="parameters">
  #### Paramètres
</div>

<ParamField path="path.access_token" type="str">
  Le jeton d’accès.
</ParamField>

<ParamField path="path.access_token_secret" type="str">
  Le secret du jeton d’accès.
</ParamField>

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

Réponse contenant le jeton de requête OAuth1.

<div id="parameters">
  #### Paramètres
</div>

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

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

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

Initialise le jeton de requête OAuth1.

<div id="parameters">
  #### Paramètres
</div>

<ParamField path="path.oauth_token" type="str">
  Le jeton OAuth.
</ParamField>

<ParamField path="path.oauth_token_secret" type="str">
  Le secret du jeton OAuth.
</ParamField>