authentik-client 2025.10.3__py3-none-any.whl → 2025.12.0rc1__py3-none-any.whl

authentik_client/models/endpoint_stage.py

@@ -0,0 +1,134 @@
+# coding: utf-8
+
+"""
+    authentik
+
+    Making authentication simple.
+
+    The version of the OpenAPI document: 2025.12.0-rc1
+    Contact: hello@goauthentik.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from uuid import UUID
+from authentik_client.models.connector import Connector
+from authentik_client.models.flow_set import FlowSet
+from authentik_client.models.stage_mode_enum import StageModeEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EndpointStage(BaseModel):
+    """
+    EndpointStage Serializer
+    """ # noqa: E501
+    pk: UUID
+    name: StrictStr
+    component: StrictStr = Field(description="Get object type so that we know how to edit the object")
+    verbose_name: StrictStr = Field(description="Return object's verbose_name")
+    verbose_name_plural: StrictStr = Field(description="Return object's plural verbose_name")
+    meta_model_name: StrictStr = Field(description="Return internal model name")
+    flow_set: List[FlowSet]
+    connector: UUID
+    connector_obj: Connector
+    mode: Optional[StageModeEnum] = None
+    __properties: ClassVar[List[str]] = ["pk", "name", "component", "verbose_name", "verbose_name_plural", "meta_model_name", "flow_set", "connector", "connector_obj", "mode"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EndpointStage from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "pk",
+            "component",
+            "verbose_name",
+            "verbose_name_plural",
+            "meta_model_name",
+            "flow_set",
+            "connector_obj",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in flow_set (list)
+        _items = []
+        if self.flow_set:
+            for _item_flow_set in self.flow_set:
+                if _item_flow_set:
+                    _items.append(_item_flow_set.to_dict())
+            _dict['flow_set'] = _items
+        # override the default output from pydantic by calling `to_dict()` of connector_obj
+        if self.connector_obj:
+            _dict['connector_obj'] = self.connector_obj.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EndpointStage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "pk": obj.get("pk"),
+            "name": obj.get("name"),
+            "component": obj.get("component"),
+            "verbose_name": obj.get("verbose_name"),
+            "verbose_name_plural": obj.get("verbose_name_plural"),
+            "meta_model_name": obj.get("meta_model_name"),
+            "flow_set": [FlowSet.from_dict(_item) for _item in obj["flow_set"]] if obj.get("flow_set") is not None else None,
+            "connector": obj.get("connector"),
+            "connector_obj": Connector.from_dict(obj["connector_obj"]) if obj.get("connector_obj") is not None else None,
+            "mode": obj.get("mode")
+        })
+        return _obj
+
+

authentik_client/models/endpoint_stage_request.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    authentik
+
+    Making authentication simple.
+
+    The version of the OpenAPI document: 2025.12.0-rc1
+    Contact: hello@goauthentik.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from authentik_client.models.stage_mode_enum import StageModeEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EndpointStageRequest(BaseModel):
+    """
+    EndpointStage Serializer
+    """ # noqa: E501
+    name: Annotated[str, Field(min_length=1, strict=True)]
+    connector: UUID
+    mode: Optional[StageModeEnum] = None
+    __properties: ClassVar[List[str]] = ["name", "connector", "mode"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EndpointStageRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EndpointStageRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "connector": obj.get("connector"),
+            "mode": obj.get("mode")
+        })
+        return _obj
+
+

authentik_client/models/{extra_user_object_permission_request.py → enroll_request.py}

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -24,12 +24,13 @@ from typing_extensions import Annotated
 from typing import Optional, Set
 from typing_extensions import Self
 
-class ExtraUserObjectPermissionRequest(BaseModel):
+class EnrollRequest(BaseModel):
     """
-    User permission with additional object-related data
+    Base serializer class which doesn't implement create/update methods
     """ # noqa: E501
-    object_pk: Annotated[str, Field(min_length=1, strict=True)]
-    __properties: ClassVar[List[str]] = ["object_pk"]
+    device_serial: Annotated[str, Field(min_length=1, strict=True)]
+    device_name: Annotated[str, Field(min_length=1, strict=True)]
+    __properties: ClassVar[List[str]] = ["device_serial", "device_name"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -49,7 +50,7 @@ class ExtraUserObjectPermissionRequest(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of ExtraUserObjectPermissionRequest from a JSON string"""
+        """Create an instance of EnrollRequest from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -74,7 +75,7 @@ class ExtraUserObjectPermissionRequest(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of ExtraUserObjectPermissionRequest from a dict"""
+        """Create an instance of EnrollRequest from a dict"""
         if obj is None:
             return None
 
@@ -82,7 +83,8 @@ class ExtraUserObjectPermissionRequest(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "object_pk": obj.get("object_pk")
+            "device_serial": obj.get("device_serial"),
+            "device_name": obj.get("device_name")
         })
         return _obj
 

