Updating Data post function

Learn how to make changes in your Active Directory right from within Jira

Active Directory Attributes Sync provides an additional post function called Update Data. This post function allows you to perform several actions directly on your LDAP server:

• Create user in AD
• Add user to AD groups
• Update user’s attribute in AD
• Reset user password in AD
• Disable/enable user account in AD
• Remove user from AD group

Adding post function

Steps

To add the Update Data post function:

1. Navigate to Project settings > Workflows.
2. Select the workflow you’d like to update and click Edit.
3. Go to the Diagram view or Text view and click on the chosen transition.
4. Open Post Functions settings from the right-hand side menu.
5. Click Add post function.
6. Select Deviniti [Active Directory Attributes Sync] - Update Data post function.
7. Click Add.

   

8. Select the Connection.
9. Select the Action.

   

10. Set the necessary parameters for the chosen action (see the relevant table in the description of your selected action).
11. Click Save.
12. Remember to Publish the changes.

    

Result

The Update Data post function has been added to your workflow.

Comment settings

The post function Update Data can also add comments to issues after every operation on your AD. It shows a confirmation when a change has been made or errors when the operation hasn’t been executed successfully.

You decide whether the comments should appear in the Customer Portal or only internally. You can also turn this function off so that no comments are generated.

You can set it up while adding the post function to a workflow. Choose one of these three options:

1. Internal: A comment will only be added to the Jira issue, so if reporters use the Customer Portal, they won’t be able to see the comments.
   
2. Public: The comment will be visible in Jira but also in the Customer Portal so the reporters will be able to track the progress of their request.
   
3. Disabled: Comments won’t appear in the comments section, either in the Jira issue view or in the Customer Portal.

Create user in AD

Using the Update Data post function, you can create new users in your AD directly from Jira.

Steps

To create a user in AD:

1. Add the post function to your workflow.
2. Select Create user in AD as the Action.
3. Configure the parameters described in the below table.
4. If you wish, add additional attributes.

Table: List of parameters for Create user in AD

Result

When an issue passes the selected transition, the chosen custom fields allow for creating a user in AD.

Add user to AD group

This post function mode allows for:

• adding a user to one AD group
• adding multiple users to one or more AD groups using a User Picker (multiple users)
• adding users to multiple existing AD groups that can be selected with a Group Picker (multiple groups) or typed in manually in a Text field
• creating a new AD group and adding users to it in a single step

Adding users to existing groups

Steps

To add users to AD groups:

1. Add the post function to your workflow.
2. Select Add user to AD group as the Action.
3. Configure the parameters described in the below table.

Table: List of parameters for Add user to AD group

Possible configurations

Creating users and adding them to AD groups simultaneously

The Create user in AD mode allows you to create and add users to AD groups in a single transition. This is the standard and most straightforward use case.

Steps

To create new users and add them to AD groups immediately:

1. Add the post function in the Create user in AD mode to your chosen transition.
2. Check the box next to Add user to group.
3. Choose the custom field for the AD group name from the Source value select list.

Result

When the post function is executed, a new user is created and added to the chosen AD group.

Creating users first and adding them to AD groups later

If you want to add users to AD groups at a different point than creating them, you will need to add the post function in the Create user in AD mode first and then add it again in the Add user to AD group mode to a later workflow transition.

Steps

Here’s the actual workflow needed for this scenario to work:

1. The post function is executed in the Create user in AD mode.
2. The Jira User Directory is synchronized with AD (a Jira user is created). You can do so under User management > User Directories:

   

3. The connection is synchronized under Active Directory Attributes Sync > Connections, to connect the new Jira user with the app:

   

4. The post function is executed in the Add user to AD group mode.

Result

A new user is created when the post function is executed. Then, in a different transition, the user is added to AD group.

Creating a new AD group

With this post function mode, you can also create a new AD group and add users to it simultaneously. The necessary configurations steps are explained in the table below:

Result

Selected users can be added to selected (or newly created) AD groups.

Adding user from a custom field

There are three Jira fields that you can use to determine which user should be added to a group:

• Assignee
• Reporter
• Current user

If the user you’d like to add doesn’t match any of the options above, you can use a custom field.

Steps

To add a user from a custom field:

1. Create a Text Field (single line) custom field.

2. Type in the word Username as the custom field’s name (or choose a different one that will be easy to find)

   

3. Add the post function Deviniti [Active Directory Attributes Sync] - Update Data > Add user to AD group to your project’s workflow.

4. Select the Username custom field from the drop-down list next to Affected user.

   

5. Type the user’s AD username into the text field in the issue view.

Result

The selected user is added to the chosen AD group.

Update user’s attribute in AD

Steps

To update a user’s attribute in AD:

1. Add the post function to your workflow.
2. Select Update user’s attribute in AD as the Action.
3. Configure the parameters described in the below table.

Table: List of parameters for Update user’s attribute in AD

Reset user password in AD

Steps

To reset the user’s Active Directory password:

1. Add the post function to your workflow.
2. Select Reset user password in AD as the Action.
3. Configure the parameters described in the below table.

Table: List of parameters for Reset user password in AD

Disable/Enable user account in AD

Steps

To disable or enable user’s Active Directory account:

1. Add the post function to your workflow.
2. Select Disable/enable user account in AD as the Action.
3. Configure the parameters described in the table below.

Table: List of parameters for Disable/enable user account in AD

Remove user from AD group

Steps

To remove a user from an Active Directory group:

1. Add the post function to your workflow.
2. Select Remove user from AD group as the Action.
3. Configure the parameters described in the below table.

Table: List of parameters for Remove user from AD group

Unlock user account in AD

This operation allows you to unlock an AD account that has been locked, for example after a user provides a wrong password too many times.

Steps

To be able to unlock a user account in Active Directory:

1. Add the post function to your workflow.
2. Select Unlock user account in AD as the Action.
3. Configure the parameters described in the below table.

Table: Unlock user account in AD