{ "info": { "author": "Nicolas Liampotis", "author_email": "nliam@grnet.gr", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "b2accessdeprovisioning\n======================\n\n.. image:: https://img.shields.io/pypi/v/b2accessdeprovisioning.svg\n :target: https://pypi.python.org/pypi/b2accessdeprovisioning\n\nA Python tool for handling the (de)provisioning of B2ACCESS user accounts.\n\nThe b2accessdeprovisioning tool can be used to retrieve the list of permanently disabled B2ACCESS user accounts via Unity's Administration API. For each of the disabled accounts, the tool performs the following operations:\n\n#. immediate removal of assigned attributes (excluding user identifiers)\n#. scheduled removal of all account information after a given period of time\n\nFinally, the tool sends a notification to one or more recipients containing the list of deprovisioned accounts.\n\nFeatures\n--------\n\n* B2ACCESS integration via Unity's Administration API v1\n* Attribute whitelisting to indicate information that should be saved when removing account data; otherwise the tool removes all attributes assigned to permanently disabled B2ACCESS user accounts\n* Adjustable duration of time for which the records of deprovisioned users should be maintained\n* Email notifications via SMTP containing deprovisioned account information in json format\n\nPython version\n--------------\n\nPython 2.6 or 2.7 are fully supported.\n\nInstallation\n------------\n\nTo install the tool, simply run:\n\n.. code-block:: bash\n\n $ pip install b2accessdeprovisioning\n \ud83c\udf7a\n\nThird party libraries and dependencies\n--------------------------------------\n\nThe following libraries will be installed when you install the client library:\n\n* `PyYAML `_\n* `unityapiclient `_\n* `pytz `_\n* `requests `_\n\nConfiguration\n-------------\nTool settings are adjustable via the ``config.yml`` configuration file.\n\nExample ``config.yml``\n^^^^^^^^^^^^^^^^^^^^^^\n\n.. code-block:: yaml\n\n # B2ACCESS API endpoint connection details\n api:\n base_url: \"https://b2access.eudat.eu:8443\"\n path: \"rest-admin\"\n version: \"v1\"\n user: \"unity_user\"\n password: \"unity_password\"\n cert_verify: True\n\n # List of attributes that should be saved when removing user information.\n # Attributes not listed here will be immediately removed upon user\n # deprovisioning.\n attr_whitelist: []\n\n # Duration of time for which the records of deprovisioned users should be\n # maintained (in days). After that period all information about the\n # deprovisioned users will be permanently removed.\n retention_period: 365\n\n # Notification settings\n notifications:\n email:\n # SMTP host to connect to. Defaults to the local host if empty.\n host: \"smtp.example.eu\"\n # SMTP port to connect to. Defaults to the standard SMTP port (25) if empty.\n port: 587\n # Whether to put the SMTP connection in TLS. Defaults to False.\n use_tls: True\n # Login username/password if the SMTP server requires authentication;\n # otherwise empty.\n user: \"smtp_user\"\n password: \"smtp_password\"\n # Sender address\n from: \"B2ACCESS Notifications \"\n # List of recipient addresses\n to:\n - \"SP1 Operator \"\n - \"SP2 Operator \"\n subject: \"Deprovisioned B2ACCESS accounts\"\n intro_text: \"See attachment for details of deprovisioned B2ACCESS accounts.\\n\\nNote: This is an automated email, please don't reply.\"\n\nSee also ``config.yml.example``.\n\nUsage\n-----\n\nSimply run the ``b2accessdeprovisioning.monitor`` module:\n\n.. code-block:: bash\n\n $ python -m b2accessdeprovisioning.monitor\n\nNote: The tool will look for the ``config.yml`` configuration file in the current directory.\n\nExample notification\n^^^^^^^^^^^^^^^^^^^^\n\nInformation about the deprovisioned user accounts is sent via an email attachment in json format (``users.json``):\n\n.. code-block:: json\n\n [\n {\n \"id\": \"3f3d5b40-26ce-45db-808a-a5ca3a4e7515\"\n },\n {\n \"id\": \"663a5b04-62ec-9d3b-078b-5ac3a4ae5733\"\n }\n ]\n\nDocumentation\n-------------\n\nDocumentation is available at http://eudat-b2access.github.io/b2access-deprovisioning \n\nLicense\n-------\n\nLicensed under the Apache 2.0 license, for details see `LICENSE`.\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/EUDAT-B2ACCESS/b2access-deprovisioning", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://eudat-b2access.github.io/b2access-deprovisioning", "keywords": "B2ACCESS account (de)provisioning tool", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "b2accessdeprovisioning", "package_url": "https://pypi.org/project/b2accessdeprovisioning/", "platform": "", "project_url": "https://pypi.org/project/b2accessdeprovisioning/", "project_urls": { "Download": "https://github.com/EUDAT-B2ACCESS/b2access-deprovisioning", "Homepage": "https://eudat-b2access.github.io/b2access-deprovisioning" }, "release_url": "https://pypi.org/project/b2accessdeprovisioning/0.9.1/", "requires_dist": [ "unityapiclient", "PyYAML" ], "requires_python": ">=2.6,<2.8", "summary": "B2ACCESS account (de)provisioning tool", "version": "0.9.1" }, "last_serial": 3110848, "releases": { "0.9.0": [ { "comment_text": "", "digests": { "md5": "799aefa266a589915b1de88b78bad715", "sha256": "5cdb400e91de0ee30fac42ef054b11eb6e1bd7326f54d9bdfd91f8dbf006fab5" }, "downloads": -1, "filename": "b2accessdeprovisioning-0.9.0-py2-none-any.whl", "has_sig": false, "md5_digest": "799aefa266a589915b1de88b78bad715", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": ">=2.6,<2.8", "size": 9340, "upload_time": "2017-02-25T03:35:13", "url": "https://files.pythonhosted.org/packages/2e/0a/2b055153b0de893415e7ab6ebfb486a7e11b42a16eeb66fe781ec1e5f6cf/b2accessdeprovisioning-0.9.0-py2-none-any.whl" } ], "0.9.1": [ { "comment_text": "", "digests": { "md5": "e0ae2086f12e00988ca4991b506bfe70", "sha256": "884ca7c0f8990c2e58ecd494fd47d6c04927a5be555eafc47fa66b99cd58565c" }, "downloads": -1, "filename": "b2accessdeprovisioning-0.9.1-py2-none-any.whl", "has_sig": false, "md5_digest": "e0ae2086f12e00988ca4991b506bfe70", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": ">=2.6,<2.8", "size": 9539, "upload_time": "2017-08-21T02:53:58", "url": "https://files.pythonhosted.org/packages/8d/9f/ad259afced75ef379bf98d5e83912a04043ae0ef772a268e22c2ade4eb79/b2accessdeprovisioning-0.9.1-py2-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e0ae2086f12e00988ca4991b506bfe70", "sha256": "884ca7c0f8990c2e58ecd494fd47d6c04927a5be555eafc47fa66b99cd58565c" }, "downloads": -1, "filename": "b2accessdeprovisioning-0.9.1-py2-none-any.whl", "has_sig": false, "md5_digest": "e0ae2086f12e00988ca4991b506bfe70", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": ">=2.6,<2.8", "size": 9539, "upload_time": "2017-08-21T02:53:58", "url": "https://files.pythonhosted.org/packages/8d/9f/ad259afced75ef379bf98d5e83912a04043ae0ef772a268e22c2ade4eb79/b2accessdeprovisioning-0.9.1-py2-none-any.whl" } ] }