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

pangea/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "6.0.0"
+__version__ = "6.1.1"
 
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.config import PangeaConfig

pangea/asyncio/request.py

@@ -61,7 +61,7 @@ class PangeaRequestAsync(PangeaRequestBase):
             data = {}
 
         # Normalize.
-        data = cast(dict[str, Any], to_jsonable_python(data))
+        data = cast(dict[str, Any], to_jsonable_python(data, exclude_none=True))
 
         if url is None:
             url = self._url(endpoint)

pangea/asyncio/services/audit.py

@@ -135,7 +135,7 @@ class AuditAsync(ServiceBaseAsync, AuditBase):
             A PangeaResponse where the hash of event data and optional verbose
                 results are returned in the response.result field.
                 Available response fields can be found in our
-                [API documentation](https://pangea.cloud/docs/api/audit#log-an-entry).
+                [API documentation](https://pangea.cloud/docs/api/audit#/v1/log-post).
 
         Examples:
             try:
@@ -186,7 +186,7 @@ class AuditAsync(ServiceBaseAsync, AuditBase):
         Returns:
             A PangeaResponse where the hash of event data and optional verbose
                 results are returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#log-an-entry).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v1/log-post).
 
         Examples:
             response = await audit.log_event({"message": "hello world"}, verbose=True)
@@ -222,7 +222,7 @@ class AuditAsync(ServiceBaseAsync, AuditBase):
         Returns:
             A PangeaResponse where the hash of event data and optional verbose
                 results are returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#log-an-entry).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v1/log-post).
 
         Examples:
             FIXME:
@@ -259,7 +259,7 @@ class AuditAsync(ServiceBaseAsync, AuditBase):
         Returns:
             A PangeaResponse where the hash of event data and optional verbose
                 results are returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#log-an-entry).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v1/log-post).
 
         Examples:
             FIXME:
@@ -328,8 +328,8 @@ class AuditAsync(ServiceBaseAsync, AuditBase):
 
         Returns:
             A PangeaResponse[SearchOutput] where the first page of matched events is returned in the
-                response.result field. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#search-for-events).
-                Pagination can be found in the [search results endpoint](https://pangea.cloud/docs/api/audit#search-results).
+                response.result field. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/audit#/v1/results-post).
+                Pagination can be found in the [search results endpoint](https://pangea.cloud/docs/api/audit#/v1/download_results-post).
 
         Examples:
             response: PangeaResponse[SearchOutput] = audit.search(query="message:test", search_restriction={'source': ["monitor"]}, limit=1, verify_consistency=True, verify_events=True)

pangea/asyncio/services/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.asyncio.services.base import ServiceBaseAsync
 from pangea.config import PangeaConfig
 from pangea.response import PangeaResponse, PangeaResponseResult
 
-SERVICE_NAME = "authn"
+__all__ = ["AuthNAsync"]
+
+
+_SERVICE_NAME = "authn"
 
 
 class AuthNAsync(ServiceBaseAsync):
@@ -35,7 +38,7 @@ class AuthNAsync(ServiceBaseAsync):
         authn = AuthNAsync(token=PANGEA_TOKEN, config=authn_config)
     """
 
-    service_name = SERVICE_NAME
+    service_name = _SERVICE_NAME
 
     def __init__(
         self,
@@ -65,7 +68,7 @@ class AuthNAsync(ServiceBaseAsync):
         self.agreements = AuthNAsync.AgreementsAsync(token, config, logger_name=logger_name)
 
     class SessionAsync(ServiceBaseAsync):
-        service_name = SERVICE_NAME
+        service_name = _SERVICE_NAME
 
         def __init__(
             self,
@@ -124,7 +127,7 @@ class AuthNAsync(ServiceBaseAsync):
             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()
@@ -162,7 +165,7 @@ class AuthNAsync(ServiceBaseAsync):
             )
 
     class ClientAsync(ServiceBaseAsync):
-        service_name = SERVICE_NAME
+        service_name = _SERVICE_NAME
 
         def __init__(
             self,
@@ -189,7 +192,7 @@ class AuthNAsync(ServiceBaseAsync):
             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(
@@ -214,7 +217,7 @@ class AuthNAsync(ServiceBaseAsync):
             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()
@@ -222,7 +225,7 @@ class AuthNAsync(ServiceBaseAsync):
             return await self.request.post("v2/client/jwks", m.ClientJWKSResult, {})
 
         class SessionAsync(ServiceBaseAsync):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -287,7 +290,7 @@ class AuthNAsync(ServiceBaseAsync):
                 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 +348,7 @@ class AuthNAsync(ServiceBaseAsync):
                 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 +362,7 @@ class AuthNAsync(ServiceBaseAsync):
                 )
 
         class PasswordAsync(ServiceBaseAsync):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -419,7 +422,7 @@ class AuthNAsync(ServiceBaseAsync):
                 return await self.request.post("v2/user/password/expire", PangeaResponseResult, {"id": user_id})
 
         class TokenAsync(ServiceBaseAsync):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -443,7 +446,7 @@ class AuthNAsync(ServiceBaseAsync):
                 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,7 +459,7 @@ class AuthNAsync(ServiceBaseAsync):
                 )
 
     class UserAsync(ServiceBaseAsync):
-        service_name = SERVICE_NAME
+        service_name = _SERVICE_NAME
 
         def __init__(
             self,
@@ -491,7 +494,7 @@ class AuthNAsync(ServiceBaseAsync):
             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(
@@ -560,7 +563,7 @@ class AuthNAsync(ServiceBaseAsync):
             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(
@@ -605,7 +608,7 @@ class AuthNAsync(ServiceBaseAsync):
             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(
@@ -649,7 +652,7 @@ class AuthNAsync(ServiceBaseAsync):
             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()
@@ -667,7 +670,7 @@ class AuthNAsync(ServiceBaseAsync):
             return await self.request.post("v2/user/list", m.UserListResult, data=input.model_dump(exclude_none=True))
 
         class InvitesAsync(ServiceBaseAsync):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -702,7 +705,7 @@ class AuthNAsync(ServiceBaseAsync):
                 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()
                 """
@@ -739,7 +742,7 @@ class AuthNAsync(ServiceBaseAsync):
                 )
 
         class AuthenticatorsAsync(ServiceBaseAsync):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -806,7 +809,7 @@ class AuthNAsync(ServiceBaseAsync):
                 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(
@@ -821,7 +824,7 @@ class AuthNAsync(ServiceBaseAsync):
                 )
 
         class ProfileAsync(ServiceBaseAsync):
-            service_name = SERVICE_NAME
+            service_name = _SERVICE_NAME
 
             def __init__(
                 self,
@@ -849,7 +852,7 @@ class AuthNAsync(ServiceBaseAsync):
                 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(
@@ -885,7 +888,7 @@ class AuthNAsync(ServiceBaseAsync):
                 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(
@@ -905,8 +908,57 @@ class AuthNAsync(ServiceBaseAsync):
                     "v2/user/profile/update", m.UserProfileUpdateResult, data=input.model_dump(exclude_none=True)
                 )
 
+        class GroupAsync(ServiceBaseAsync):
+            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)
+
+            async 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 await self.request.post(
+                    "v2/user/group/assign",
+                    data={"id": user_id, "group_ids": group_ids},
+                    result_class=m.PangeaResponseResult,
+                )
+
+            async 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 await self.request.post(
+                    "v2/user/group/remove",
+                    data={"id": user_id, "group_id": group_id},
+                    result_class=m.PangeaResponseResult,
+                )
+
+            async 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 await self.request.post("v2/user/group/list", data={"id": user_id}, result_class=m.GroupList)
+
     class FlowAsync(ServiceBaseAsync):
-        service_name = SERVICE_NAME
+        service_name = _SERVICE_NAME
 
         def __init__(
             self,
@@ -930,7 +982,7 @@ class AuthNAsync(ServiceBaseAsync):
             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(
@@ -961,7 +1013,7 @@ class AuthNAsync(ServiceBaseAsync):
                 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(
@@ -1000,7 +1052,7 @@ class AuthNAsync(ServiceBaseAsync):
                 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(
@@ -1034,7 +1086,7 @@ class AuthNAsync(ServiceBaseAsync):
                 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(
@@ -1052,7 +1104,7 @@ class AuthNAsync(ServiceBaseAsync):
             )
 
     class AgreementsAsync(ServiceBaseAsync):
-        service_name = SERVICE_NAME
+        service_name = _SERVICE_NAME
 
         def __init__(
             self,
@@ -1081,7 +1133,7 @@ class AuthNAsync(ServiceBaseAsync):
             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(
@@ -1148,7 +1200,7 @@ class AuthNAsync(ServiceBaseAsync):
             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()
@@ -1186,7 +1238,7 @@ class AuthNAsync(ServiceBaseAsync):
             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(
@@ -1201,3 +1253,108 @@ class AuthNAsync(ServiceBaseAsync):
             return await self.request.post(
                 "v2/agreements/update", m.AgreementUpdateResult, data=input.model_dump(exclude_none=True)
             )
+
+    class GroupAsync(ServiceBaseAsync):
+        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)
+
+        async 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 await self.request.post(
+                "v2/group/create",
+                data={"name": name, "type": type, "description": description, "attributes": attributes},
+                result_class=m.GroupInfo,
+            )
+
+        async def delete(self, id: str) -> PangeaResponse[PangeaResponseResult]:
+            """
+            Delete a group
+
+            Delete a group
+
+            OperationId: authn_post_v2_group_delete
+            """
+            return await self.request.post("v2/group/delete", data={"id": id}, result_class=PangeaResponseResult)
+
+        async 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 await self.request.post("v2/group/get", data={"id": id}, result_class=m.GroupInfo)
+
+        async 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 await self.request.post(
+                "v2/group/list",
+                data={"filter": filter, "last": last, "order": order, "order_by": order_by, "size": size},
+                result_class=m.GroupList,
+            )
+
+        async 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 await self.request.post(
+                "v2/group/user/list",
+                data={"id": id, "last": last, "size": size},
+                result_class=m.GroupUserList,
+            )
+
+        async 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 await self.request.post(
+                "v2/group/update",
+                data={"id": id, "name": name, "description": description, "type": type, "attributes": attributes},
+                result_class=m.GroupInfo,
+            )