OAuth2PKCEAuth

이 모듈은 안전한 인가 플로우를 위한 OAuth2 PKCE(Proof Key for Code Exchange) 인증 기능을 제공합니다. 코드 검증자(code verifier) 생성, 토큰 관리, 토큰 자동 갱신 기능을 포함합니다.

​

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__

OAuth 2 PKCE 인증을 초기화합니다.

​

매개변수

path.base_url · str · 기본값: "'https://api.x.com'"

X API 토큰 엔드포인트용 기본 URL입니다 (기본값은 https://api.x.com입니다).

path.authorization_base_url · str · 기본값: "'https://x.com/i'"

OAuth2 인가용 기본 URL입니다 (기본값은 https://x.com/i입니다).

path.client_id · str or None · 기본값: "None"

X API용 클라이언트 id입니다.

path.client_secret · str or None · 기본값: "None"

X API용 클라이언트 시크릿입니다.

path.redirect_uri · str or None · 기본값: "None"

OAuth2 인가용 리디렉트 URI입니다.

path.token · Dict[str, Any] or None · 기본값: "None"

기존 OAuth2 토큰 딕셔너리입니다 (있는 경우).

path.scope · str or List[str] or None · 기본값: "None"

OAuth2 인가 범위를 나타내는 공백으로 구분된 문자열 또는 문자열 리스트입니다.

​

exchange_code

인가 코드를 토큰으로 교환합니다(TypeScript API와 동일합니다).

​

매개변수

path.code · str

콜백에서 전달된 authorization code입니다.

path.code_verifier · str or None · 기본값: "None"

선택적인 code verifier입니다. 제공되지 않으면 저장된 verifier를 사용합니다.

​

반환값

Dictstr, Any

​

fetch_token

인가 응답 URL을 사용해 토큰을 가져오는 레거시 메서드입니다(내부적으로 exchange_code를 사용합니다).

​

매개변수

path.authorization_response · str

인가 후에 받은 전체 콜백 URL

​

반환

Dictstr, Any

​

get_authorization_url

OAuth2 PKCE 플로우용 인가 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 값입니다 (제공되지 않은 경우 자동으로 생성됩니다).