ADManager Plus API
The ADManager Plus API is a complete REST- based interface designed to help you seamlessly integrate Active Directory (AD) management with your existing IT ecosystem. As organizations increasingly rely on automation and cross-platform workflows, the API provides a secure and reliable way to extend ADManager Plus functionality into external tools and services.
With this API, you can perform a wide range of AD operations programmatically, such as provisioning new user accounts, resetting or unlocking passwords, updating user details, and managing groups. This allows IT teams, help desk technicians, and system integrators to connect ADManager Plus with HR applications, ticketing systems, and custom business tools, ensuring faster response times while reducing manual effort.
ADManager Plus API is built to be:- Consistent: Provides clean REST endpoints with predictable responses.
- Flexible: Supports create, read, update, delete (CRUD) operations and action-based workflows.
- Secure: Requires authorization tokens to ensure only authenticated requests are processed.
- Scalable: Includes built-in rate limits to protect service stability across all users.
All API requests must include an authorization token in the request header. You can generate this token from the Delegation tab (Delegation > Configuration > Technician Authtokens) or from the My Account tab (My Account > Active Authtokens) in ADManager Plus. For more details on generating and managing tokens, see the Authentication section.
http://admanagerplus:8080/api/v2
Prerequisites
To use the ADManager Plus API, ensure the following requirements are met:
- You must have an ADManager Plus instance installed and running on a server.
- You must have a valid authentication token, which can be generated in ADManager Plus.
- You should have a basic understanding of RESTful APIs and how to work with data in JSON format.
- You should be familiar with the HTTP methods ( GET, POST, PATCH, DELETE ) that are used to make API calls.
HTTP methods and status codes
HTTP methods
ADManager Plus APIs follow standard REST conventions for interacting with resources. Each operation is performed using a specific HTTP method, and the result of that operation is communicated through an HTTP status code in the response.
The following HTTP methods are supported, each serving a specific purpose in resource management:
| Method | Purpose |
|---|---|
| GET | Used to retrieve information from the server.For example, fetching user account details or listing groups. |
| POST | Used to create new resources or trigger actions.For example, creating a new user or resetting a password. |
| PATCH | Used to partially update an existing resource without replacing the entire object.For example, modifying only the phone number of a user. |
| DELETE | Used to remove an existing resource from the server.For example, deleting a user account or removing a group. |
Status codes
Every response from the API includes a standard HTTP status code that indicates whether the request was successful or if an error occurred. Status codes in the 2xx range indicate success, 4xx indicate client-side errors, and 5xx indicate server-side errors. The most common status codes used in ADManager Plus APIs are listed below:
| Status code | Message | Description |
|---|---|---|
| 200 | OK | The request was successful, and the server retrieved and returned the requested data. |
| 201 | Created | The request was successful, and a new resource was created or added on the server. |
| 400 | Bad Request | The request could not be processed due to invalid input, such as missing parameters or incorrect field values in the request body. |
| 401 | Unauthorized | Authentication failed because the token was missing, expired, or invalid. The request cannot be processed without a valid token. This error may also occur if the required actions are not delegated to the technician or if the account lacks permission to perform the operation . |
| 404 | Not Found | The requested resource could not be found on the server. |
| 405 | Method Not Allowed (method called is not supported for the API invoked) | The server recognizes the request method, but the endpoint does not support it for the requested resource.For example, sending a POST request to a read-only resource. |
| 500 | Internal Server Error | The server encountered an unexpected error while processing the request. |
API Call Limit
To provide better quality of service, maintain performance, stability, and fair usage across all users, ADManager Plus enforces rate limits on API calls.
These are the following rate limits:
- Read APIs (GET requests): Limited to 100 requests per minute, applied across all GET endpoints.
- Action APIs (non-GET requests): Limited to 50 requests per minute, applied across POST, PATCH, and DELETE endpoints.
- Custom limits: Some APIs may define their own stricter limits depending on their impact. Any such limits will be clearly documented in the respective API’s description.
- Usage tracking: You can view your API usage count inside the product. Log in and navigate to Admin > System Settings > Integrations > Rest API. In the top-right corner, a Rest API Usage counter shows your total allocation and current usage.
REST API settings page in ADManager Plus showing available API operations and usage quota.