- Overview
- Configuration
Sprout Solutions
Automate Sprout Solutions HR-to-IT data sync for smoother operations.
Overview
Integrating Sprout Solutions with Active Directory via ADManager Plus enables automated synchronization of employee lifecycle events between your HR platform and directory services. As user records are created, updated, or deleted in Sprout’s HR system, the corresponding AD accounts are automatically provisioned, adjusted, or offboarded. This seamless alignment eliminates manual data transfers, speeds up setup, ensures security consistency, and keeps HR and IT operations tightly in sync.
Automated onboarding
Instantly provision AD accounts with the correct roles and groups when new employees are added to Sprout.
Instant access updates
Reflect changes in department, position, or status in real time to maintain accurate AD permissions.
Secure and compliant offboarding
Automatically disable or remove AD access when users are offboarded in Sprout, reducing security risks.
Prerequisites:
Sprout uses OAuth 2.0 to authorize API requests. Please ensure to provide the client_id, client_secret, and Ocp-Apim-Subscription-Key to retrieve desired information and perform tasks in Sprout. Refer to the Sprout's API references page 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 Sprout (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 Sprout.
- Toggle the Enable Sprout Integration button on.
- In the Sprout Configuration page, click Authorization.
- Perform steps to generate client_id and client_secret from Sprout, and paste them in the respective value fields.
- Select Grant Type as Client Credentials.
- Click Configure.
Inbound webhook configuration
The inbound webhook enables you to get user data from Sprout to ADManager Plus and perform desired action available in Automation feature on them. To configure an inbound webhook for Sprout:
- Under Inbound Webhook, click Sprout Endpoint Configuration.
- In the Endpoint Configuration tab, an endpoint,
Sprout USERS ENDPOINT, comes preconfigured with an
Endpoint URL, API Method, Headers, and
Parameters fields to fetch user accounts from Sprout.
Replace Ocp-Apim-Subscription-Key, and set appropriate values for
CompanyId, DepartmentId, and LocationId in the endpoint configuration.
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 Sprout'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.
- Macros: You can add macros to your endpoint configuration to dynamically change it as per your requirement using the macro chooser component.
- Refer to Sprout'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 Sprout's API references to know the Parameters that must be configured to fetch specific parameters.
- You can configure multiple endpoints for Sprout 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 Sprout.
- 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 Sprout.
- If you would like to create a new custom format for this, click Mapping Attribute.
- Click Save.
Outbound webhook configuration
An outbound webhook enables you to send changes made in AD using ADManager Plus to Sprout and carry out tasks in Sprout—all from ADManager Plus.To configure an outbound webhook for Sprout:
- Under Outbound Webhook, click Sprout 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 Sprout'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.