pangea-sdk 3.8.0b1__py3-none-any.whl → 5.4.0b1__py3-none-any.whl

pangea/services/authn/authn.py

@@ -1,10 +1,12 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+from __future__ import annotations
 
 from typing import Dict, List, Optional, Union
 
 import pangea.services.authn.models as m
-from pangea.response import PangeaResponse
+from pangea.config import PangeaConfig
+from pangea.response import PangeaResponse, PangeaResponseResult
 from pangea.services.base import ServiceBase
 
 SERVICE_NAME = "authn"
@@ -37,10 +39,24 @@ class AuthN(ServiceBase):
 
     def __init__(
         self,
-        token,
-        config=None,
-        logger_name="pangea",
-    ):
+        token: str,
+        config: PangeaConfig | None = None,
+        logger_name: str = "pangea",
+    ) -> None:
+        """
+        AuthN client
+
+        Initializes a new AuthN client.
+
+        Args:
+            token: Pangea API token.
+            config: Configuration.
+            logger_name: Logger name.
+
+        Examples:
+             config = PangeaConfig(domain="pangea_domain")
+             authn = AuthN(token="pangea_token", config=config)
+        """
         super().__init__(token, config, logger_name=logger_name)
         self.user = AuthN.User(token, config, logger_name=logger_name)
         self.flow = AuthN.Flow(token, config, logger_name=logger_name)
@@ -80,7 +96,7 @@ class AuthN(ServiceBase):
             """
             input = m.SessionInvalidateRequest(session_id=session_id)
             return self.request.post(
-                "v2/session/invalidate", m.SessionInvalidateResult, data=input.dict(exclude_none=True)
+                "v2/session/invalidate", m.SessionInvalidateResult, data=input.model_dump(exclude_none=True)
             )
 
         def list(
@@ -118,7 +134,7 @@ class AuthN(ServiceBase):
                 filter = m.SessionListFilter(**filter)
 
             input = m.SessionListRequest(filter=filter, last=last, order=order, order_by=order_by, size=size)
-            return self.request.post("v2/session/list", m.SessionListResults, data=input.dict(exclude_none=True))
+            return self.request.post("v2/session/list", m.SessionListResults, data=input.model_dump(exclude_none=True))
 
         def logout(self, user_id: str) -> PangeaResponse[m.SessionLogoutResult]:
             """
@@ -140,7 +156,9 @@ class AuthN(ServiceBase):
                 )
             """
             input = m.SessionLogoutRequest(user_id=user_id)
-            return self.request.post("v2/session/logout", m.SessionLogoutResult, data=input.dict(exclude_none=True))
+            return self.request.post(
+                "v2/session/logout", m.SessionLogoutResult, data=input.model_dump(exclude_none=True)
+            )
 
     class Client(ServiceBase):
         service_name = SERVICE_NAME
@@ -178,7 +196,9 @@ class AuthN(ServiceBase):
                 )
             """
             input = m.ClientUserinfoRequest(code=code)
