Skip to content

Token Client

OAuth 2.0 token endpoint operations (client credentials grant).

Request / Response Models

ClientCredentialsTokenRequest(address, client_id, client_secret, scope) dataclass

Bases: BaseRequest

Request for an OAuth 2.0 client credentials token.

Attributes:

Name Type Description
address str

The token endpoint URL.

client_id str

The client identifier.

client_secret str

The client secret.

scope str

Space-delimited list of requested scopes.

ClientCredentialsTokenResponse(is_successful, error=None, token=None) dataclass

Bases: BaseResponse

Response from a client credentials token request.

Check is_successful before accessing token.

Sync API

request_client_credentials_token(request, http_client=None)

Request an access token using client credentials flow.

Parameters:

Name Type Description Default
request ClientCredentialsTokenRequest

Client credentials token request

required
http_client HTTPClient | None

Optional managed HTTP client. When None, uses the thread-local default.

None

Returns:

Name Type Description
ClientCredentialsTokenResponse ClientCredentialsTokenResponse

Token response

Async API

request_client_credentials_token(request, http_client=None) async

Request an access token using client credentials flow (async).

Parameters:

Name Type Description Default
request ClientCredentialsTokenRequest

Client credentials token request

required
http_client AsyncHTTPClient | None

Optional managed HTTP client. When None, uses the module-level singleton.

None

Returns:

Name Type Description
ClientCredentialsTokenResponse ClientCredentialsTokenResponse

Token response