Skip to content

Overview

This SDK includes API references, code samples, and documentation to help you customize Adaxes and adjust the product to meet your specific business and organizational needs. To benefit most from the documentation and samples included in this SDK, you should be familiar with Adaxes functionality, ADSI and PowerShell programming.

Adaxes provides a high degree of customization, enabling you to:

  • Customize automation processes and AD management operations with user-defined scripts.

    Providing the ability to use custom scripts in Business Rules, Scheduled Tasks, and Custom Commands, Adaxes makes it possible to extend its out-of-the-box functionality and lets you automate all aspects of your unique business processes. Embedding user-defined scripts into AD management processes enables you to:

    • Facilitate provisioning and deprovisioning of user accounts by involving various data sources in the process. For example, you can populate properties of user accounts based on data from an external database.

    • Synchronously update data in multiple data sources. For example, when a user account is created, modified or deleted in Active Directory, using scripts you can automatically create, modify, and delete user accounts in other systems and applications than Active Directory.

    • Implement sophisticated data validation procedures to ensure the quality and integrity of user input. For example, you may want to ensure that the Employee ID specified for a new user is valid by querying your HR database. Or you can use a script to verify that user logon names are always in accordance with established policies and guidelines.

    • Automate Active Directory management tasks by involving third-party applications in the administrative workflow. For example, during an operation on an AD object, your script can make a call to a web service to initiate a processing task in your web application hosted somewhere in the cloud.

    For details, see Server-side scripting.

  • Use scripts to configure and manage your Adaxes service.

    Using scripting it is possible to manage Adaxes configuration objects (Scheduled Tasks, Security Roles, Property Patterns, Business Rules, etc). All operations performed in Adaxes Administration Console interactively can be done by using scripts. For example, using a script you can create a Scheduled Task that will deprovision a specific user account on a predefined date and configure the task to delete itself after execution.

  • Develop custom client applications and scripts for Active Directory management.

    You can use the Adaxes ADSI Provider in your applications, user interfaces and scripts to communicate with Adaxes Service. The ADSI Provider is the main programming interface for Adaxes. All Adaxes clients, including Web Interface and Administration Console, use the ADSI Provider to perform operations in Active Directory and Adaxes. It means that all operations implemented in the clients can be implemented in your custom applications and scripts.

    Using Adaxes ADSI Provider to perform operations in Active Directory allows you to leverage Adaxes features like Business Rules and Property Patterns. For example, if your application creates a new user account in Active Directory using Adaxes ADSI Provider, all account provisioning operations will be done automatically by Adaxes.

    Using Adaxes ADSI Provider you can also integrate Active Directory management capabilities with your existing applications and workflow processes.

Adaxes ADSI Provider

Adaxes ADSI Provider provides client applications and scripts with a common interface for communicating with Adaxes services. The ADSI Provider is a set of Component Object Model (COM) interfaces and objects that you can use within scripts and custom applications to work with Active Directory and Adaxes. Adaxes ADSI objects can be accessed and manipulated by any language that supports automation, such as PowerShell, VBScript, Visual Basic, C#, C++, or Java.

All Adaxes clients, including Web Interface and Administration Console, use the ADSI Provider to manipulate Active Directory objects and Adaxes configuration. The ADSI Provider translates client requests into .NET Remoting calls and sends them to the Adaxes Service. Upon receiving an operation request from a client, the Adaxes Service performs the requested operation in Active Directory or Adaxes Configuration Server.

 Adaxes ADSI Provider

To use Adaxes ADSI Provider, it must be installed on the computer where your script or application is running. For information on how to install Adaxes ADSI Provider, see Install Adaxes ADSI Provider. For details on how to use ADSI provider, see Writing ADSI Scripts.

Adaxes PowerShell module for Active Directory

Adaxes PowerShell Module is a set of PowerShell cmdlets designed to provide a command-line interface for Active Directory management. Using cmdlets included in Adaxes PowerShell Module you can create, update and delete Active Directory objects, manage group memberships, reset passwords, search Active Directory, etc.

Operations on Active Directory objects can be performed either via the Adaxes Service, or by directly accessing Active Directory domain controllers. When using the Adaxes Service as a proxy, you benefit from Adaxes features like Active Directory automation, workflow rules, data validation policies, audit and reporting. If you want an operation to be performed via the Adaxes Service, you need to specify the AdaxesService parameter for a cmdlet:

Search-AdmAccount -AccountDisabled -AdaxesService localhost

This SDK includes reference topics about the cmdlets included in the Adaxes PowerShell Module.

See also