pangea-sdk 6.0.0__py3-none-any.whl → 6.1.1__py3-none-any.whl

pangea/services/authn/authn.py

@@ -2,14 +2,17 @@
 # Author: Pangea Cyber Corporation
 from __future__ import annotations
 
-from typing import Dict, List, Optional, Union
+from typing import Dict, List, Literal, Optional, Union
 
 import pangea.services.authn.models as m
 from pangea.config import PangeaConfig
 from pangea.response import PangeaResponse, PangeaResponseResult
 from pangea.services.base import ServiceBase
 
-SERVICE_NAME = "authn"
+__all__ = ["AuthN"]
+
+
+_SERVICE_NAME = "authn"
 
 
 class AuthN(ServiceBase):
@@ -35,7 +38,7 @@ class AuthN(ServiceBase):
         authn = AuthN(token=PANGEA_TOKEN, config=authn_config)
     """
 
-    service_name = SERVICE_NAME
+    service_name = _SERVICE_NAME
 
     def __init__(
         self,
@@ -63,9 +66,10 @@ class AuthN(ServiceBase):
         self.client = AuthN.Client(token, config, logger_name=logger_name)
         self.session = AuthN.Session(token, config, logger_name=logger_name)
         self.agreements = AuthN.Agreements(token, config, logger_name=logger_name)
+        self.group = AuthN.Group(token, config, logger_name=logger_name)
 
     class Session(ServiceBase):
-        service_name = SERVICE_NAME
+        service_name = _SERVICE_NAME
 
         def __init__(
             self,
@@ -124,7 +128,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a list of sessions in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/session/list).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/session/list-post).
 
             Examples:
                 response = authn.session.list()
@@ -161,7 +165,7 @@ class AuthN(ServiceBase):
             )
 
     class Client(ServiceBase):
-        service_name = SERVICE_NAME
+        service_name = _SERVICE_NAME
 
         def __init__(
             self,
@@ -188,7 +192,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with credentials for a login session in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/client/userinfo).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/client/userinfo-post).
 
             Examples:
                 response = authn.client.userinfo(
@@ -213,7 +217,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with jwt verification keys in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/jwt#/v2/client/jwks).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/jwt#/v2/client/jwks-post).
 
             Examples:
                 response = authn.client.jwks()
@@ -221,7 +225,7 @@ class AuthN(ServiceBase):
             return self.request.post("v2/client/jwks", m.ClientJWKSResult, {})
 
         class Session(ServiceBase):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -286,7 +290,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a list of sessions in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/list).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/list-post).
 
                 Examples:
                     response = authn.client.session.list(
@@ -345,7 +349,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with credentials for a login session in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/refresh).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/refresh-post).
 
                 Examples:
                     response = authn.client.session.refresh(
@@ -359,7 +363,7 @@ class AuthN(ServiceBase):
                 )
 
         class Password(ServiceBase):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -419,7 +423,7 @@ class AuthN(ServiceBase):
                 return self.request.post("v2/user/password/expire", PangeaResponseResult, {"id": user_id})
 
         class Token(ServiceBase):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -443,7 +447,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a token and its information in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/client/token/check).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/client/token/check-post).
 
                 Examples:
                     response = authn.client.token_endpoints.check(
@@ -456,18 +460,19 @@ class AuthN(ServiceBase):
                 )
 
     class User(ServiceBase):
-        service_name = SERVICE_NAME
+        service_name = _SERVICE_NAME
 
         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)
             self.profile = AuthN.User.Profile(token, config, logger_name=logger_name)
             self.authenticators = AuthN.User.Authenticators(token, config, logger_name=logger_name)
             self.invites = AuthN.User.Invites(token, config, logger_name=logger_name)
+            self.group = AuthN.User.Group(token, config, logger_name=logger_name)
 
         def create(
             self,
@@ -491,7 +496,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a user and its information in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/create).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/create-post).
 
             Examples:
                 response = authn.user.create(
@@ -556,7 +561,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a pending user invitation in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite-post).
 
             Examples:
                 response = authn.user.invite(
@@ -601,7 +606,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a user and its information in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/update).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/update-post).
 
             Examples:
                 response = authn.user.update(
@@ -644,7 +649,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a list of users in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/list).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/list-post).
 
             Examples:
                 response = authn.user.list()
@@ -663,7 +668,7 @@ class AuthN(ServiceBase):
             return self.request.post("v2/user/list", m.UserListResult, data=input.model_dump(exclude_none=True))
 
         class Invites(ServiceBase):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -698,7 +703,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a list of pending user invitations in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite/list).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite/list-post).
                 Examples:
                     response = authn.user.invites.list()
                 """
