Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (
Help us improve Python packaging - Donate today!

Managing OpenAM via rest API

Project Description

This 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.


OpenAM Versions

This python module should work with the following versions of OpenAM:

  • 12.0.0
  • 13.0.0

Tests 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.

What is working in the current version of this module. The following (json/) endpoints work:

endpoint OpenAM 12 OpenAM 13
/authenticate V V
/users V V
/groups V V
/agents V V
/realms V V
/dashboard . .
/sessions V V
/serverinfo/* V V
/applications . .
/resourcetypes n.a. V
/policies . .
/applicationtypes . .
/conditiontypes . .
/subjecttypes . .
/subjectattributes . .
/decisioncombiners . .
/subjectattributes . .

V = Works

. = Not working (yet)

The following (xacml/) endpoints work:

endpoint OpenAM 12 OpenAM 13
/policies . .

The following (frrest/) endpoints work:

endpoint OpenAM 12 OpenAM 13
/token . .
/client . .


Installation is very simple, execute the following command:

pip install python-openam

Module is installed and can be used.

Example usage

The following is a basic example for authenticating and doing an logout on OpenAM:

import openam

am = openam.Openam(openam_url="")
am.authenticate(username="amadmin", password="password_openam")

You’ll have to update the ‘openam_url’ and both the ‘username’ and ‘password’ for your setup.

Creating an identity

import openam
am = openam.Openam(openam_url="")
auth_data = am.authenticate(username="amadmin", password="password_openam")
user_data = {"username": "bjensen", "userpassword": "secret12", "mail": ""}

{u'username': u'bjensen', u'dn': [u'uid=bjensen,ou=people,dc=openam,dc=forgerock,dc=org'], u'realm': u'/'..}
{u'reason': u'Conflict', u'code': 409, u'message': u'Resource already exists'}


Of 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.

All help is welcome. :-)

Release History

Release History

This version
History Node


History Node


History Node


Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting