README

Use this package to integrate ADManager Plus REST API into your Laravel application.

Installation

You can install the package via composer:

composer require springfieldclinic/laravel-admanager-plus-sdk

You can publish the config file with:

php artisan vendor:publish --tag="laravel-admanager-plus-sdk-config"

This is the contents of the published config file:

return [
    /*
    |--------------------------------------------------------------------------
    | Base API URL
    |--------------------------------------------------------------------------
    | The full base URL to your ADManager Plus REST API (e.g.
    | http://hostname:8080/RestAPI). Leave null to set via ENV.
    */
    'BASE_API_URL' => env('ADMANAGER_BASE_API_URL', null),

    /*
    |--------------------------------------------------------------------------
    | Active Directory Domain Name
    |--------------------------------------------------------------------------
    | The domain that ADManager Plus will target by default.
    */
    'domainName' => env('ADMANAGER_DOMAIN_NAME', null),

    /*
    |--------------------------------------------------------------------------
    | Authorization Token
    |--------------------------------------------------------------------------
    | A valid AuthToken generated in ADManager Plus (Delegation → Technician Authtokens).
    */
    'AuthToken' => env('ADMANAGER_AUTH_TOKEN', null),

    /*|--------------------------------------------------------------------------
    | Product Name
    |--------------------------------------------------------------------------
    | The product name to use in the API requests. Defaults to 'RESTAPI'.
    | This can be useful for identifying the source of API requests in audit/logs.
    */
    'PRODUCT_NAME' => env('ADMANAGER_PRODUCT_NAME', 'RESTAPI'),
];

Set the following in .env:

ADMANAGER_PLUS_BASE_API_URL=http://your-admanager-plus-host
ADMANAGER_PLUS_DOMAIN_NAME=your.domain.com
ADMANAGER_PLUS_AUTH_TOKEN=your_auth_token
ADMANAGER_PLUS_PRODUCT_NAME=name_of_your_application_for_audit_purposes

Usage

use LaravelAdmanagerPlusSdk\Http\Clients\ADManagerPlusConnector;

$connector = new ADManagerPlusConnector();
$users = $connector->users()->search(searchText: 'john');

dump($users);

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

springfieldclinic / laravel-admanager-plus-sdk

Maintainers

Details