@@ -735,7 +740,7 @@ class AuthN(ServiceBase):
                 )
 
         class Authenticators(ServiceBase):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -802,7 +807,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a list of authenticators in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/authenticators/list).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/authenticators/list-post).
 
                 Examples:
                     response = authn.user.authenticators.list(
@@ -817,7 +822,7 @@ class AuthN(ServiceBase):
                 )
 
         class Profile(ServiceBase):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -845,7 +850,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a user and its information in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/get).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/get-post).
 
                 Examples:
                     response = authn.user.profile.get(
@@ -881,7 +886,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a user and its information in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/update).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/update-post).
 
                 Examples:
                     response = authn.user.profile.update(
@@ -901,8 +906,57 @@ class AuthN(ServiceBase):
                     "v2/user/profile/update", m.UserProfileUpdateResult, data=input.model_dump(exclude_none=True)
                 )
 
+        class Group(ServiceBase):
+            service_name = _SERVICE_NAME
+
+            def __init__(
+                self,
+                token: str,
+                config: PangeaConfig | None = None,
+                logger_name: str = "pangea",
+            ) -> None:
+                super().__init__(token, config, logger_name=logger_name)
+
+            def assign(self, user_id: str, group_ids: list[str]) -> PangeaResponse[PangeaResponseResult]:
+                """
+                Assign groups to a user
+
+                Add a list of groups to a specified user
+
+                OperationId: authn_post_v2_user_group_assign
+                """
+                return self.request.post(
+                    "v2/user/group/assign",
+                    data={"id": user_id, "group_ids": group_ids},
+                    result_class=m.PangeaResponseResult,
+                )
+
+            def remove(self, user_id: str, group_id: str) -> PangeaResponse[PangeaResponseResult]:
+                """
+                Remove a group assigned to a user
+
+                Remove a group assigned to a user
+
+                OperationId: authn_post_v2_user_group_remove
+                """
+                return self.request.post(
+                    "v2/user/group/remove",
+                    data={"id": user_id, "group_id": group_id},
+                    result_class=m.PangeaResponseResult,
+                )
+
+            def list(self, user_id: str) -> PangeaResponse[m.GroupList]:
+                """
+                List of groups assigned to a user
+
+                Return a list of ids for groups assigned to a user
+
+                OperationId: authn_post_v2_user_group_list
+                """
+                return self.request.post("v2/user/group/list", data={"id": user_id}, result_class=m.GroupList)
+
     class Flow(ServiceBase):
-        service_name = SERVICE_NAME
+        service_name = _SERVICE_NAME
 
         def __init__(
             self,
@@ -926,7 +980,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with credentials for a login session in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/complete).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/complete-post).
 
             Examples:
                 response = authn.flow.complete(
@@ -955,7 +1009,7 @@ class AuthN(ServiceBase):
                 A PangeaResponse with information about next steps needed
                     to complete a flow in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/restart).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/restart-post).
 
             Examples:
                 response = authn.flow.restart(
@@ -992,7 +1046,7 @@ class AuthN(ServiceBase):
                 A PangeaResponse with information about next steps needed
                     to complete a flow in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/start).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/start-post).
 
             Examples:
                 response = authn.flow.start(
@@ -1026,7 +1080,7 @@ class AuthN(ServiceBase):
                 A PangeaResponse with information about next steps needed
                     to complete a flow in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/update).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/update-post).
 
             Examples:
                 response = authn.flow.update(
@@ -1042,7 +1096,7 @@ class AuthN(ServiceBase):
             return self.request.post("v2/flow/update", m.FlowUpdateResult, data=input.model_dump(exclude_none=True))
 
     class Agreements(ServiceBase):
-        service_name = SERVICE_NAME
+        service_name = _SERVICE_NAME
 
         def __init__(
             self,
@@ -1071,7 +1125,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a EULA object in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/create).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/create-post).
 
             Examples:
                 response = authn.agreements.create(
@@ -1138,7 +1192,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a list of EULA objects in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/list).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/list-post).
 
             Examples:
                 response = authn.agreements.list()
