LDAP

This chapter describes how to use the LDAP endpoints. These endpoints are used to read, add, modify or delete objects in an LDAP directory server. As we intend to map LDAP objects to their equivalent Broadworks structure of tenants, groups and users, the endpoints are structured in the same way as common Broadworks endpoints.

Note that JSON structure of endpoints is not fixed but is defined by the LDAP Server backend on APIO. See documentation for a full description on how to configure LDAP Server backend.

Contents:

• LDAP Backend Management
  • Retrieve the list of available backends
• LDAP Tenant Management
  • Retrieve a list of tenants with filter
  • Retrieve a list of tenants with custom filter
  • Retrieve one specific tenant
  • Create a new tenant
  • Modify an existing tenant
  • Delete a tenant
• LDAP Group Management
  • Retrieve a list of groups with filter
  • Retrieve a list of groups with custom filter
  • Retrieve one specific group
  • Create a new group
  • Modify an existing group
  • Delete a group
• LDAP User Management
  • Retrieve a list of users with filter
  • Retrieve a list of users with custom filter
  • Retrieve one specific user
  • Create a new user
  • Modify an existing user
  • Delete a user
• LDAP Object Management by OU (DN)
  • Retrieve an object by OU (DN)
  • Create an object by OU (DN)
  • Modify an existing object by OU (DN)
  • Delete an object by OU (DN)
• LDAP Last Modified
  • Retrieve a list of modified OU’s by date
• LDAP Object Details
  • General Configuration
  • Attributes Mapping
• LDAP Filter Details