{"id":16130070,"url":"https://github.com/dj-wasabi/python-openam","last_synced_at":"2025-03-18T14:30:51.258Z","repository":{"id":142810783,"uuid":"66199235","full_name":"dj-wasabi/python-openam","owner":"dj-wasabi","description":null,"archived":false,"fork":false,"pushed_at":"2019-05-22T17:37:54.000Z","size":603,"stargazers_count":11,"open_issues_count":2,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-16T21:01:55.746Z","etag":null,"topics":["openam","python"],"latest_commit_sha":null,"homepage":"http://python-openam.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dj-wasabi.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-08-21T13:06:02.000Z","updated_at":"2023-12-05T12:45:31.000Z","dependencies_parsed_at":"2023-05-07T06:47:25.234Z","dependency_job_id":null,"html_url":"https://github.com/dj-wasabi/python-openam","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dj-wasabi%2Fpython-openam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dj-wasabi%2Fpython-openam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dj-wasabi%2Fpython-openam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dj-wasabi%2Fpython-openam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dj-wasabi","download_url":"https://codeload.github.com/dj-wasabi/python-openam/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244240025,"owners_count":20421383,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openam","python"],"created_at":"2024-10-09T22:14:23.436Z","updated_at":"2025-03-18T14:30:51.251Z","avatar_url":"https://github.com/dj-wasabi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\npython-openam\n=============\n\n.. image:: https://readthedocs.org/projects/python-openam/badge/?version=latest\n    :target: http://python-openam.readthedocs.org/en/latest/?badge=latest\n    :alt: Documentation Status\n\n.. image:: https://travis-ci.org/dj-wasabi/python-openam.svg?branch=master\n    :target: https://travis-ci.org/dj-wasabi/python-openam\n    :alt: Build Status\n\n.. image:: https://badge.fury.io/py/python-openam.svg\n    :target: https://badge.fury.io/py/python-openam\n\n.. image:: https://cdn.rawgit.com/dj-wasabi/python-openam/master/coverage.svg\n\nThis module is a python wrapper for the OpenAM API. With this module you can easy make use of the OpenAM API. The goal is to fully configure an OpenAM instance via the API.\n\nInformation:\n\n* Github page: https://github.com/dj-wasabi/python-openam\n* PyPi page: https://pypi.python.org/pypi/python-openam\n* Docker container: https://hub.docker.com/r/wdijkerman/openam/\n\n\nOpenAM Versions\n***************\n\nThis python module should work with the following versions of OpenAM:\n\n* 12.0.0\n* 13.0.0\n\nTests will validate that the module works on these versions. There is no plan yet to update the module so it can also handle older \"legacy\" versions.\n\nWhat is working in the current version of this module.\nThe following (json/) endpoints work:\n\n+--------------------+------------+-----------+\n| endpoint           | OpenAM 12  | OpenAM 13 |\n+====================+============+===========+\n| /authenticate      |  V         |    V      |\n+--------------------+------------+-----------+\n| /users             |  V         |    V      |\n+--------------------+------------+-----------+\n| /groups            |  V         |    V      |\n+--------------------+------------+-----------+\n| /agents            |  V         |    V      |\n+--------------------+------------+-----------+\n| /realms            |  V         |    V      |\n+--------------------+------------+-----------+\n| /dashboard         |  .         |    .      |\n+--------------------+------------+-----------+\n| /sessions          |  V         |    V      |\n+--------------------+------------+-----------+\n| /serverinfo/*      |  V         |    V      |\n+--------------------+------------+-----------+\n| /applications      |  .         |    .      |\n+--------------------+------------+-----------+\n| /resourcetypes     |  n.a.      |    V      |\n+--------------------+------------+-----------+\n| /policies          |  .         |    .      |\n+--------------------+------------+-----------+\n| /applicationtypes  |  .         |    .      |\n+--------------------+------------+-----------+\n| /conditiontypes    |  .         |    .      |\n+--------------------+------------+-----------+\n| /subjecttypes      |  .         |    .      |\n+--------------------+------------+-----------+\n| /subjectattributes |  .         |    .      |\n+--------------------+------------+-----------+\n| /decisioncombiners |  .         |    .      |\n+--------------------+------------+-----------+\n| /subjectattributes |  .         |    .      |\n+--------------------+------------+-----------+\n\nV = Works\n\n. = Not working (yet)\n\n\nThe following (xacml/) endpoints work:\n\n+--------------------+------------+-----------+\n| endpoint           | OpenAM 12  | OpenAM 13 |\n+====================+============+===========+\n| /policies          |  V         |    V      |\n+--------------------+------------+-----------+\n\nThe following (frrest/) endpoints work:\n\n+--------------------+------------+-----------+\n| endpoint           | OpenAM 12  | OpenAM 13 |\n+====================+============+===========+\n| /token             |  .         |    .      |\n+--------------------+------------+-----------+\n| /client            |  .         |    .      |\n+--------------------+------------+-----------+\n\n\nInstallation\n************\n\nInstallation is very simple, execute the following command:\n\n.. code:: bash\n\n    pip install python-openam\n\nModule is installed and can be used.\n\nExample usage\n*************\n\nThe following is a basic example for authenticating and doing an logout on OpenAM:\n\n.. code:: python\n\n    import openam\n\n    am = openam.Openam(openam_url=\"http://openam.example.com:8080/openam/\")\n    am.authenticate(username=\"amadmin\", password=\"password_openam\")\n    am.logout()\n\nYou'll have to update the 'openam_url' and both the 'username' and 'password' for your setup.\n\n\nCreating an identity\n\n.. code:: python\n\n    import openam\n    am = openam.Openam(openam_url=\"http://openam.example.com:8080/openam/\")\n    auth_data = am.authenticate(username=\"amadmin\", password=\"password_openam\")\n    user_data = {\"username\": \"bjensen\", \"userpassword\": \"secret12\", \"mail\": \"bjensen@example.com\"}\n\n    am.create_identity(user_data=user_data)\n    {u'username': u'bjensen', u'dn': [u'uid=bjensen,ou=people,dc=openam,dc=forgerock,dc=org'], u'realm': u'/'..}\n    am.create_identity(user_data=user_data)\n    {u'reason': u'Conflict', u'code': 409, u'message': u'Resource already exists'}\n    am.logout()\n\n\nIssues\n******\n\nOf course there are issues, please let me know. Also if you want to help me add functionality to the module, let me know and create a Pull Request.\n\nAll help is welcome. :-)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdj-wasabi%2Fpython-openam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdj-wasabi%2Fpython-openam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdj-wasabi%2Fpython-openam/lists"}