-            return self.request.post("v2/client/userinfo", m.ClientUserinfoResult, data=input.dict(exclude_none=True))
+            return self.request.post(
+                "v2/client/userinfo", m.ClientUserinfoResult, data=input.model_dump(exclude_none=True)
+            )
 
         def jwks(
             self,
@@ -234,7 +254,9 @@ class AuthN(ServiceBase):
                 """
                 input = m.ClientSessionInvalidateRequest(token=token, session_id=session_id)
                 return self.request.post(
-                    "v2/client/session/invalidate", m.ClientSessionInvalidateResult, data=input.dict(exclude_none=True)
+                    "v2/client/session/invalidate",
+                    m.ClientSessionInvalidateResult,
+                    data=input.model_dump(exclude_none=True),
                 )
 
             def list(
@@ -279,7 +301,7 @@ class AuthN(ServiceBase):
                     token=token, filter=filter, last=last, order=order, order_by=order_by, size=size
                 )
                 return self.request.post(
-                    "v2/client/session/list", m.ClientSessionListResults, data=input.dict(exclude_none=True)
+                    "v2/client/session/list", m.ClientSessionListResults, data=input.model_dump(exclude_none=True)
                 )
 
             def logout(self, token: str) -> PangeaResponse[m.ClientSessionLogoutResult]:
@@ -303,7 +325,7 @@ class AuthN(ServiceBase):
                 """
                 input = m.ClientSessionLogoutRequest(token=token)
                 return self.request.post(
-                    "v2/client/session/logout", m.ClientSessionLogoutResult, data=input.dict(exclude_none=True)
+                    "v2/client/session/logout", m.ClientSessionLogoutResult, data=input.model_dump(exclude_none=True)
                 )
 
             def refresh(
@@ -333,7 +355,7 @@ class AuthN(ServiceBase):
                 """
                 input = m.ClientSessionRefreshRequest(refresh_token=refresh_token, user_token=user_token)
                 return self.request.post(
-                    "v2/client/session/refresh", m.ClientSessionRefreshResult, data=input.dict(exclude_none=True)
+                    "v2/client/session/refresh", m.ClientSessionRefreshResult, data=input.model_dump(exclude_none=True)
                 )
 
         class Password(ServiceBase):
@@ -341,10 +363,10 @@ class AuthN(ServiceBase):
 
             def __init__(
                 self,
-                token,
-                config=None,
-                logger_name="pangea",
-            ):
+                token: str,
+                config: PangeaConfig | None = None,
+                logger_name: str = "pangea",
+            ) -> None:
                 super().__init__(token, config, logger_name=logger_name)
 
             def change(
@@ -374,9 +396,28 @@ class AuthN(ServiceBase):
                 """
                 input = m.ClientPasswordChangeRequest(token=token, old_password=old_password, new_password=new_password)
                 return self.request.post(
-                    "v2/client/password/change", m.ClientPasswordChangeResult, data=input.dict(exclude_none=True)
+                    "v2/client/password/change", m.ClientPasswordChangeResult, data=input.model_dump(exclude_none=True)
                 )
 
+            def expire(self, user_id: str) -> PangeaResponse[PangeaResponseResult]:
+                """
+                Expire a user's password
+
+                Expire a user's password.
+
+                OperationId: authn_post_v2_user_password_expire
+
+                Args:
+                    user_id: The identity of a user or a service.
+
+                Returns:
+                    A PangeaResponse with an empty object in the response.result field.
+
+                Examples:
+                    authn.client.password.expire("pui_[...]")
+                """
+                return self.request.post("v2/user/password/expire", PangeaResponseResult, {"id": user_id})
+
         class Token(ServiceBase):
             service_name = SERVICE_NAME
 
@@ -411,7 +452,7 @@ class AuthN(ServiceBase):
                 """
                 input = m.ClientTokenCheckRequest(token=token)
                 return self.request.post(
-                    "v2/client/token/check", m.ClientTokenCheckResult, data=input.dict(exclude_none=True)
+                    "v2/client/token/check", m.ClientTokenCheckResult, data=input.model_dump(exclude_none=True)
                 )
 
     class User(ServiceBase):
@@ -432,6 +473,8 @@ class AuthN(ServiceBase):
             self,
             email: str,
             profile: m.Profile,
+            *,
+            username: str | None = None,
         ) -> PangeaResponse[m.UserCreateResult]:
             """
             Create User
@@ -441,8 +484,9 @@ class AuthN(ServiceBase):
             OperationId: authn_post_v2_user_create
 
             Args:
-                email (str): An email address
-                profile (m.Profile): A user profile as a collection of string properties
+                email: An email address.
+                profile: A user profile as a collection of string properties.
+                username: A username.
 
             Returns:
                 A PangeaResponse with a user and its information in the response.result field.
@@ -461,10 +505,13 @@ class AuthN(ServiceBase):
             input = m.UserCreateRequest(
                 email=email,
                 profile=profile,
+                username=username,
             )
-            return self.request.post("v2/user/create", m.UserCreateResult, data=input.dict(exclude_none=True))
+            return self.request.post("v2/user/create", m.UserCreateResult, data=input.model_dump(exclude_none=True))
 
-        def delete(self, email: Optional[str] = None, id: Optional[str] = None) -> PangeaResponse[m.UserDeleteResult]:
+        def delete(
+            self, email: str | None = None, id: str | None = None, *, username: str | None = None
+        ) -> PangeaResponse[m.UserDeleteResult]:
             """
             Delete User
 
@@ -473,8 +520,9 @@ class AuthN(ServiceBase):
             OperationId: authn_post_v2_user_delete
 
             Args:
-                email (str, optional): An email address
-                id (str, optional): The id of a user or a service
+                email: An email address.
+                id: The id of a user or a service.
+                username: A username.
 
             Returns:
                 A PangeaResponse with an empty object in the response.result field.
@@ -482,8 +530,8 @@ class AuthN(ServiceBase):
             Examples:
                 authn.user.delete(email="example@example.com")
             """
-            input = m.UserDeleteRequest(email=email, id=id)
-            return self.request.post("v2/user/delete", m.UserDeleteResult, data=input.dict(exclude_none=True))
+            input = m.UserDeleteRequest(email=email, id=id, username=username)
+            return self.request.post("v2/user/delete", m.UserDeleteResult, data=input.model_dump(exclude_none=True))
 
         def invite(
             self,
@@ -524,14 +572,16 @@ class AuthN(ServiceBase):
                 callback=callback,
                 state=state,
             )
-            return self.request.post("v2/user/invite", m.UserInviteResult, data=input.dict(exclude_none=True))
+            return self.request.post("v2/user/invite", m.UserInviteResult, data=input.model_dump(exclude_none=True))
 
         def update(
             self,
-            disabled: Optional[bool] = None,
-            id: Optional[str] = None,
-            email: Optional[str] = None,
-            unlock: Optional[bool] = None,
+            disabled: bool | None = None,
+            id: str | None = None,
+            email: str | None = None,
+            unlock: bool | None = None,
+            *,
+            username: str | None = None,
         ) -> PangeaResponse[m.UserUpdateResult]:
             """
             Update user's settings
@@ -541,11 +591,12 @@ class AuthN(ServiceBase):
             OperationId: authn_post_v2_user_update
 
             Args:
-                disabled (bool): New disabled value.
+                disabled: New disabled value.
                     Disabling a user account will prevent them from logging in.
-                unlock (bool): Unlock a user account if it has been locked out due to failed Authentication attempts.
-                id (str, optional): The identity of a user or a service
-                email (str, optional): An email address
+                unlock: Unlock a user account if it has been locked out due to failed authentication attempts.
+                id: The identity of a user or a service.
+                email: An email address.
+                username: A username.
 
             Returns:
                 A PangeaResponse with a user and its information in the response.result field.
@@ -563,9 +614,10 @@ class AuthN(ServiceBase):
                 email=email,
                 disabled=disabled,
                 unlock=unlock,
+                username=username,
             )
 
-            return self.request.post("v2/user/update", m.UserUpdateResult, data=input.dict(exclude_none=True))
+            return self.request.post("v2/user/update", m.UserUpdateResult, data=input.model_dump(exclude_none=True))
 
         def list(
             self,
@@ -608,7 +660,7 @@ class AuthN(ServiceBase):
                 order_by=order_by,
                 size=size,
             )
-            return self.request.post("v2/user/list", m.UserListResult, data=input.dict(exclude_none=True))
+            return self.request.post("v2/user/list", m.UserListResult, data=input.model_dump(exclude_none=True))
 
         class Invites(ServiceBase):
             service_name = SERVICE_NAME
@@ -655,7 +707,7 @@ class AuthN(ServiceBase):
 
                 input = m.UserInviteListRequest(filter=filter, last=last, order=order, order_by=order_by, size=size)
                 return self.request.post(
-                    "v2/user/invite/list", m.UserInviteListResult, data=input.dict(exclude_none=True)
+                    "v2/user/invite/list", m.UserInviteListResult, data=input.model_dump(exclude_none=True)
                 )
 
             def delete(self, id: str) -> PangeaResponse[m.UserInviteDeleteResult]:
@@ -679,7 +731,7 @@ class AuthN(ServiceBase):
                 """
                 input = m.UserInviteDeleteRequest(id=id)
                 return self.request.post(
-                    "v2/user/invite/delete", m.UserInviteDeleteResult, data=input.dict(exclude_none=True)
+                    "v2/user/invite/delete", m.UserInviteDeleteResult, data=input.model_dump(exclude_none=True)
                 )
 
         class Authenticators(ServiceBase):
@@ -694,7 +746,12 @@ class AuthN(ServiceBase):
                 super().__init__(token, config, logger_name=logger_name)
 
             def delete(
-                self, authenticator_id: str, id: Optional[str] = None, email: Optional[str] = None
+                self,
+                authenticator_id: str,
+                id: str | None = None,
+                email: str | None = None,
+                *,
+                username: str | None = None,
             ) -> PangeaResponse[m.UserAuthenticatorsDeleteResult]:
                 """
                 Delete user authenticator
@@ -704,9 +761,10 @@ class AuthN(ServiceBase):
                 OperationId: authn_post_v2_user_authenticators_delete
 
                 Args:
-                    authenticator_id (str): An ID for an authenticator
-                    id (str, optional): The identity of a user or a service
-                    email (str, optional): An email address
+                    authenticator_id: An ID for an authenticator.
+                    id: The identity of a user or a service.
+                    email: An email address.
+                    username: A username.
 
                 Returns:
                     A PangeaResponse with an empty object in the response.result field.
@@ -717,15 +775,17 @@ class AuthN(ServiceBase):
                         id="pui_xpkhwpnz2cmegsws737xbsqnmnuwtbm5",
                     )
                 """
-                input = m.UserAuthenticatorsDeleteRequest(authenticator_id=authenticator_id, email=email, id=id)
+                input = m.UserAuthenticatorsDeleteRequest(
+                    authenticator_id=authenticator_id, email=email, id=id, username=username
+                )
                 return self.request.post(
                     "v2/user/authenticators/delete",
                     m.UserAuthenticatorsDeleteResult,
-                    data=input.dict(exclude_none=True),
+                    data=input.model_dump(exclude_none=True),
                 )
 
             def list(
-                self, email: Optional[str] = None, id: Optional[str] = None
+                self, email: str | None = None, id: str | None = None, *, username: str | None = None
             ) -> PangeaResponse[m.UserAuthenticatorsListResult]:
                 """
                 Get user authenticators
@@ -735,8 +795,9 @@ class AuthN(ServiceBase):
                 OperationId: authn_post_v2_user_authenticators_list
 
                 Args:
-                    email (str, optional): An email address
-                    id (str, optional): The identity of a user or a service
+                    email: An email address.
+                    id: The identity of a user or a service.
+                    username: A username.
 
                 Returns:
                     A PangeaResponse with a list of authenticators in the response.result field.
@@ -748,9 +809,11 @@ class AuthN(ServiceBase):
                         id="pui_xpkhwpnz2cmegsws737xbsqnmnuwtbm5",
                     )
                 """
-                input = m.UserAuthenticatorsListRequest(email=email, id=id)
+                input = m.UserAuthenticatorsListRequest(email=email, id=id, username=username)
                 return self.request.post(
-                    "v2/user/authenticators/list", m.UserAuthenticatorsListResult, data=input.dict(exclude_none=True)
+                    "v2/user/authenticators/list",
+                    m.UserAuthenticatorsListResult,
+                    data=input.model_dump(exclude_none=True),
                 )
 
         class Profile(ServiceBase):
@@ -765,7 +828,7 @@ class AuthN(ServiceBase):
                 super().__init__(token, config, logger_name=logger_name)
 
             def get(
-                self, id: Optional[str] = None, email: Optional[str] = None
+                self, id: str | None = None, email: str | None = None, *, username: str | None = None
             ) -> PangeaResponse[m.UserProfileGetResult]:
                 """
                 Get user
@@ -775,8 +838,9 @@ class AuthN(ServiceBase):
                 OperationId: authn_post_v2_user_profile_get
 
                 Args:
-                    id (str, optional): The identity of a user or a service
-                    email (str, optional): An email address
+                    id: The identity of a user or a service.
+                    email: An email address.
+                    username: A username.
 
                 Returns:
                     A PangeaResponse with a user and its information in the response.result field.
@@ -788,16 +852,18 @@ class AuthN(ServiceBase):
                         email="joe.user@email.com",
                     )
                 """
-                input = m.UserProfileGetRequest(id=id, email=email)
+                input = m.UserProfileGetRequest(id=id, email=email, username=username)
                 return self.request.post(
-                    "v2/user/profile/get", m.UserProfileGetResult, data=input.dict(exclude_none=True)
+                    "v2/user/profile/get", m.UserProfileGetResult, data=input.model_dump(exclude_none=True)
                 )
 
             def update(
                 self,
                 profile: m.Profile,
-                id: Optional[str] = None,
-                email: Optional[str] = None,
+                id: str | None = None,
+                email: str | None = None,
+                *,
+                username: str | None = None,
             ) -> PangeaResponse[m.UserProfileUpdateResult]:
                 """
                 Update user
@@ -807,9 +873,10 @@ class AuthN(ServiceBase):
                 OperationId: authn_post_v2_user_profile_update
 
                 Args:
-                    profile (m.Profile): Updates to a user profile
-                    id (str, optional): The identity of a user or a service
-                    email (str, optional): An email address
+                    profile: Updates to a user profile.
+                    id: The identity of a user or a service.
+                    email: An email address.
+                    username: A username.
 
                 Returns:
                     A PangeaResponse with a user and its information in the response.result field.
@@ -828,9 +895,10 @@ class AuthN(ServiceBase):
                     id=id,
                     email=email,
                     profile=profile,
+                    username=username,
                 )
                 return self.request.post(
-                    "v2/user/profile/update", m.UserProfileUpdateResult, data=input.dict(exclude_none=True)
+                    "v2/user/profile/update", m.UserProfileUpdateResult, data=input.model_dump(exclude_none=True)
                 )
 
     class Flow(ServiceBase):
@@ -866,7 +934,7 @@ class AuthN(ServiceBase):
                 )
             """
             input = m.FlowCompleteRequest(flow_id=flow_id)
-            return self.request.post("v2/flow/complete", m.FlowCompleteResult, data=input.dict(exclude_none=True))
+            return self.request.post("v2/flow/complete", m.FlowCompleteResult, data=input.model_dump(exclude_none=True))
 
         def restart(
             self, flow_id: str, choice: m.FlowChoice, data: m.FlowRestartData = {}
@@ -898,7 +966,7 @@ class AuthN(ServiceBase):
             """
 
             input = m.FlowRestartRequest(flow_id=flow_id, choice=choice, data=data)
-            return self.request.post("v2/flow/restart", m.FlowRestartResult, data=input.dict(exclude_none=True))
+            return self.request.post("v2/flow/restart", m.FlowRestartResult, data=input.model_dump(exclude_none=True))
 
         def start(
             self,
@@ -937,7 +1005,7 @@ class AuthN(ServiceBase):
                 )
             """
             input = m.FlowStartRequest(cb_uri=cb_uri, email=email, flow_types=flow_types, invitation=invitation)
-            return self.request.post("v2/flow/start", m.FlowStartResult, data=input.dict(exclude_none=True))
+            return self.request.post("v2/flow/start", m.FlowStartResult, data=input.model_dump(exclude_none=True))
 
         def update(
             self, flow_id: str, choice: m.FlowChoice, data: m.FlowUpdateData = {}
@@ -971,7 +1039,7 @@ class AuthN(ServiceBase):
             """
 
             input = m.FlowUpdateRequest(flow_id=flow_id, choice=choice, data=data)
-            return self.request.post("v2/flow/update", m.FlowUpdateResult, data=input.dict(exclude_none=True))
+            return self.request.post("v2/flow/update", m.FlowUpdateResult, data=input.model_dump(exclude_none=True))
 
     class Agreements(ServiceBase):
         service_name = SERVICE_NAME
@@ -1015,7 +1083,7 @@ class AuthN(ServiceBase):
 
             input = m.AgreementCreateRequest(type=type, name=name, text=text, active=active)
             return self.request.post(
-                "v2/agreements/create", m.AgreementCreateResult, data=input.dict(exclude_none=True)
+                "v2/agreements/create", m.AgreementCreateResult, data=input.model_dump(exclude_none=True)
             )
 
         def delete(self, type: m.AgreementType, id: str) -> PangeaResponse[m.AgreementDeleteResult]:
@@ -1042,7 +1110,7 @@ class AuthN(ServiceBase):
 
             input = m.AgreementDeleteRequest(type=type, id=id)
             return self.request.post(
-                "v2/agreements/delete", m.AgreementDeleteResult, data=input.dict(exclude_none=True)
+                "v2/agreements/delete", m.AgreementDeleteResult, data=input.model_dump(exclude_none=True)
             )
 
         def list(
@@ -1080,7 +1148,9 @@ class AuthN(ServiceBase):
                 filter = m.AgreementListFilter(**filter)
 
             input = m.AgreementListRequest(filter=filter, last=last, order=order, order_by=order_by, size=size)
-            return self.request.post("v2/agreements/list", m.AgreementListResult, data=input.dict(exclude_none=True))
+            return self.request.post(
+                "v2/agreements/list", m.AgreementListResult, data=input.model_dump(exclude_none=True)
+            )
 
         def update(
             self,
@@ -1120,5 +1190,5 @@ class AuthN(ServiceBase):
 
             input = m.AgreementUpdateRequest(type=type, id=id, name=name, text=text, active=active)
             return self.request.post(
-                "v2/agreements/update", m.AgreementUpdateResult, data=input.dict(exclude_none=True)
+                "v2/agreements/update", m.AgreementUpdateResult, data=input.model_dump(exclude_none=True)
             )