Python interface to OpenAM REST Services
Code borrowed and reworked from github repositories:
The openam.py module provided by django-openam had a dependency upon python-restclient which in turn had a dependency upon python-httplib2. I removed these dependencies in favor of Python's urllib2, which is part of the Standard Library. Since we're just doing basic HTTP GET calls, I felt that eliminating the external dependencies made this library as lightweight as possible.
For REST Services documentation please see Forgerock Use OpenAM RESTful Services
Example with username and password:
>>> import openam
>>> oam = openam.OpenAM('https://example.com/openam')
>>> token = oam.authenticate(username='pepesmith', password='likesbananas')
>>> oam.is_token_valid(token)
True
>>> attrs = oam.attributes(token)
>>> attrs.attributes.keys()
['telephonenumber', 'distinguishedname', 'inetUserStatus', 'displayname', 'cn',
'dn', 'samaccountname', 'useraccountcontrol', 'objectguid', 'userprincipalname',
'name', 'objectclass', 'sun-fm-saml2-nameid-info', 'sn', 'mail',
'sun-fm-saml2-nameid-infokey', 'givenname', 'employeenumber']
>>> attrs.attributes.get('displayname')
'Smith, Pepe'
>>> oam.logout(token)
>>> oam.is_token_valid(token)
False
Example with token:
>>> import openam
>>> oam = openam.OpenAM('https://example.com/openam')
>>> token_cookie_name = oam.get_cookie_name_for_token()
>>> openam_token = some_cookie_dict.get(token_cookie_name)
>>> oam.is_token_valid(openam_token)
True
>>> attrs = oam.attributes(openam_token)
>>> attrs.attributes.keys()
['telephonenumber', 'distinguishedname', 'inetUserStatus', 'displayname', 'cn',
'dn', 'samaccountname', 'useraccountcontrol', 'objectguid', 'userprincipalname',
'name', 'objectclass', 'sun-fm-saml2-nameid-info', 'sn', 'mail',
'sun-fm-saml2-nameid-infokey', 'givenname', 'employeenumber']
>>> attrs.attributes.get('displayname')
'Smith, Pepe'
>>> oam.logout(openam_token)
>>> oam.is_token_valid(openam_token)
False