- Overview
- Configuration
Deputy
Automate employee access management with Deputy and AD integration
Integrating Deputy with ADManager Plus enhances workforce management by automating identity and access management tasks across Active Directory, Exchange, Microsoft 365, and other business applications. When employee details, including name, department, role, and access requirements, are updated in Deputy, ADManager Plus can automatically execute these updates across connected systems, ensuring that user access remains current and aligned with organizational needs.
Role-based access control
Assign and update permissions for employees in Deputy based on their role changes in Active Directory
Error-free user management
Significantly reduces manual effort, minimizes errors, and ensures accurate and efficient user management processes, including user provisioning, updates, and deprovisioning.
Prerequisites:
Deputy uses OAuth2.0 to authorize API requests. You'll need to have the client_id and client_secret to retrieve desired information and perform tasks in Deputy. Refer to Deputy's API documentation for more details.
Privileges:
To import users from Deputy (inbound action): Ensure the account used for authorization has permission to read all user accounts.
To perform any action or query in Deputy (outbound action): Ensure the account used for authorization has permission to perform the desired action.
Note: ADManager Plus comes with a preconfigured set of APIs that help perform basic actions with the integration. If the action you require is not available, please gather the necessary API details from Deputy's API documentation to configure inbound or outbound webhooks to perform the required actions.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 Deputy.
- Toggle the Enable Deputy Integration button on.
- On the Deputy Configuration page, click Authorization.
- Enter the client_id and client_secret values generated in Deputy into the respective fields.
- Click Configure.
Inbound webhook configuration
Inbound webhooks enable you to fetch user data from Deputy and send it to ADManager Plus. The attribute mapping configured in this section can be selected as the data source during automation configuration to perform the desired action on the list of users received from the API response. To configure an inbound webhook for Deputy:
- Under Inbound Webhook, click Deputy Endpoint Configuration.
-
In the Endpoint Configuration tab, an endpoint, Deputy USERS ENDPOINT, comes preconfigured with Endpoint URL, API Method, Headers, and Parameters fields to fetch user accounts from Deputy. 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 Deputy's API documentation. Click here to learn how.
Note:
- The API key value pair 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 requirements using the macro chooser component.
- Refer to Deputy's API documentation 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 Deputy's API documentation to learn about the parameters that must be configured to fetch only specific parameters.
- You can configure multiple endpoints for Deputy 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 Deputy.
[ADManager Plus also lets you customize attribute format from Deputy.] -
Click + Add New Configuration and perform the following actions:
- 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 Deputy.
- If you would like to create a new custom format for this, click Mapping Attribute.
- Click Save.
Outbound webhook configuration
Outbound webhooks enable you to update the changes made in AD by sending the information from ADManager Plus to Deputy, or to fetch or forward required details from Deputy and synchronize them with AD. To configure an outbound webhook for Deputy:
- Under Outbound Webhook, click Deputy 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 Deputy's API documentation for the API details, such as URL, headers, and parameters.
- 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.