Refresh Token¶
OAuth 2.0 Refresh Token Grant (RFC 6749 Section 6) for obtaining new access tokens.
Request Model¶
RefreshTokenRequest(address, client_id, refresh_token, scope=None, client_secret=None)
dataclass
¶
Bases: BaseRequest
Request for refreshing an OAuth 2.0 access token.
Attributes:
| Name | Type | Description |
|---|---|---|
address |
str
|
The token endpoint URL. |
client_id |
str
|
The client identifier. |
refresh_token |
str
|
The refresh token received from a prior authorization. |
scope |
str | None
|
Optional space-delimited scopes (must be subset of original grant). |
client_secret |
str | None
|
Client secret (optional for public clients). |
Response Model¶
RefreshTokenResponse(is_successful, error=None, token=None)
dataclass
¶
Bases: BaseResponse
Response from a refresh token grant.
Check is_successful before accessing token.
The token dict typically contains a new access_token and may
include a new refresh_token.
Functions¶
refresh_token(request, http_client=None)
¶
Refresh an OAuth 2.0 access token using a refresh token.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
RefreshTokenRequest
|
Refresh token request with refresh_token and client credentials. |
required |
http_client
|
HTTPClient | None
|
Optional managed HTTP client. |
None
|
Returns:
| Type | Description |
|---|---|
RefreshTokenResponse
|
RefreshTokenResponse with new token dict or error. |