UserInfo

OpenID Connect UserInfo endpoint (OIDC Core 1.0 Section 5.3).

Request / Response Models

UserInfoRequest(address, token) dataclass

Bases: BaseRequest

Request for the OpenID Connect UserInfo endpoint.

Attributes:

Name	Type	Description
address	str	The UserInfo endpoint URL.
token	str	A valid access token with openid scope.

UserInfoResponse(is_successful, error=None, claims=None, raw=None) dataclass

Bases: BaseResponse

Response from the UserInfo endpoint.

Check is_successful before accessing claims or raw.

Sync API

get_userinfo(request, http_client=None)

Get claims about an authenticated user from the UserInfo endpoint.

Parameters:

Name	Type	Description	Default
request	UserInfoRequest	UserInfo request with endpoint address and access token	required
http_client	HTTPClient | None	Optional managed HTTP client. When None, uses the thread-local default.	None

Returns:

Name	Type	Description
UserInfoResponse	UserInfoResponse	Response with claims (JSON) or raw JWT string

Async API

get_userinfo(request, http_client=None) async

Get claims about an authenticated user from the UserInfo endpoint (async).

Parameters:

Name	Type	Description	Default
request	UserInfoRequest	UserInfo request with endpoint address and access token	required
http_client	AsyncHTTPClient | None	Optional managed HTTP client. When None, uses the module-level singleton.	None

Returns:

Name	Type	Description
UserInfoResponse	UserInfoResponse	Response with claims (JSON) or raw JWT string