Responses

Response objects used throughout the project.

from aioauth import responses

AuthorizationCodeResponse dataclass

Response for authorization_code.

Used by aioauth.response_type.ResponseTypeAuthorizationCode.

Source code in aioauth/responses.py

@dataclass
class AuthorizationCodeResponse:
    """Response for `authorization_code`.

    Used by `aioauth.response_type.ResponseTypeAuthorizationCode`.
    """

    code: str
    scope: str

ErrorResponse dataclass

Response for errors.

Source code in aioauth/responses.py

@dataclass
class ErrorResponse:
    """Response for errors."""

    error: ErrorType
    description: str
    error_uri: str = ""

IdTokenResponse dataclass

Response for OpenID id_token.

Used by aioauth.response_type.ResponseResponseTypeIdTokenTypeToken.

Source code in aioauth/responses.py

@dataclass
class IdTokenResponse:
    """Response for OpenID id_token.

    Used by `aioauth.response_type.ResponseResponseTypeIdTokenTypeToken`.
    """

    id_token: str

NoneResponse dataclass

Response for aioauth.response_type.ResponseTypeNone.

See: OAuth v2 multiple response types,

Source code in aioauth/responses.py

@dataclass
class NoneResponse:
    """Response for `aioauth.response_type.ResponseTypeNone`.

    See: [OAuth v2 multiple response types](https://openid.net/specs/oauth-v2-multiple-response-types-1_0.html#none),
    """

Response dataclass

General response class.

Used by aioauth.server.AuthorizationServer.

Source code in aioauth/responses.py

@dataclass
class Response:
    """General response class.

    Used by `aioauth.server.AuthorizationServer`.
    """

    content: Dict = field(default_factory=dict)
    status_code: HTTPStatus = HTTPStatus.OK
    headers: HTTPHeaderDict = field(
        default_factory=lambda: default_headers
    )  # pragma: no cover

TokenActiveIntrospectionResponse dataclass

Response for a valid access token.

Used by aioauth.server.AuthorizationServer.create_token_introspection_response.

Source code in aioauth/responses.py

@dataclass
class TokenActiveIntrospectionResponse:
    """Response for a valid access token.

    Used by `aioauth.server.AuthorizationServer.create_token_introspection_response`.
    """

    scope: str
    client_id: str
    token_type: TokenType
    expires_in: int
    active: bool = True

TokenInactiveIntrospectionResponse dataclass

For an invalid, revoked or expired token.

Used by aioauth.server.AuthorizationServer.create_token_introspection_response.

Source code in aioauth/responses.py

@dataclass
class TokenInactiveIntrospectionResponse:
    """For an invalid, revoked or expired token.

    Used by `aioauth.server.AuthorizationServer.create_token_introspection_response`.
    """

    active: bool = False

TokenResponse dataclass

Response for valid token.

Used by aioauth.response_type.ResponseTypeToken.

Source code in aioauth/responses.py

@dataclass
class TokenResponse:
    """Response for valid token.

    Used by `aioauth.response_type.ResponseTypeToken`.
    """

    expires_in: int
    access_token: str
    scope: str
    refresh_token_expires_in: Optional[int] = None
    refresh_token: Optional[str] = None
    token_type: str = "Bearer"