Softerra.Adaxes.Client 3.18.0

About

The Softerra.Adaxes.Client library provides the necessary classes and interfaces to build custom applications and integrations that interact with Adaxes, a self-hosted automation and identity management solution.

Prerequisites

To use this library effectively, you must have access to a licensed or a trial deployment of the Adaxes service. It is not intended for general-purpose use outside of the Adaxes ecosystem.

The computer where you will be using this library must be joined to an Active Directory domain.

Key features

• Perform operations in Active Directory, Entra ID, Exchange, and Microsoft 365 via Adaxes service.
• Manage Adaxes configuration and modify Adaxes service settings.
• Create configuration objects like business rules or custom commands.
• View log records for operations performed via Adaxes.
• Generate and export reports you have configured in Adaxes.
• Process approval requests.

How to use

To perform any operations on an Adaxes service instance, you need to connect to it. Here's an example of how you can connect to an Adaxes service installed on a specific host.

using Softerra.Adaxes.Adsi;
using Softerra.Adaxes.Interop.Adsi.PersistentObjects;

const string hostName = "myserver.example.com";
AdmNamespace ns = new AdmNamespace();
IAdmService service = ns.GetServiceDirectly(hostName);

For more details and other methods of connecting to an Adaxes service, see Connecting to Adaxes service.

Once connected, you need to bind to an object you want to interact with. The binding method is identical for directory objects and Adaxes configuration objects – IAdmService.OpenObject.

The operations you can perform with an object depend on which interface you used to access it. For example, you need to use different interfaces to perform Microsoft 365 and Exchange operations:

using Softerra.Adaxes.Adsi;
using Softerra.Adaxes.Interop.Adsi.Microsoft365;
using Softerra.Adaxes.Interop.Adsi.PasswordSelfService;
using Softerra.Adaxes.Interop.Adsi.PersistentObjects;

const string hostName = "myserver.example.com";
AdmNamespace ns = new AdmNamespace();
IAdmService service = ns.GetServiceDirectly(hostName);

const string userPath = "Adaxes://CN=John Smith,CN=Users,DC=domain,DC=com";

// Binding to a user to modify Microsoft 365 properties.
IAdmM365Account user1 = (IAdmM365Account)service.OpenObject(userPath, null, null, 0);

// Binding to a user to create an Exchange mailbox.
IAdmExchangeMailboxOps user2 = (IAdmExchangeMailboxOps)service.OpenObject(userPath, null, null, 0);

For more information, see Interfaces supported by directory objects.

The examples above illustrate the general pattern for interacting with Adaxes: connect to the service, bind to an object, and use the appropriate interface to perform operations. For a complete API reference and detailed guidance, see the documentation below.

Documentation

• Developing with Adaxes .NET API
• Adaxes SDK

You are also welcome to leave feedback and submit bug reports using our support form.

License

This package is distributed under the MIT license.