- Overview
- Configuration
Boomi
Automate employee lifecycle management by integrating Boomi with ADManager Plus
Boomi is an integration and automation platform that can help you instantly connect to applications, sync data, and automate processes such as employee onboarding. By integrating Boomi with ADManager Plus, you can extend your HCM platform's capabilities. Integrate Boomi with ADManager Plus to synchronize with AD and automate perform employee life cycle management across Exchange, Microsoft365 and other connected applications with ease.
Multi-platform user provisioning
Automatically create user accounts across various platforms, such as AD, Exchange, and Microsoft 365, when new employees are added to the HCM application.
A reduction in security risks caused by obsolete accounts
Automatically delete or disable user accounts, remove their licenses, and do even more each time a user record is deleted in the HCM application.
How to integrate Boomi with ADManager Plus
Prerequisites
Provide an API key with permissions to retrieve the desired information and perform tasks in Boomi. Refer to Boomi's API references for more details.
Privileges
- To import users from Boomi (inbound action): Ensure the account used for authorization has permission to read all user accounts.
- To perform any action or query in Boomi (outbound action): Ensure the account used for authorization has permission to perform the desired action.
Authorization configuration
- Log in to ADManager Plus and navigate to Directory/Application Settings.
- Go to Application Integrations, then search for and select Boomi.
- Toggle the Enable Boomi Integration button on.
- In the Boomi Configuration page, click Authorization.
- Generate the API key and API token in Boomi, and paste the generated value in the Value field for the x-boomi-flow-api-key.
- Click Configure.
Inbound webhook configuration
An inbound webhook enables you to fetch user data from Boomi and send it to ADManager Plus. To configure an inbound webhook for Boomi:
- Under Inbound Webhook, click Boomi Endpoint Configuration.
- An endpoint, Boomi USERS ENDPOINT, comes preconfigured with Endpoint URL, HTTP Method, Headers, and Parameters fields to fetch user accounts from Boomi. If you would like to use this preconfigured endpoint, replace {Domain-Name} with the domain name of your Boomi instance in the Endpoint URL field. However, if you would like to use a new endpoint to import users, you can configure one using the + Add API Endpoint button and filling in the required fields per Boomi's API references. To learn how, see this help document. Note:
- The API key-value pair is preconfigured as a header for authenticating API requests as configured during authorization configuration.
- Refer to Boomi's API references and configure additional headers and parameters, if needed.
- Macros can be added to the endpoint URL, headers, parameters, and message body to dynamically modify the configuration using the macro chooser.
- Once done, click Test & Save to validate and save the endpoint, or click Save as Draft to store the configuration as a draft without testing the endpoint. If you choose Test & Save, a response window will be displayed with the following tabs:
- Response: Displays API response parameters in a tree structure. You can set the datatype for each field:
- Text (default)
- Number
- Timestamp
- Array
- Response Details: Displays the complete response message in text format.
- Request: Displays the request headers, parameters, and message body.
- Response: Displays API response parameters in a tree structure. You can set the datatype for each field:
- Click Save. Note: You can configure multiple endpoints for Boomi using the + Add API Endpoint button. To learn how, see this help document.
- Click Data Source - LDAP Attribute Mapping to match endpoints and to map AD LDAP attributes with the respective attributes in Boomi. ADManager Plus also lets you customize the attribute format from Boomi.
- Click + Add New Configuration and perform the following:
- Enter the Configuration Name and Description and select the Automation Category from the drop-down menu.
- In the Select Endpoint field, select the desired endpoint and a Primary Key that is unique to a user (e.g., employeeIdentifier). Note: When multiple endpoints are configured, this attribute must hold the same value in all the endpoints.
- In the Attribute Mapping field, select the attribute from the LDAP Attribute Name drop-down menu and map it to the corresponding column in Boomi. Macros are also supported in attribute mapping. To create a new custom format, click Add New Format.
- Click Save.
Outbound webhook configuration
An outbound webhook enables you to update the changes made in AD using ADManager Plus in Boomi or fetch or forward required details from Boomi and synchronize them with AD. To configure an outbound webhook for Boomi:
- Under Outbound Webhook, click Boomi Webhook Configuration.
- Two endpoint configurations—Boomi Add User Endpoint and Boomi Delete User Endpoint—come preconfigured with the Endpoint URL, HTTP Method, Headers, and Parameters required to send user account data to Boomi. To use these preconfigured endpoints, replace {Domain-Name} in the Endpoint URL field with your Boomi instance’s domain name.
- Alternatively, if you prefer to create a new endpoint, click + Add Webhook.
- Enter a name and description for this webhook.
- Decide on the action that will be performed and refer to Boomi's API references for the API details, such as the URL, headers, parameters, and other requirements. Enter the employee details value in the Parameter field.
- Select the HTTP method that will enable you to perform the desired action on the endpoint from the drop-down menu.
- Enter the endpoint URL.
- Configure the Headers, Parameters, and Message Type in the appropriate format based on the API call that you would like to perform. Note: Macros can be added to the endpoint URL, headers, parameters, and message body to dynamically modify the configuration using the macro chooser.
- Click Test & Save to validate and save the webhook, or click Save as Draft to store the webhook as a draft without testing.
- If you select Test & Save, a response window will be displayed. Choose the user or group on which the API request should be tested and click OK. This triggers a real-time call to the endpoint URL, allowing you to verify whether macros are applied correctly. You may skip selecting a user or group. However, if you do make a selection, the macros present in the webhook will be parsed using the selected object’s values.
- Response: Displays API response parameters in a tree structure. You can set the datatype for each field:
- Text (default)
- Number
- Timestamp
- Response Details: Displays the complete response message in text format.
- Request: Displays the request headers, parameters, and message body.
- Response: Displays API response parameters in a tree structure. You can set the datatype for each field:
- Verify them for the expected API behavior and click Save.
Actions supported:
Upon integrating Boomi with ADManager Plus, you can do the following:
- Create user accounts
- Delete user accounts
- Disable user accounts
- Modify user account properties
- Remove Microsoft 365 licenses
- Add users to groups
- Remove users from groups
- Move users across groups
- Modify user attributes with templates
- Create mailboxes
- Disable mailboxes
- Delete mailboxes
- Reset passwords
- Move the home folder
- Delete the home folder
- Manage users' photos
- Configure automatic reply settings
- Disable Lync accounts
- Run custom scripts