मुख्य सामग्री पर जाएं

Documentation Index

Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

यह मॉड्यूल सुरक्षित ऑथराइज़ेशन फ़्लो के लिए OAuth2 PKCE (Proof Key for Code Exchange) प्रमाणीकरण सुविधा प्रदान करता है। इसमें कोड वेरिफ़ायर जनरेट करना, टोकन प्रबंधन, और स्वचालित टोकन रीफ़्रेश जैसी क्षमताएँ शामिल हैं।

​
class xdk.oauth2_auth.OAuth2PKCEAuth

X API के लिए OAuth2 PKCE प्रमाणीकरण।

​
पैरामीटर

​
path.base_url
str
डिफ़ॉल्ट:"'https://api.x.com'"
​
path.authorization_base_url
str
डिफ़ॉल्ट:"'https://x.com/i'"
​
path.client_id
str or None
डिफ़ॉल्ट:"None"
​
path.client_secret
str or None
डिफ़ॉल्ट:"None"
​
path.redirect_uri
str or None
डिफ़ॉल्ट:"None"
​
path.token
Dict[str, Any] or None
डिफ़ॉल्ट:"None"
​
path.scope
str or List[str] or None
डिफ़ॉल्ट:"None"

​
__init__

OAuth2 PKCE प्रमाणीकरण प्रारंभ करता है।

​
पैरामीटर

​
path.base_url
str
डिफ़ॉल्ट:"'https://api.x.com'"
X API टोकन endpoint के लिए base URL (https://api.x.com डिफ़ॉल्ट रूप से सेट है)।
​
path.authorization_base_url
str
डिफ़ॉल्ट:"'https://x.com/i'"
OAuth2 ऑथराइज़ेशन के लिए base URL (https://x.com/i डिफ़ॉल्ट रूप से सेट है)।
​
path.client_id
str or None
डिफ़ॉल्ट:"None"
X API के लिए client ID।
​
path.client_secret
str or None
डिफ़ॉल्ट:"None"
X API के लिए client secret।
​
path.redirect_uri
str or None
डिफ़ॉल्ट:"None"
OAuth2 ऑथराइज़ेशन के लिए redirect URI।
​
path.token
Dict[str, Any] or None
डिफ़ॉल्ट:"None"
मौजूदा OAuth2 token dictionary (यदि उपलब्ध हो)।
​
path.scope
str or List[str] or None
डिफ़ॉल्ट:"None"
OAuth2 ऑथराइज़ेशन scope के लिए स्पेस से अलग की गई string या strings की सूची।

​
exchange_code

टोकन के लिए ऑथराइज़ेशन कोड का विनिमय करें (TypeScript API के अनुरूप)।

​
पैरामीटर

​
path.code
str
कॉलबैक से प्राप्त ऑथराइज़ेशन code।
​
path.code_verifier
str or None
डिफ़ॉल्ट:"None"
वैकल्पिक code verifier (यदि प्रदान नहीं किया गया है, तो संग्रहीत verifier का उपयोग किया जाता है)।

​
रिटर्न

Dictstr, Any

​
fetch_token

ऑथराइज़ेशन रिस्पॉन्स URL का उपयोग करके टोकन प्राप्त करें (लेगेसी विधि, आंतरिक रूप से exchange_code का उपयोग करती है)।

​
पैरामीटर

​
path.authorization_response
str
ऑथराइज़ेशन के बाद प्राप्त पूरा callback URL

​
रिटर्न

Dictstr, Any

​
get_authorization_url

OAuth2 PKCE flow के लिए ऑथराइज़ेशन URL प्राप्त करें।

​
पैरामीटर

​
path.state
str or None
डिफ़ॉल्ट:"None"
सुरक्षा के लिए एक वैकल्पिक state पैरामीटर।

​
रिटर्न

str

​
get_code_challenge

वर्तमान code challenge प्राप्त करता है (PKCE के लिए)। :returns: वर्तमान code challenge, या सेट न होने पर None। :rtype: Optional[str]

​
रिटर्न

str | None

​
get_code_verifier

वर्तमान code verifier लौटाता है (PKCE के लिए)। :returns: वर्तमान code verifier, या यदि यह सेट न हो तो None। :rtype: Optional[str]

​
रिटर्न

str | None

​
is_token_expired

जांचें कि टोकन की समय-सीमा समाप्त हो चुकी है या नहीं। :returns: यदि टोकन की समय-सीमा समाप्त हो चुकी है, तो True; अन्यथा False। :rtype: bool

​
रिटर्न

bool

​
refresh_token

एक्सेस टोकन को रीफ़्रेश करता है। :returns: रीफ़्रेश किया गया टोकन डिक्शनरी :rtype: Dict[str, Any]

​
रिटर्न

Dictstr, Any

​
set_pkce_parameters

PKCE पैरामीटर को मैन्युअली सेट करें।

​
पैरामीटर

​
path.code_verifier
str
इस्तेमाल किया जाने वाला code verifier.
​
path.code_challenge
str or None
डिफ़ॉल्ट:"None"
वैकल्पिक code challenge (अगर नहीं दिया गया है, तो इसे जनरेट किया जाएगा)।