- Overview
- Configuration
Appenate
Simplify Appenate form-builder access through automated account management.
Overview
Integrating Appenate with Active Directory through ADManager Plus enables seamless user identity management for organizations that rely on mobile workflows and field data collection.
This integration automates key lifecycle actions, such as user provisioning, access updates, and deprovisioning, eliminating manual overhead and reducing errors.This not only speeds up access delivery and revocation but also helps maintain data security and compliance. By bridging the gap between your centralized directory and Appenate’s mobile environment, the integration brings much-needed efficiency, accuracy, and control to workforce management.
Streamlined onboarding for field staff
Automatically create Appenate accounts in Active Directory during onboarding to grant access to mobile workflows and data capture tools.
Real-time access synchronization
Reflect user role changes from Active Directory in Appenate to ensure users have appropriate access levels across mobile apps.
Efficient offboarding
Automatically deactivate or delete Appenate accounts when employees leave the organization, minimizing security risks.
Configuration Document: Integrating Appenate with ADManager Plus
Prerequisites:
Please ensure to provide an API key with permissions to retrieve desired information and perform tasks in Appenate. Refer to Appenate's API references for more details.
Privileges:
- To import users from Appenate (Inbound action): Ensure the account used for authorization has permission to read all user accounts.
- To perform any action or query in Appenate (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 the Automation tab.
- In the left pane, under Configuration, click Application Integrations.
- Under Enterprise Applications, click Appenate.
- Toggle the Enable Appenate Integration button on.
- In the Appenate Configuration page, click Authorization.
- Perform the steps to generate the API Keys and API Token in Appenate.
- Replace {IntegrationKey} in value's field with the IntegrationKey value of your instance.
- Click Configure.
Inbound webhook configuration
Inbound webhook enables you to fetch user data from Appenate to ADManager Plus. To configure an inbound webhook for Appenate:
- Under Inbound Webhook, click Appenate Endpoint Configuration.
- In the Endpoint Configuration tab, an endpoint, Appenate GET USERS ENDPOINT, comes pre-configured with an Endpoint URL, API Method, Headers, and Parameters fields to fetch user accounts from Appenate. If you would like to use this pre-configured endpoint, replace {CompanyId} with the specific company ID in the parameter 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 Appenate'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.
- Refer to Appenate'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. Click Proceed. Note:
- Refer to Appenate's API references to know the Parameters that must be configured to fetch only specific parameters.
- You can configure multiple endpoints for Appenate 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 Appenate. [ADManager Plus also lets you customize attribute format from Appenate]
- 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 with the respective column in Appenate.
- If you would like to create a new custom format for this, click Mapping Attribute.
- Click Save.
Outbound webhook configuration
Outbound webhook enables you to update the changes made in AD using ADManager Plus to Appenate or fetch/forward required details from Appenate and synchronize them with AD. To configure an outbound webhook for Appenate:
- Under Outbound Webhook, click Appenate 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 Appenate's API references for the API details, such as the URL, headers, parameters, and other requirements that will be needed.
- Replace {IntegrationKey},{CompanyId} value with specific IntegrationKey value and company ID in the body message 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.
- Click Test and Save.
- A pop-up window will then display a list of AD users and groups to test the configured API call. Select the desired user or group over 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 as per the configuration.
- The webhook response and request details will then be displayed. Verify them for the expected API behavior and click Save.