pangea-sdk 6.2.0b2__py3-none-any.whl → 6.4.0__py3-none-any.whl

pangea/services/authn/models.py

@@ -1,69 +1,28 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
 
-# TODO: Modernize.
-# ruff: noqa: UP006, UP035
-
 from __future__ import annotations
 
 import enum
-from typing import Dict, List, NewType, Optional, Union
-from warnings import warn
+from collections.abc import Mapping
+from typing import Annotated, Literal, Optional, Union
 
-from typing_extensions import deprecated
+from pydantic import Field
 
 import pangea.services.intel as im
-from pangea.deprecated import pangea_deprecated
-from pangea.response import APIRequestModel, APIResponseModel, PangeaResponseResult
+from pangea.response import APIRequestModel, APIResponseModel, PangeaDateTime, PangeaResponseResult
 from pangea.services.vault.models.common import JWK, JWKec, JWKrsa
 
-Scopes = NewType("Scopes", List[str])
-
-
-class Profile(Dict[str, str]):
-    @property
-    def first_name(self) -> str:
-        warn(
-            '`Profile.first_name` is deprecated. Use `Profile["first_name"]` instead.', DeprecationWarning, stacklevel=2
-        )
-        return self["first_name"]
-
-    @first_name.setter
-    def first_name(self, value: str) -> None:
-        warn(
-            '`Profile.first_name` is deprecated. Use `Profile["first_name"]` instead.', DeprecationWarning, stacklevel=2
-        )
-        self["first_name"] = value
-
-    @property
-    def last_name(self) -> str:
-        warn('`Profile.last_name` is deprecated. Use `Profile["last_name"]` instead.', DeprecationWarning, stacklevel=2)
-        return self["last_name"]
-
-    @last_name.setter
-    def last_name(self, value: str) -> None:
-        warn('`Profile.last_name` is deprecated. Use `Profile["last_name"]` instead.', DeprecationWarning, stacklevel=2)
-        self["last_name"] = value
-
-    @property
-    def phone(self) -> str:
-        warn('`Profile.phone` is deprecated. Use `Profile["phone"]` instead.', DeprecationWarning, stacklevel=2)
-        return self["phone"]
-
-    @phone.setter
-    def phone(self, value: str) -> None:
-        warn('`Profile.phone` is deprecated. Use `Profile["phone"]` instead.', DeprecationWarning, stacklevel=2)
-        self["phone"] = value
-
-    @deprecated("`Profile.model_dump()` is deprecated. `Profile` is already a `dict[str, str]`.")
-    @pangea_deprecated(reason="`Profile` is already a `dict[str, str]`.")
-    def model_dump(self, *, exclude_none: bool = False) -> dict[str, str]:
-        warn(
-            "`Profile.model_dump()` is deprecated. `Profile` is already a `dict[str, str]`.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self
+GroupId = Annotated[str, Field(pattern="^pgi_[a-z2-7]{32}$")]
+Identity = Annotated[str, Field(pattern="^[a-zA-Z0-9 '.:/_-]+$")]
+Scope = Annotated[str, Field(pattern="^[a-zA-Z0-9:*/_=-]+$")]
+Token = Annotated[
+    str, Field(pattern="^(p(ti|tr|ts|tu|cl)_[a-z2-7]{32})|([A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+)$")
+]
+TokenId = Annotated[str, Field(pattern="^pmt_[a-z2-7]{32}$")]
+TokenType = Literal[
+    "client", "service", "service_account", "service_account_client", "service_account_pangea", "session", "user"
+]
 
 
 class ClientPasswordChangeRequest(APIRequestModel):
@@ -76,10 +35,6 @@ class ClientPasswordChangeResult(PangeaResponseResult):
     pass
 
 
-class ClientTokenCheckRequest(APIRequestModel):
-    token: str
-
-
 class IPIntelligence(PangeaResponseResult):
     is_bad: bool
     is_vpn: bool
@@ -107,8 +62,8 @@ class SessionToken(PangeaResponseResult):
     expire: str
     identity: str
     email: str
-    scopes: Optional[Scopes] = None
-    profile: Union[Profile, Dict[str, str]]
+    scopes: Optional[list[Scope]] = None
+    profile: dict[str, str]
     created_at: str
     intelligence: Optional[Intelligence] = None
 
@@ -117,8 +72,45 @@ class LoginToken(SessionToken):
     token: str
 
 
-class ClientTokenCheckResult(SessionToken):
-    token: Optional[str] = None
+class ClientTokenCheckResult(PangeaResponseResult):
+    id: TokenId
+    """An ID for a token"""
+
+    type: TokenType
+    """A token type"""
+
+    life: Annotated[int, Field(gt=0)]
+    """A positive time duration in seconds"""
+
+    expire: PangeaDateTime
+    """A time in ISO-8601 format"""
+
+    enabled: Optional[bool] = None
+    identity: Identity
+    """The identity of a user or a service"""
+
+    email: str
+    scopes: Annotated[Optional[list[Scope]], Field(examples=[["scope1", "scope2"]])] = None
+    """A list of scopes"""
+
+    profile: Annotated[dict[str, str], Field(examples=[{"first_name": "Joe", "last_name": "User"}])]
+    """A user profile as a collection of string properties"""
+
+    created_at: PangeaDateTime
+    """A time in ISO-8601 format"""
+
+    intelligence: Optional[Intelligence] = None
+    audience: Optional[list[str]] = None
+    client_id: Annotated[
+        Optional[str],
+        Field(
+            examples=["psa_wuk7tvtpswyjtlsx52b7yyi2l7zotv4a"],
+            pattern="^psa_[a-z2-7]{32}$",
+        ),
+    ] = None
+    """An ID for a service account"""
+
+    claims: Optional[object] = None
 
 
 class IDProvider(str, enum.Enum):
@@ -248,7 +240,7 @@ class User(PangeaResponseResult):
     username: str
     """A username."""
 
-    profile: Union[Profile, Dict[str, str]]
+    profile: dict[str, str]
     """A user profile as a collection of string properties."""
 
     verified: bool
@@ -273,7 +265,7 @@ class User(PangeaResponseResult):
     last_login_ip: Optional[str] = None
     last_login_city: Optional[str] = None
     last_login_country: Optional[str] = None
-    authenticators: List[Authenticator] = []
+    authenticators: list[Authenticator] = []
     """A list of authenticators."""
 
 
@@ -281,7 +273,7 @@ class UserCreateRequest(APIRequestModel):
     email: str
     """An email address."""
 
-    profile: Union[Profile, Dict[str, str]]
+    profile: Mapping[str, str]
     """A user profile as a collection of string properties."""
 
     username: Optional[str] = None
@@ -309,8 +301,8 @@ class UserDeleteResult(PangeaResponseResult):
 
 class UserListFilter(APIRequestModel):
     accepted_eula_id: Optional[str] = None
-    accepted_eula_id__contains: Optional[List[str]] = None
-    accepted_eula_id__in: Optional[List[str]] = None
+    accepted_eula_id__contains: Optional[list[str]] = None
+    accepted_eula_id__in: Optional[list[str]] = None
     created_at: Optional[str] = None
     created_at__gt: Optional[str] = None
     created_at__gte: Optional[str] = None
@@ -318,32 +310,32 @@ class UserListFilter(APIRequestModel):
     created_at__lte: Optional[str] = None
     disabled: Optional[bool] = None
     email: Optional[str] = None
-    email__contains: Optional[List[str]] = None
-    email__in: Optional[List[str]] = None
+    email__contains: Optional[list[str]] = None
+    email__in: Optional[list[str]] = None
     id: Optional[str] = None
-    id__contains: Optional[List[str]] = None
-    id__in: Optional[List[str]] = None
+    id__contains: Optional[list[str]] = None
+    id__in: Optional[list[str]] = None
     last_login_at: Optional[str] = None
     last_login_at__gt: Optional[str] = None
     last_login_at__gte: Optional[str] = None
     last_login_at__lt: Optional[str] = None
     last_login_at__lte: Optional[str] = None
     last_login_ip: Optional[str] = None
-    last_login_ip__contains: Optional[List[str]] = None
-    last_login_ip__in: Optional[List[str]] = None
+    last_login_ip__contains: Optional[list[str]] = None
+    last_login_ip__in: Optional[list[str]] = None
     last_login_city: Optional[str] = None
-    last_login_city__contains: Optional[List[str]] = None
-    last_login_city__in: Optional[List[str]] = None
+    last_login_city__contains: Optional[list[str]] = None
+    last_login_city__in: Optional[list[str]] = None
     last_login_country: Optional[str] = None
-    last_login_country__contains: Optional[List[str]] = None
-    last_login_country__in: Optional[List[str]] = None
+    last_login_country__contains: Optional[list[str]] = None
+    last_login_country__in: Optional[list[str]] = None
     login_count: Optional[int] = None
     login_count__gt: Optional[int] = None
     login_count__gte: Optional[int] = None
     login_count__lt: Optional[int] = None
     login_count__lte: Optional[int] = None
     require_mfa: Optional[bool] = None
-    scopes: Optional[List[str]] = None
+    scopes: Optional[list[str]] = None
     verified: Optional[bool] = None
 
 
@@ -356,7 +348,7 @@ class UserListRequest(APIRequestModel):
 
 
 class UserListResult(PangeaResponseResult):
-    users: List[User]
+    users: list[User]
     last: Optional[str] = None
     count: int
 
@@ -404,35 +396,35 @@ class UserInviterOrderBy(enum.Enum):
 
 class UserInviteListFilter(APIRequestModel):
     callback: Optional[str] = None
-    callback__contains: Optional[List[str]] = None
-    callback__in: Optional[List[str]] = None
+    callback__contains: Optional[list[str]] = None
+    callback__in: Optional[list[str]] = None
     created_at: Optional[str] = None
     created_at__gt: Optional[str] = None
     created_at__gte: Optional[str] = None
     created_at__lt: Optional[str] = None
     created_at__lte: Optional[str] = None
     email: Optional[str] = None
-    email__contains: Optional[List[str]] = None
-    email__in: Optional[List[str]] = None
+    email__contains: Optional[list[str]] = None
+    email__in: Optional[list[str]] = None
     expire: Optional[str] = None
     expire__gt: Optional[str] = None
     expire__gte: Optional[str] = None
     expire__lt: Optional[str] = None
     expire__lte: Optional[str] = None
     id: Optional[str] = None
-    id__contains: Optional[List[str]] = None
-    id__in: Optional[List[str]] = None
+    id__contains: Optional[list[str]] = None
+    id__in: Optional[list[str]] = None
     invite_org: Optional[str] = None
-    invite_org__contains: Optional[List[str]] = None
-    invite_org__in: Optional[List[str]] = None
+    invite_org__contains: Optional[list[str]] = None
+    invite_org__in: Optional[list[str]] = None
     inviter: Optional[str] = None
-    inviter__contains: Optional[List[str]] = None
-    inviter__in: Optional[List[str]] = None
+    inviter__contains: Optional[list[str]] = None
+    inviter__in: Optional[list[str]] = None
     is_signup: Optional[bool] = None
     require_mfa: Optional[bool] = None
     state: Optional[str] = None
-    state__contains: Optional[List[str]] = None
-    state__in: Optional[List[str]] = None
+    state__contains: Optional[list[str]] = None
+    state__in: Optional[list[str]] = None
 
 
 class UserInviteListRequest(APIRequestModel):
@@ -444,7 +436,7 @@ class UserInviteListRequest(APIRequestModel):
 
 
 class UserInviteListResult(PangeaResponseResult):
-    invites: List[UserInvite]
+    invites: list[UserInvite]
 
 
 class UserInviteDeleteRequest(APIRequestModel):
@@ -471,7 +463,7 @@ class UserProfileGetResult(User):
 
 
 class UserProfileUpdateRequest(APIRequestModel):
-    profile: Union[Profile, Dict[str, str]]
+    profile: Mapping[str, str]
     """Updates to a user profile."""
 
     id: Optional[str] = None
@@ -525,7 +517,7 @@ class ClientUserinfoRequest(APIRequestModel):
 
 
 class ClientJWKSResult(PangeaResponseResult):
-    keys: List[Union[JWKec, JWKrsa, JWK]]
+    keys: list[Union[JWKec, JWKrsa, JWK]]
 
 
 class UserAuthenticatorsDeleteRequest(APIRequestModel):
@@ -558,7 +550,7 @@ class UserAuthenticatorsListRequest(APIRequestModel):
 
 
 class UserAuthenticatorsListResult(PangeaResponseResult):
-    authenticators: List[Authenticator] = []
+    authenticators: list[Authenticator] = []
     """A list of authenticators."""
 
 
@@ -573,16 +565,16 @@ class FlowCompleteResult(PangeaResponseResult):
 
 class FlowChoiceItem(APIResponseModel):
     choice: str
-    data: Dict = {}
+    data: dict = {}
 
 
 class CommonFlowResult(PangeaResponseResult):
     flow_id: str
-    flow_type: List[str] = []
+    flow_type: list[str] = []
     email: Optional[str] = None
     disclaimer: Optional[str] = None
     flow_phase: str
-    flow_choices: List[FlowChoiceItem] = []
+    flow_choices: list[FlowChoiceItem] = []
 
 
 class FlowChoice(enum.Enum):
@@ -612,7 +604,7 @@ class FlowRestartDataSMSOTP(APIRequestModel):
     phone: str
 
 
-FlowRestartData = Union[Dict, FlowRestartDataSMSOTP]
+FlowRestartData = Union[dict, FlowRestartDataSMSOTP]
 
 
 class FlowRestartRequest(APIRequestModel):
@@ -628,7 +620,7 @@ class FlowRestartResult(CommonFlowResult):
 class FlowStartRequest(APIRequestModel):
     cb_uri: Optional[str] = None
     email: Optional[str] = None
-    flow_types: Optional[List[FlowType]] = None
+    flow_types: Optional[list[FlowType]] = None
     invitation: Optional[str] = None
 
 
@@ -637,7 +629,7 @@ class FlowStartResult(CommonFlowResult):
 
 
 class FlowUpdateDataAgreements(APIRequestModel):
-    agreed: List[str]
+    agreed: list[str]
 
 
 class FlowUpdateDataCaptcha(APIRequestModel):
@@ -658,7 +650,7 @@ class FlowUpdateDataPassword(APIRequestModel):
 
 
 class FlowUpdateDataProfile(APIRequestModel):
-    profile: Union[Profile, Dict[str, str]]
+    profile: dict[str, str]
 
 
 class FlowUpdateDataProvisionalEnrollment(APIRequestModel):
@@ -698,7 +690,7 @@ class FlowUpdateDataVerifyEmail(APIRequestModel):
 
 
 FlowUpdateData = Union[
-    Dict,
+    dict,
     FlowUpdateDataAgreements,
     FlowUpdateDataCaptcha,
     FlowUpdateDataEmailOTP,
@@ -737,31 +729,31 @@ class ClientSessionInvalidateResult(PangeaResponseResult):
 
 class SessionListFilter(APIRequestModel):
     active_token_id: Optional[str] = None
-    active_token_id__contains: Optional[List[str]] = None
-    active_token_id__in: Optional[List[str]] = None
+    active_token_id__contains: Optional[list[str]] = None
+    active_token_id__in: Optional[list[str]] = None
     created_at: Optional[str] = None
     created_at__gt: Optional[str] = None
     created_at__gte: Optional[str] = None
     created_at__lt: Optional[str] = None
     created_at__lte: Optional[str] = None
     email: Optional[str] = None
-    email__contains: Optional[List[str]] = None
-    email__in: Optional[List[str]] = None
+    email__contains: Optional[list[str]] = None
+    email__in: Optional[list[str]] = None
     expire: Optional[str] = None
     expire__gt: Optional[str] = None
     expire__gte: Optional[str] = None
     expire__lt: Optional[str] = None
     expire__lte: Optional[str] = None
     id: Optional[str] = None
-    id__contains: Optional[List[str]] = None
-    id__in: Optional[List[str]] = None
+    id__contains: Optional[list[str]] = None
+    id__in: Optional[list[str]] = None
     identity: Optional[str] = None
-    identity__contains: Optional[List[str]] = None
-    identity__in: Optional[List[str]] = None
-    scopes: Optional[List[str]] = None
+    identity__contains: Optional[list[str]] = None
+    identity__in: Optional[list[str]] = None
+    scopes: Optional[list[str]] = None
     type: Optional[str] = None
-    type__contains: Optional[List[str]] = None
-    type__in: Optional[List[str]] = None
+    type__contains: Optional[list[str]] = None
+    type__in: Optional[list[str]] = None
 
 
 class ClientSessionListRequest(APIRequestModel):
@@ -779,19 +771,19 @@ class SessionItem(APIResponseModel):
     life: int
     expire: str
     email: str
-    scopes: Optional[Scopes] = None
-    profile: Union[Profile, Dict[str, str]]
+    scopes: Optional[list[Scope]] = None
+    profile: dict[str, str]
     created_at: str
     active_token: Optional[SessionToken] = None
 
 
 class ClientSessionListResults(PangeaResponseResult):
-    sessions: List[SessionItem]
+    sessions: list[SessionItem]
     last: str
 
 
 class SessionListResults(PangeaResponseResult):
-    sessions: List[SessionItem]
+    sessions: list[SessionItem]
     last: str
 
 
@@ -894,28 +886,61 @@ class AgreementListOrderBy(enum.Enum):
 
 class AgreementListFilter(APIRequestModel):
     active: Optional[bool] = None
-    created_at: Optional[str] = None
-    created_at__gt: Optional[str] = None
-    created_at__gte: Optional[str] = None
-    created_at__lt: Optional[str] = None
-    created_at__lte: Optional[str] = None
-    published_at: Optional[str] = None
-    published_at__gt: Optional[str] = None
-    published_at__gte: Optional[str] = None
-    published_at__lt: Optional[str] = None
-    published_at__lte: Optional[str] = None
-    type: Optional[str] = None
-    type__contains: Optional[List[str]] = None
-    type__in: Optional[List[str]] = None
+    """Only records where active equals this value."""
+    created_at: Optional[PangeaDateTime] = None
+    """Only records where created_at equals this value."""
+    created_at__gt: Optional[PangeaDateTime] = None
+    """Only records where created_at is greater than this value."""
+    created_at__gte: Optional[PangeaDateTime] = None
+    """Only records where created_at is greater than or equal to this value."""
+    created_at__lt: Optional[PangeaDateTime] = None
+    """Only records where created_at is less than this value."""
+    created_at__lte: Optional[PangeaDateTime] = None
+    """Only records where created_at is less than or equal to this value."""
     id: Optional[str] = None
-    id__contains: Optional[List[str]] = None
-    id__in: Optional[List[str]] = None
+    """Only records where id equals this value."""
+    id__contains: Optional[list[str]] = None
+    """Only records where id includes each substring."""
+    id__in: Optional[list[str]] = None
+    """Only records where id equals one of the provided substrings."""
     name: Optional[str] = None
-    name__contains: Optional[List[str]] = None
-    name__in: Optional[List[str]] = None
+    """Only records where name equals this value."""
+    name__contains: Optional[list[str]] = None
+    """Only records where name includes each substring."""
+    name__in: Optional[list[str]] = None
+    """Only records where name equals one of the provided substrings."""
+    published_at: Optional[PangeaDateTime] = None
+    """Only records where published_at equals this value."""
+    published_at__gt: Optional[PangeaDateTime] = None
+    """Only records where published_at is greater than this value."""
+    published_at__gte: Optional[PangeaDateTime] = None
+    """Only records where published_at is greater than or equal to this value."""
+    published_at__lt: Optional[PangeaDateTime] = None
+    """Only records where published_at is less than this value."""
+    published_at__lte: Optional[PangeaDateTime] = None
+    """Only records where published_at is less than or equal to this value."""
     text: Optional[str] = None
-    text__contains: Optional[List[str]] = None
-    text__in: Optional[List[str]] = None
+    """Only records where text equals this value."""
+    text__contains: Optional[list[str]] = None
+    """Only records where text includes each substring."""
+    text__in: Optional[list[str]] = None
+    """Only records where text equals one of the provided substrings."""
+    type: Optional[str] = None
+    """Only records where type equals this value."""
+    type__contains: Optional[list[str]] = None
+    """Only records where type includes each substring."""
+    type__in: Optional[list[str]] = None
+    """Only records where type equals one of the provided substrings."""
+    updated_at: Optional[PangeaDateTime] = None
+    """Only records where updated_at equals this value."""
+    updated_at__gt: Optional[PangeaDateTime] = None
+    """Only records where updated_at is greater than this value."""
+    updated_at__gte: Optional[PangeaDateTime] = None
+    """Only records where updated_at is greater than or equal to this value."""
+    updated_at__lt: Optional[PangeaDateTime] = None
+    """Only records where updated_at is less than this value."""
+    updated_at__lte: Optional[PangeaDateTime] = None
+    """Only records where updated_at is less than or equal to this value."""
 
 
 class AgreementListRequest(APIRequestModel):
@@ -927,7 +952,7 @@ class AgreementListRequest(APIRequestModel):
 
 
 class AgreementListResult(PangeaResponseResult):
-    agreements: List[AgreementInfo]
+    agreements: list[AgreementInfo]
     count: int
     last: Optional[str] = None
 
@@ -947,14 +972,21 @@ class AgreementUpdateResult(AgreementInfo):
 class GroupInfo(PangeaResponseResult):
     """A group and its information"""
 
-    id: str
+    id: GroupId
+    """An ID for a group"""
+
     name: str
     type: str
 
     description: Optional[str] = None
-    attributes: Optional[Dict[str, str]] = None
-    created_at: Optional[str] = None
-    updated_at: Optional[str] = None
+    attributes: Optional[dict[str, str]] = None
+    """A collection of key/value pairs"""
+
+    created_at: Optional[PangeaDateTime] = None
+    """A time in ISO-8601 format"""
+
+    updated_at: Optional[PangeaDateTime] = None
+    """A time in ISO-8601 format"""
 
 
 class GroupsFilter(APIRequestModel):
@@ -981,28 +1013,28 @@ class GroupsFilter(APIRequestModel):
     id: Optional[str] = None
     """Only records where id equals this value."""
 
-    id__contains: Optional[List[str]] = None
+    id__contains: Optional[list[str]] = None
     """Only records where id includes each substring."""
 
-    id__in: Optional[List[str]] = None
+    id__in: Optional[list[str]] = None
     """Only records where id equals one of the provided substrings."""
 
     name: Optional[str] = None
     """Only records where name equals this value."""
 
-    name__contains: Optional[List[str]] = None
+    name__contains: Optional[list[str]] = None
     """Only records where name includes each substring."""
 
-    name__in: Optional[List[str]] = None
+    name__in: Optional[list[str]] = None
     """Only records where name equals one of the provided substrings."""
 
     type: Optional[str] = None
     """Only records where type equals this value."""
 
-    type__contains: Optional[List[str]] = None
+    type__contains: Optional[list[str]] = None
     """Only records where type includes each substring."""
 
-    type__in: Optional[List[str]] = None
+    type__in: Optional[list[str]] = None
     """Only records where type equals one of the provided substrings."""
 
     updated_at: Optional[str] = None
@@ -1025,7 +1057,7 @@ class GroupsFilter(APIRequestModel):
 
 
 class GroupList(PangeaResponseResult):
-    groups: List[GroupInfo]
+    groups: list[GroupInfo]
     """List of matching groups"""
 
     count: int
@@ -1033,6 +1065,6 @@ class GroupList(PangeaResponseResult):
 
 
 class GroupUserList(PangeaResponseResult):
-    users: List[User]
+    users: list[User]
     count: int
     last: Optional[str] = None