This is a client library for the Unity IDM APIs.

Currently, it only supprorts a subset of the operations exposed by Unity’s Administration API.

Python version

Python 2.6 or 2.7 are fully supported.


To install the client library, simply run:

$ pip install unityapiclient

Third party libraries and dependencies

The following libraries will be installed when you install the client library:


The following example assumes a Unity IDM deployment at https://unity.example.org:

>>> import unityapiclient
>>> from unityapiclient.client import UnityApiClient
>>> client = UnityApiClient('https://unity.example.org',
... auth=('unityapiuser', 'secretpassword'))
>>> entity = client.get_entity(257)
>>> entity['entityInformation']['state']

Indices and tables