@@ -1177,7 +1231,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with the updated EULA object in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/update).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/update-post).
 
             Examples:
                 response = authn.agreements.update(
@@ -1192,3 +1246,108 @@ class AuthN(ServiceBase):
             return self.request.post(
                 "v2/agreements/update", m.AgreementUpdateResult, data=input.model_dump(exclude_none=True)
             )
+
+    class Group(ServiceBase):
+        service_name = _SERVICE_NAME
+
+        def __init__(
+            self,
+            token: str,
+            config: PangeaConfig | None = None,
+            logger_name: str = "pangea",
+        ) -> None:
+            super().__init__(token, config, logger_name=logger_name)
+
+        def create(
+            self, name: str, type: str, *, description: str | None = None, attributes: dict[str, str] | None = None
+        ) -> PangeaResponse[m.GroupInfo]:
+            """
+            Create a new group
+
+            Create a new group
+
+            OperationId: authn_post_v2_group_create
+            """
+            return self.request.post(
+                "v2/group/create",
+                data={"name": name, "type": type, "description": description, "attributes": attributes},
+                result_class=m.GroupInfo,
+            )
+
+        def delete(self, id: str) -> PangeaResponse[PangeaResponseResult]:
+            """
+            Delete a group
+
+            Delete a group
+
+            OperationId: authn_post_v2_group_delete
+            """
+            return self.request.post("v2/group/delete", data={"id": id}, result_class=PangeaResponseResult)
+
+        def get(self, id: str) -> PangeaResponse[m.GroupInfo]:
+            """
+            Get group information
+
+            Look up a group by ID and return its information.
+
+            OperationId: authn_post_v2_group_get
+            """
+            return self.request.post("v2/group/get", data={"id": id}, result_class=m.GroupInfo)
+
+        def list(
+            self,
+            *,
+            filter: m.GroupsFilter | None = None,
+            last: str | None = None,
+            order: Literal["asc", "desc"] | None = None,
+            order_by: Literal["id", "created_at", "updated_at", "name", "type"] | None = None,
+            size: int | None = None,
+        ) -> PangeaResponse[m.GroupList]:
+            """
+            List groups
+
+            Look up groups by name, type, or attributes.
+            """
+            return self.request.post(
+                "v2/group/list",
+                data={"filter": filter, "last": last, "order": order, "order_by": order_by, "size": size},
+                result_class=m.GroupList,
+            )
+
+        def list_users(
+            self, id: str, *, last: str | None = None, size: int | None = None
+        ) -> PangeaResponse[m.GroupUserList]:
+            """
+            List of users assigned to a group
+
+            Return a list of ids for users assigned to a group
+
+            OperationId: authn_post_v2_group_user_list
+            """
+            return self.request.post(
+                "v2/group/user/list",
+                data={"id": id, "last": last, "size": size},
+                result_class=m.GroupUserList,
+            )
+
+        def update(
+            self,
+            id: str,
+            *,
+            name: str | None = None,
+            description: str | None = None,
+            type: str | None = None,
+            attributes: dict[str, str] | None = None,
+        ) -> PangeaResponse[m.GroupInfo]:
+            """
+            Update group information
+
+            Update group information
+
+            OperationId: authn_post_v2_group_update
+            """
+            return self.request.post(
+                "v2/group/update",
+                data={"id": id, "name": name, "description": description, "type": type, "attributes": attributes},
+                result_class=m.GroupInfo,
+            )

pangea/services/authn/models.py

@@ -939,3 +939,97 @@ class AgreementUpdateRequest(APIRequestModel):
 
 class AgreementUpdateResult(AgreementInfo):
     pass
+
+
+class GroupInfo(PangeaResponseResult):
+    """A group and its information"""
+
+    id: str
+    name: str
+    type: str
+
+    description: Optional[str] = None
+    attributes: Optional[Dict[str, str]] = None
+    created_at: Optional[str] = None
+    updated_at: Optional[str] = None
+
+
+class GroupsFilter(APIRequestModel):
+    """Search filter for groups"""
+
+    created_at: Optional[str] = None
+    """Only records where created_at equals this value."""
+
+    created_at__gt: Optional[str] = None
+    """Only records where created_at is greater than this value."""
+
+    created_at__gte: Optional[str] = None
+    """Only records where created_at is greater than or equal to this value."""
+
+    created_at__lt: Optional[str] = None
+    """Only records where created_at is less than this value."""
+
+    created_at__lte: Optional[str] = None
+    """Only records where created_at is less than or equal to this value."""
+
+    created_at__contains: Optional[str] = None
+    """Only records where created_at includes this value."""
+
+    id: Optional[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
+    """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."""
+
+    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[str] = None
+    """Only records where updated_at equals this value."""
+
+    updated_at__gt: Optional[str] = None
+    """Only records where updated_at is greater than this value."""
+
+    updated_at__gte: Optional[str] = None
+    """Only records where updated_at is greater than or equal to this value."""
+
+    updated_at__lt: Optional[str] = None
+    """Only records where updated_at is less than this value."""
+
+    updated_at__lte: Optional[str] = None
+    """Only records where updated_at is less than or equal to this value."""
+
+    updated_at__contains: Optional[str] = None
+    """Only records where updated_at includes this value."""
+
+
+class GroupList(PangeaResponseResult):
+    groups: List[GroupInfo]
+    """List of matching groups"""
+
+    count: int
+    last: Optional[str] = None
+
+
+class GroupUserList(PangeaResponseResult):
+    users: List[User]
+    count: int
+    last: Optional[str] = None