Welcome to python-syncope’s documentation!

Documentation Status

Table of Content

Overview

This is an python wrapper for the Syncope REST API. You’ll be able to get, create and update User, roles and a lot more via the API. You’ll need basic understanding of JSON to use this module properly. I tried to add a lot of example on how to use the functions in this module. If you do however find something that might be documented better, please let me know. Also check the ‘examples’ directory on github for examples.

Syncope usage

An overview of the components on which Syncope version is working.

component Syncope 1.1 Syncope 1.2
Users v x
Roles v x
Logger v x
Audit v x
Configuration v x
Entitlements v x
Notifications v x
Policies v x

This module is sill Work In Progress, so if you miss an specific action it will come. You could also help me by adding the actions yourself and creating an Pull Request.

Installation

Installation can be done with:

pip install python-syncope

Indices and tables