- Overview
- Configuration
Carbonite
Simplify Carbonite account provisioning and backup access management.
Overview
Carbonite is a backup and data recovery software that prevents threats like data loss, including ransomware, accidental deletion, computer theft and hardware failure. Integrating Carbonite with ManageEngine ADManager Plus enables IT administrators to streamline user account management by automating user creation and updates in Carbonite based on user data in Active Directory (AD) records.
Automated user creation
IT administrators can automate the addition of users in Carbonite using data from ADManager Plus. When a new user is created in AD, a corresponding Carbonite account is automatically provisioned. This ensures users can access backup and recovery services without delay.
Real-time user updates
Automatically update user records in Carbonite to reflect changes made in ADManager Plus. For example, if a user's information, such as email or role, is updated in AD, the changes are synchronized with their Carbonite account in real time, ensuring data accuracy and streamlined management.
Prerequisites:
Please ensure to provide the Bearer Token to retrieve desired information and perform tasks in Carbonite. Refer to Carbonite API references for more details.
Privileges:
- To import users (inbound action): Ensure the account used for authorization has permission to read all user accounts.
- To perform any action or query in Carbonite (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 and select Carbonite.
- Toggle the Enable Carbonite Integration button to On.
- In the Carbonite Configuration page, click Authorization.
- Perform the steps to generate Bearer Token in Carbonite and paste the Bearer Token in the Value field.
- Replace {region} value with that of your Carbonite instance.
- Replace {email} and {apiKeySecret value} in authorization endpoint body message with that of your Carbonite instance.
- Click Configure.
Inbound webhook configuration
Inbound webhook enables you to fetch user data from Carbonite and transfer it to ADManager Plus. To configure an inbound webhook for Carbonite:
- Under Inbound Webhook, click Carbonite Endpoint Configuration.
- In the Endpoint Configuration tab, an endpoint, Carbonite GET
USERS ENDPOINT, comes preconfigured with an Endpoint URL, API
Method, Headers, and Parameters fields to fetch user
accounts from Carbonite. If you would like to use this preconfigured
endpoint, replace {region} with that of your Carbonite
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
as per Carbonite's API references. Click
here to learn how. Note:
- Authorization Header is preconfigured as a header for authenticating API requests as configured during Authorization Configuration.
- You can add macros to your endpoint configuration to dynamically change it as per your requirement using the macro chooser component
- Refer to Carbonite's API references and configure additional headers and parameters, if required.
- Once done, click Test & Save. A response window
will display all the requested parameters that can be fetched using the
API call. After verifying if the requested parameters have been called
to action, click Proceed. Note:
- Refer to Carbonite's API references to know the Parameters that must be configured to fetch only specific parameters.
- You can configure multiple endpoints for Carbonite using the + Add API endpoint button. Click here to learn how.
- Click Data Source - LDAP Attribute Mapping to match endpoints and to map AD LDAP attributes with the respective attributes in Carbonite.
- 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 (for example, 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 with the respective attribute in Carbonite.
- If you would like to create a new custom format for this, click Add New Format.
- Click Save.
Outbound webhook configuration
An outbound webhook enables you to send changes made in AD using ADManager Plus to Carbonite and carry out tasks in Carbonite—all from ADManager Plus. To configure an outbound webhook for Carbonite:
- Under Outbound Webhook, click Carbonite Webhook Configuration.
- Click + Add Webhook.
- Enter a name and description for this webhook.
- Decide on the action that has to be performed and refer to Carbonite's API references for the API details, such as the URL, headers, parameters, and other requirements.
- 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.
- Click Test and Save.
- A pop-up window will then display a list of AD users and groups on which to test the configured API call. Select the desired user or group on which this API request has to be tested and click OK. This will make a real-time call to the endpoint URL, and the selected objects will be modified according to the configuration.
- The webhook response and request details will then be displayed. Verify them for the expected API behavior and click Save.