This is an old revision of the document!

Fusiondirectory WebService

FusionDirectory WebService plugin exposes a JSONRPC webservice you can use if you want to access LDAP content through FusionDirectory system (This way, you ensure that things like foreign keys are kept consistent, and you have a nicer API than the low-level LDAP one). It is a standard JSONRPC server served on HTTPS protocol (Note that you can allow HTTP in plugin configuration, but please avoid doing so except for testing purposes). The available methods are detailed here:

Basically you first need to call login to get a session ticket you’ll use in the other method calls you make. If you have several LDAP configured you might call listLdaps first to list them and specify which one to use as first parameter of login (otherwise just pass NULL as first parameter).

Then you can use ls to list objects of a given type (list types with listTypes first if needed). getfields method will give you the fields of a given type (and tab) and setfields will allow you to change the value of these fields.

example in PHP

/* You can find this file in FusionDirectory include directory if argonaut plugin is installed */
/* Connection information. Fill peer_name with the name matching the certificate. */
$host       = 'https://localhost/fusiondirectory/jsonrpc.php';
$ca_file    = '/etc/ssl/certs/fd.pem';
$login      = 'fd-admin';
$password   = 'adminpwd';
/* DN of an existing user we can display and modify */
$userdn     = 'uid=bilbo,dc=opensides,dc=be';
$ssl_options = array(
  'cafile'            => $ca_file,
  'peer_name'         => 'localhost',
  'verify_peer'       => TRUE,
  'verify_peer_name'  => TRUE,
$http_options = array(
  'timeout' => 10
try {
  /* We create the connection object */
  $client = new jsonRPCClient($host, $http_options, $ssl_options);
  /* Then we need to login. Here we log in the default LDAP */
  $session_id = $client->login(NULL, $login, $password);
  /* Once we have a session ID, we can ask for the list of users */
  $users  = $client->ls($session_id, 'user');
  foreach ($users as $dn => $user) {
    echo "$user ($dn)\n";
  /* We can get a user’s fields */
  $fields = $client->getfields($session_id, 'user', $userdn);
  /* Change a value. We can pass an array for each tab, main one is 'user'. 
     The array for each tab contains attribute ids and their new value. 
     Attribute ids can be found in getfields, they are used as keys in the 'attrs' array of each section. 
  $result = $client->setfields($session_id, 'user', $userdn, 
      'user' => array('description' => 'Modified by webservice')
  if (isset($result['errors'])) {
    foreach($result['errors'] as $error) {
      print "Error: $error\n";
  /* Doing the same thing with NULL as dn would create a user, if you provide all needed fields. */
} catch (jsonRPCClient_RequestErrorException $e) {
} catch (jsonRPCClient_NetworkErrorException $e) {
en/documentation/plugin/webservice_plugin/how_to_use_webservice.1475489487.txt.gz · Last modified: 2017/10/31 10:38 (external edit)
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0