illumio-py-open 1.2.0__tar.gz

illumio_py_open-1.2.0/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

illumio_py_open-1.2.0/MANIFEST.in

@@ -0,0 +1,18 @@
+# Keep LICENSE / NOTICE / README in the sdist.
+include LICENSE NOTICE README.md
+include illumio/py.typed
+
+# Exclude repo/dev/reference material from the distribution.
+# (setuptools_scm otherwise includes every git-tracked file in the sdist.)
+exclude .gitignore .coveragerc .readthedocs.yaml tox.ini Makefile CHANGELOG.rst UPDATE_REPORT.md CLAUDE.md
+prune .github
+prune tasks
+prune docs
+prune tests
+prune tools
+
+# Illumio API reference material — never shipped
+prune webservices-v2-experimental-26.3.0
+exclude illumio-v2-openapi-experimental-25.2.10.json
+exclude illumio-core-26.3-openapi.json
+recursive-exclude . *.schema.json

illumio_py_open-1.2.0/NOTICE

@@ -0,0 +1,9 @@
+illumio-py
+Copyright 2022 Illumio
+
+This product includes software developed at Illumio (https://www.illumio.com/).
+
+illumio-py-open is a community-maintained fork of illumio/illumio-py
+(https://github.com/illumio/illumio-py), modified to track current Illumio Core
+REST APIs. Changes are made under the terms of the Apache License 2.0. This fork
+is not an official Illumio product and is not endorsed by Illumio.

illumio_py_open-1.2.0/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: illumio-py-open
+Version: 1.2.0
+Summary: Community-maintained REST API client for the Illumio Core Policy Compute Engine (fork of illumio/illumio-py)
+Home-page: https://github.com/alexgoller/illumio-py
+Author: Illumio
+Author-email: app-integrations@illumio.com
+Maintainer: Alex Goller
+Maintainer-email: alex@ryte.de
+Project-URL: Source, https://github.com/alexgoller/illumio-py
+Project-URL: Upstream, https://github.com/illumio/illumio-py
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.26.0
+Requires-Dist: dataclasses>=0.8; python_version == "3.6"
+Dynamic: license-file
+
+# illumio-py-open
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg?color=orange)](https://opensource.org/licenses/Apache-2.0)
+
+> **Community fork.** `illumio-py-open` is a community-maintained fork of
+> [illumio/illumio-py](https://github.com/illumio/illumio-py), updated to track current
+> Illumio Core REST APIs. It is **not an official Illumio product and is not endorsed by
+> Illumio.** It is distributed under the Apache License 2.0 (see [NOTICE](NOTICE) and
+> [LICENSE](LICENSE)). The import package is still `illumio`, so existing code keeps working:
+> `from illumio import PolicyComputeEngine`.
+
+Illumio Policy Compute Engine REST client for python 3. Provides full API coverage of the Illumio PCE REST API with 56 registered CRUD endpoints and 67 custom methods for specialized operations.
+
+Covers security policy, workloads, VENs, infrastructure, access management, authentication, reporting, settings, label mapping, vulnerability management, and traffic analysis.
+
+Compatible with Illumio Core PCE version 21.2+.
+
+The main entrypoint for the client is the `PolicyComputeEngine` class:  
+
+```python
+>>> from illumio import PolicyComputeEngine
+>>> pce = PolicyComputeEngine('pce.company.com', port='8443', org_id='12')
+>>> pce.set_credentials('api_key', 'api_secret')
+>>> workloads = pce.workloads.get(
+...     params={
+...         'managed': True,
+...         'enforcement_mode': 'visibility_only'
+...     }
+... )
+>>> workloads
+[
+    Workload(href='/orgs/12/workloads/c754a713-2bde-4427-af1f-bff145be509b', ...),
+    ...
+]
+```
+
+For more information on the Illumio APIs, see the [REST API guide](https://docs.illumio.com/core/21.5/Content/LandingPages/Guides/rest-api.htm) and the [API reference](https://docs.illumio.com/core/21.5/API-Reference/index.html) for your version of Illumio Core.  
+
+## [Read the Docs](https://illumio-py.readthedocs.io/en/latest/)
+
+You can find API documentation, code examples, and usage guides on our [readthedocs page](https://illumio-py.readthedocs.io/en/latest/)!
+
+## Installation  
+
+Once published, the fork will be available on PyPI as `illumio-py-open` (the import name
+remains `illumio`):
+
+```sh
+$ python -m pip install illumio-py-open
+```
+
+To build and install from source  
+
+```sh
+$ git clone git@github.com:alexgoller/illumio-py.git
+$ cd illumio-py
+$ make
+```
+
+## Support  
+
+The `illumio` package is released and distributed as open source software subject to the included [LICENSE](https://github.com/illumio/illumio-py/blob/main/LICENSE). Illumio has no obligation or responsibility related to the package with respect to support, maintenance, availability, security or otherwise. Please read the entire [LICENSE](https://github.com/illumio/illumio-py/blob/main/LICENSE) for additional information regarding the permissions and limitations. Support is offered on a best-effort basis through the [Illumio app integrations team](mailto:app-integrations@illumio.com) and project contributors.  
+
+## Contributing  
+
+See the project's [CONTRIBUTING](https://github.com/illumio/illumio-py/blob/main/.github/CONTRIBUTING.md) document for details.  
+
+## License  
+
+Copyright 2022 Illumio  
+
+```
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```

illumio_py_open-1.2.0/README.md

@@ -0,0 +1,84 @@
+# illumio-py-open
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg?color=orange)](https://opensource.org/licenses/Apache-2.0)
+
+> **Community fork.** `illumio-py-open` is a community-maintained fork of
+> [illumio/illumio-py](https://github.com/illumio/illumio-py), updated to track current
+> Illumio Core REST APIs. It is **not an official Illumio product and is not endorsed by
+> Illumio.** It is distributed under the Apache License 2.0 (see [NOTICE](NOTICE) and
+> [LICENSE](LICENSE)). The import package is still `illumio`, so existing code keeps working:
+> `from illumio import PolicyComputeEngine`.
+
+Illumio Policy Compute Engine REST client for python 3. Provides full API coverage of the Illumio PCE REST API with 56 registered CRUD endpoints and 67 custom methods for specialized operations.
+
+Covers security policy, workloads, VENs, infrastructure, access management, authentication, reporting, settings, label mapping, vulnerability management, and traffic analysis.
+
+Compatible with Illumio Core PCE version 21.2+.
+
+The main entrypoint for the client is the `PolicyComputeEngine` class:  
+
+```python
+>>> from illumio import PolicyComputeEngine
+>>> pce = PolicyComputeEngine('pce.company.com', port='8443', org_id='12')
+>>> pce.set_credentials('api_key', 'api_secret')
+>>> workloads = pce.workloads.get(
+...     params={
+...         'managed': True,
+...         'enforcement_mode': 'visibility_only'
+...     }
+... )
+>>> workloads
+[
+    Workload(href='/orgs/12/workloads/c754a713-2bde-4427-af1f-bff145be509b', ...),
+    ...
+]
+```
+
+For more information on the Illumio APIs, see the [REST API guide](https://docs.illumio.com/core/21.5/Content/LandingPages/Guides/rest-api.htm) and the [API reference](https://docs.illumio.com/core/21.5/API-Reference/index.html) for your version of Illumio Core.  
+
+## [Read the Docs](https://illumio-py.readthedocs.io/en/latest/)
+
+You can find API documentation, code examples, and usage guides on our [readthedocs page](https://illumio-py.readthedocs.io/en/latest/)!
+
+## Installation  
+
+Once published, the fork will be available on PyPI as `illumio-py-open` (the import name
+remains `illumio`):
+
+```sh
+$ python -m pip install illumio-py-open
+```
+
+To build and install from source  
+
+```sh
+$ git clone git@github.com:alexgoller/illumio-py.git
+$ cd illumio-py
+$ make
+```
+
+## Support  
+
+The `illumio` package is released and distributed as open source software subject to the included [LICENSE](https://github.com/illumio/illumio-py/blob/main/LICENSE). Illumio has no obligation or responsibility related to the package with respect to support, maintenance, availability, security or otherwise. Please read the entire [LICENSE](https://github.com/illumio/illumio-py/blob/main/LICENSE) for additional information regarding the permissions and limitations. Support is offered on a best-effort basis through the [Illumio app integrations team](mailto:app-integrations@illumio.com) and project contributors.  
+
+## Contributing  
+
+See the project's [CONTRIBUTING](https://github.com/illumio/illumio-py/blob/main/.github/CONTRIBUTING.md) document for details.  
+
+## License  
+
+Copyright 2022 Illumio  
+
+```
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```

illumio_py_open-1.2.0/illumio/__init__.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+"""The illumio library provides a simple interface for interacting with PCE APIs.
+
+Copyright:
+    © 2022 Illumio
+
+License:
+    Apache2, see LICENSE for more details.
+"""
+from .events import *
+from .exceptions import *
+from .secpolicy import *
+from .util import *
+from .accessmanagement import *
+from .authentication import *
+from .policyobjects import *
+from .infrastructure import *
+from .vulnerabilities import *
+from .workloads import *
+from .rules import *
+from .explorer import *
+from .reporting import *
+from .settings import *
+from .labelmapping import *
+from .pce import *
+from .appgroups import *
+
+from types import ModuleType
+
+# avoid name conflicts with package modules when using
+# `from illumio import *` by excluding them here
+__all__ = [
+    export for export, o in globals().items()
+        if not (export.startswith('_') or isinstance(o, ModuleType))
+]

illumio_py_open-1.2.0/illumio/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '1.2.0'
+__version_tuple__ = version_tuple = (1, 2, 0)
+
+__commit_id__ = commit_id = 'g73b4e85ec'

illumio_py_open-1.2.0/illumio/accessmanagement/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+"""This module provides classes related to users, RBAC, and IAM.
+
+Copyright:
+    © 2022 Illumio
+
+License:
+    Apache2, see LICENSE for more details.
+"""
+from .user import *
+from .accessrestriction import *
+from .authsecurityprincipal import *
+from .permission import *
+from .role import *
+from .serviceaccount import *

illumio_py_open-1.2.0/illumio/accessmanagement/accessrestriction.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+
+"""This module provides classes related to access restrictions.
+
+Copyright:
+    © 2022 Illumio
+
+License:
+    Apache2, see LICENSE for more details.
+"""
+from dataclasses import dataclass
+from typing import List
+
+from illumio.util import Reference, MutableObject, pce_api
+
+
+@dataclass
+@pce_api('access_restrictions')
+class AccessRestriction(MutableObject):
+    """Represents an access restriction in the PCE.
+
+    Access restrictions limit what IP ranges can access the PCE management API.
+    """
+    ips: List[str] = None
+    type: str = None
+
+
+__all__ = [
+    'AccessRestriction',
+]

illumio_py_open-1.2.0/illumio/accessmanagement/authsecurityprincipal.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+
+"""This module provides classes related to auth security principals.
+
+Copyright:
+    © 2022 Illumio
+
+License:
+    Apache2, see LICENSE for more details.
+"""
+from dataclasses import dataclass
+from typing import List
+
+from illumio.util import Reference, MutableObject, pce_api
+
+
+@dataclass
+@pce_api('auth_security_principals')
+class AuthSecurityPrincipal(MutableObject):
+    """Represents an auth security principal in the PCE.
+
+    Auth security principals map external identity provider groups
+    to PCE permissions.
+    """
+    display_name: str = None
+    sid: str = None
+    type: str = None
+
+
+__all__ = [
+    'AuthSecurityPrincipal',
+]

illumio_py_open-1.2.0/illumio/accessmanagement/permission.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+
+"""This module provides classes related to RBAC permissions.
+
+Copyright:
+    © 2022 Illumio
+
+License:
+    Apache2, see LICENSE for more details.
+"""
+from dataclasses import dataclass
+from typing import List
+
+from illumio.util import Reference, MutableObject, pce_api
+
+
+@dataclass
+@pce_api('permissions')
+class Permission(MutableObject):
+    """Represents an RBAC permission in the PCE.
+
+    Permissions define access control bindings between auth security principals,
+    roles, and scopes.
+    """
+    role: Reference = None
+    scope: List[Reference] = None
+    auth_security_principal: Reference = None
+
+
+__all__ = [
+    'Permission',
+]

illumio_py_open-1.2.0/illumio/accessmanagement/role.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+
+"""This module provides classes related to RBAC roles.
+
+Copyright:
+    © 2022 Illumio
+
+License:
+    Apache2, see LICENSE for more details.
+"""
+from dataclasses import dataclass
+from typing import List
+
+from illumio.util import Reference, JsonObject, pce_api
+
+
+@dataclass
+@pce_api('roles')
+class Role(Reference):
+    """Represents a role in the PCE.
+
+    Roles are read-only and define sets of capabilities.
+    """
+    display_name: str = None
+    access_level: str = None
+
+
+__all__ = [
+    'Role',
+]

illumio_py_open-1.2.0/illumio/accessmanagement/serviceaccount.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+
+"""This module provides classes related to service accounts.
+
+Copyright:
+    © 2022 Illumio
+
+License:
+    Apache2, see LICENSE for more details.
+"""
+from dataclasses import dataclass
+from typing import List
+
+from illumio.util import Reference, MutableObject, pce_api
+
+
+@dataclass
+@pce_api('service_accounts')
+class ServiceAccount(MutableObject):
+    """Represents a service account in the PCE.
+
+    Service accounts provide API access credentials for automated systems.
+    """
+    permissions: List[Reference] = None
+    api_key_id: str = None
+    api_key_secret: str = None
+    last_login: str = None
+
+
+__all__ = [
+    'ServiceAccount',
+]

illumio_py_open-1.2.0/illumio/accessmanagement/user.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+"""This module provides classes related to RBAC users in the PCE.
+
+Copyright:
+    © 2022 Illumio
+
+License:
+    Apache2, see LICENSE for more details.
+"""
+from dataclasses import dataclass
+from typing import List
+
+from illumio.util import IllumioObject, pce_api
+
+
+@dataclass
+@pce_api('users', is_global=True)
+class User(IllumioObject):
+    """Represents a user object in the PCE."""
+    username: str = None
+    last_login_on: str = None
+    last_login_ip_address: str = None
+    login_count: int = None
+    full_name: str = None
+    time_zone: str = None
+    locked: bool = None
+    effective_groups: List[str] = None
+    local_profile: dict = None
+    type: str = None
+    presence_status: str = None
+
+
+__all__ = [
+    'User',
+]