172 lines
5.5 KiB
Python
172 lines
5.5 KiB
Python
from typing import Any, Dict, Type, TypeVar, Tuple, Optional, BinaryIO, TextIO
|
|
|
|
from typing import List
|
|
|
|
|
|
import attr
|
|
|
|
from ..types import UNSET, Unset
|
|
|
|
from typing import Union
|
|
from typing import Dict
|
|
from typing import cast
|
|
from ..types import UNSET, Unset
|
|
from typing import cast, List
|
|
|
|
|
|
|
|
|
|
T = TypeVar("T", bound="LoginRequest")
|
|
|
|
@attr.s(auto_attribs=True)
|
|
class LoginRequest:
|
|
"""
|
|
Attributes:
|
|
challenge (str): ID is the identifier ("login challenge") of the login request. It is used to
|
|
identify the session.
|
|
client (OAuth2Client):
|
|
request_url (str): RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It
|
|
is the URL which
|
|
initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but
|
|
might come in handy if you want to deal with additional request parameters.
|
|
requested_access_token_audience (List[str]):
|
|
requested_scope (List[str]):
|
|
skip (bool): Skip, if true, implies that the client has requested the same scopes from the same user previously.
|
|
If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect
|
|
URL.
|
|
|
|
This feature allows you to update / set session information.
|
|
subject (str): Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or
|
|
deny the scope
|
|
requested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type
|
|
when accepting the login request, or the request will fail.
|
|
oidc_context (Union[Unset, OpenIDConnectContext]):
|
|
session_id (Union[Unset, str]): SessionID is the login session ID. If the user-agent reuses a login session (via
|
|
cookie / remember flag)
|
|
this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember
|
|
is false)
|
|
this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC
|
|
Front-/Back-
|
|
channel logout. It's value can generally be used to associate consecutive login requests by a certain user.
|
|
"""
|
|
|
|
challenge: str
|
|
client: 'OAuth2Client'
|
|
request_url: str
|
|
requested_access_token_audience: List[str]
|
|
requested_scope: List[str]
|
|
skip: bool
|
|
subject: str
|
|
oidc_context: Union[Unset, 'OpenIDConnectContext'] = UNSET
|
|
session_id: Union[Unset, str] = UNSET
|
|
additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
|
|
|
|
|
|
def to_dict(self) -> Dict[str, Any]:
|
|
challenge = self.challenge
|
|
client = self.client.to_dict()
|
|
|
|
request_url = self.request_url
|
|
requested_access_token_audience = self.requested_access_token_audience
|
|
|
|
|
|
|
|
|
|
requested_scope = self.requested_scope
|
|
|
|
|
|
|
|
|
|
skip = self.skip
|
|
subject = self.subject
|
|
oidc_context: Union[Unset, Dict[str, Any]] = UNSET
|
|
if not isinstance(self.oidc_context, Unset):
|
|
oidc_context = self.oidc_context.to_dict()
|
|
|
|
session_id = self.session_id
|
|
|
|
field_dict: Dict[str, Any] = {}
|
|
field_dict.update(self.additional_properties)
|
|
field_dict.update({
|
|
"challenge": challenge,
|
|
"client": client,
|
|
"request_url": request_url,
|
|
"requested_access_token_audience": requested_access_token_audience,
|
|
"requested_scope": requested_scope,
|
|
"skip": skip,
|
|
"subject": subject,
|
|
})
|
|
if oidc_context is not UNSET:
|
|
field_dict["oidc_context"] = oidc_context
|
|
if session_id is not UNSET:
|
|
field_dict["session_id"] = session_id
|
|
|
|
return field_dict
|
|
|
|
|
|
|
|
@classmethod
|
|
def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
|
|
_d = src_dict.copy()
|
|
challenge = _d.pop("challenge")
|
|
|
|
client = OAuth2Client.from_dict(_d.pop("client"))
|
|
|
|
|
|
|
|
|
|
request_url = _d.pop("request_url")
|
|
|
|
requested_access_token_audience = cast(List[str], _d.pop("requested_access_token_audience"))
|
|
|
|
|
|
requested_scope = cast(List[str], _d.pop("requested_scope"))
|
|
|
|
|
|
skip = _d.pop("skip")
|
|
|
|
subject = _d.pop("subject")
|
|
|
|
_oidc_context = _d.pop("oidc_context", UNSET)
|
|
oidc_context: Union[Unset, OpenIDConnectContext]
|
|
if isinstance(_oidc_context, Unset):
|
|
oidc_context = UNSET
|
|
else:
|
|
oidc_context = OpenIDConnectContext.from_dict(_oidc_context)
|
|
|
|
|
|
|
|
|
|
session_id = _d.pop("session_id", UNSET)
|
|
|
|
login_request = cls(
|
|
challenge=challenge,
|
|
client=client,
|
|
request_url=request_url,
|
|
requested_access_token_audience=requested_access_token_audience,
|
|
requested_scope=requested_scope,
|
|
skip=skip,
|
|
subject=subject,
|
|
oidc_context=oidc_context,
|
|
session_id=session_id,
|
|
)
|
|
|
|
login_request.additional_properties = _d
|
|
return login_request
|
|
|
|
@property
|
|
def additional_keys(self) -> List[str]:
|
|
return list(self.additional_properties.keys())
|
|
|
|
def __getitem__(self, key: str) -> Any:
|
|
return self.additional_properties[key]
|
|
|
|
def __setitem__(self, key: str, value: Any) -> None:
|
|
self.additional_properties[key] = value
|
|
|
|
def __delitem__(self, key: str) -> None:
|
|
del self.additional_properties[key]
|
|
|
|
def __contains__(self, key: str) -> bool:
|
|
return key in self.additional_properties
|