class xdk.oauth2_auth.OAuth2PKCEAuth
OAuth2 PKCE authentication for the X API.
Parámetros
str
default:"'https://api.x.com'"
str
default:"'https://x.com/i'"
str or None
default:"None"
str or None
default:"None"
str or None
default:"None"
Dict[str, Any] or None
default:"None"
str or List[str] or None
default:"None"
__init__
Initialize the OAuth2 PKCE authentication.
Parámetros
str
default:"'https://api.x.com'"
The base URL for the X API token endpoint (defaults to https://api.x.com).
str
default:"'https://x.com/i'"
La URL base para la autorización OAuth2 (por defecto https://x.com/i).
str or None
default:"None"
The client ID for the X API.
str or None
default:"None"
El client secret para la X API.
str or None
default:"None"
La URI de redirección para la autorización OAuth2.
Dict[str, Any] or None
default:"None"
An existing OAuth2 token dictionary (if available).
str or List[str] or None
default:"None"
Cadena separada por espacios o lista de cadenas para los scopes de autorización OAuth2.
exchange_code
Intercambia el código de autorización por tokens (coincide con la API de TypeScript).
Parámetros
str
El código de autorización del callback.
str or None
default:"None"
Verificador de código opcional (usa el verificador almacenado si no se proporciona).
Devuelve
Dictstr, Any
fetch_token
Fetch token using authorization response URL (legacy method, uses exchange_code internally).
Parámetros
str
The full callback URL received after authorization
Devuelve
Dictstr, Any
get_authorization_url
Obtiene la URL de autorización para el flujo OAuth2 PKCE.
Parámetros
str or None
default:"None"
Parámetro de estado opcional por seguridad.
Devuelve
str
get_code_challenge
Get the current code challenge (for PKCE).
:returns: The current code challenge, or None if not set.
:rtype: Optional[str]
Devuelve
str | None
get_code_verifier
Get the current code verifier (for PKCE).
:returns: The current code verifier, or None if not set.
:rtype: Optional[str]
Devuelve
str | None
is_token_expired
Check if the token is expired.
:returns: True if the token is expired, False otherwise.
:rtype: bool
Devuelve
bool
refresh_token
Refresh the access token.
:returns: The refreshed token dictionary
:rtype: Dict[str, Any]
Devuelve
Dictstr, Any
set_pkce_parameters
Manually set PKCE parameters.
Parámetros
str
The code verifier to use.
str or None
default:"None"
Optional code challenge (will be generated if not provided).