authentik_client/models/enrollment_token.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+"""
+    authentik
+
+    Making authentication simple.
+
+    The version of the OpenAPI document: 2025.12.0-rc1
+    Contact: hello@goauthentik.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from uuid import UUID
+from authentik_client.models.device_access_group import DeviceAccessGroup
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EnrollmentToken(BaseModel):
+    """
+    EnrollmentToken
+    """ # noqa: E501
+    token_uuid: UUID
+    device_group: Optional[UUID] = None
+    device_group_obj: DeviceAccessGroup
+    connector: UUID
+    name: StrictStr
+    expiring: Optional[StrictBool] = None
+    expires: Optional[datetime] = None
+    __properties: ClassVar[List[str]] = ["token_uuid", "device_group", "device_group_obj", "connector", "name", "expiring", "expires"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EnrollmentToken from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "token_uuid",
+            "device_group_obj",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of device_group_obj
+        if self.device_group_obj:
+            _dict['device_group_obj'] = self.device_group_obj.to_dict()
+        # set to None if device_group (nullable) is None
+        # and model_fields_set contains the field
+        if self.device_group is None and "device_group" in self.model_fields_set:
+            _dict['device_group'] = None
+
+        # set to None if expires (nullable) is None
+        # and model_fields_set contains the field
+        if self.expires is None and "expires" in self.model_fields_set:
+            _dict['expires'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EnrollmentToken from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "token_uuid": obj.get("token_uuid"),
+            "device_group": obj.get("device_group"),
+            "device_group_obj": DeviceAccessGroup.from_dict(obj["device_group_obj"]) if obj.get("device_group_obj") is not None else None,
+            "connector": obj.get("connector"),
+            "name": obj.get("name"),
+            "expiring": obj.get("expiring"),
+            "expires": obj.get("expires")
+        })
+        return _obj
+
+

authentik_client/models/enrollment_token_request.py

@@ -0,0 +1,109 @@
+# coding: utf-8
+
+"""
+    authentik
+
+    Making authentication simple.
+
+    The version of the OpenAPI document: 2025.12.0-rc1
+    Contact: hello@goauthentik.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EnrollmentTokenRequest(BaseModel):
+    """
+    EnrollmentTokenRequest
+    """ # noqa: E501
+    device_group: Optional[UUID] = None
+    connector: UUID
+    name: Annotated[str, Field(min_length=1, strict=True)]
+    expiring: Optional[StrictBool] = None
+    expires: Optional[datetime] = None
+    __properties: ClassVar[List[str]] = ["device_group", "connector", "name", "expiring", "expires"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EnrollmentTokenRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if device_group (nullable) is None
+        # and model_fields_set contains the field
+        if self.device_group is None and "device_group" in self.model_fields_set:
+            _dict['device_group'] = None
+
+        # set to None if expires (nullable) is None
+        # and model_fields_set contains the field
+        if self.expires is None and "expires" in self.model_fields_set:
+            _dict['expires'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EnrollmentTokenRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "device_group": obj.get("device_group"),
+            "connector": obj.get("connector"),
+            "name": obj.get("name"),
+            "expiring": obj.get("expiring"),
+            "expires": obj.get("expires")
+        })
+        return _obj
+
+

authentik_client/models/error_detail.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/error_reporting_config.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/event.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/event_actions.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -53,6 +53,7 @@ class EventActions(str, Enum):
     MODEL_DELETED = 'model_deleted'
     EMAIL_SENT = 'email_sent'
     UPDATE_AVAILABLE = 'update_available'
+    EXPORT_READY = 'export_ready'
     CUSTOM = 'custom_'
 
     @classmethod

authentik_client/models/event_matcher_policy.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/event_matcher_policy_request.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/event_request.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/event_top_per_user.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/event_volume.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/events_requested_enum.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/expiring_base_grant_model.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/expression_policy.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/expression_policy_request.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

authentik_client/models/extra_role_object_permission.py

@@ -5,7 +5,7 @@
 
     Making authentication simple.
 
-    The version of the OpenAPI document: 2025.10.3
+    The version of the OpenAPI document: 2025.12.0-rc1
     Contact: hello@goauthentik.io
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -25,7 +25,7 @@ from typing_extensions import Self
 
 class ExtraRoleObjectPermission(BaseModel):
     """
-    User permission with additional object-related data
+    Role permission with additional object-related data
     """ # noqa: E501
     id: StrictInt
     codename: StrictStr
@@ -35,7 +35,7 @@ class ExtraRoleObjectPermission(BaseModel):
     name: StrictStr
     app_label_verbose: StrictStr = Field(description="Get app label from permission's model")
     model_verbose: StrictStr = Field(description="Get model label from permission's model")
-    object_description: Optional[StrictStr] = Field(description="Get model description from attached model. This operation takes at least one additional query, and the description is only shown if the user/role has the view_ permission on the object")
+    object_description: Optional[StrictStr] = Field(description="Get model description from attached model. This operation takes at least one additional query, and the description is only shown if the role has the view_ permission on the object")
     __properties: ClassVar[List[str]] = ["id", "codename", "model", "app_label", "object_pk", "name", "app_label_verbose", "model_verbose", "object_description"]
 
     model_config = ConfigDict(