Migrating users between user directories
Organizations will often migrate to or from LDAP engines, such as Active Directory or OpenLDAP, as they grow or acquire new companies, and need to migrate users into the same LDAP engine. As changes occur outside of JIRA, they will also need to be reflected within the JIRA user directories:
- JIRA can have multiple user directories (e.g. JIRA Internal, Delegated LDAP, LDAP Connector).
- The difference between the two is a connector will periodically synchronize user details against LDAP and can add/delete users and groups during that process. A delegated directory can only add users/groups upon the user's first login.
You can easily identify this by looking for the Synchronize option.
- Each directory will have unique users, groups and group memberships. This means there can be multiple users of the same username with different group memberships.
- Project Roles are global across all user directories.
- If you have the same user in multiple directories, the effect of directory order will apply. This means that if you add a new user directory and then change the order, so it is before your existing directory, your users will be selected from that directory first.
- When deactivating a user in LDAP, it will be deactivated in JIRA.
- When deleting a user in LDAP, it will be deleted in JIRA if it is not needed, or deactivated if it is (e.g. the user has comments).
- You can set up a User Directory with different permissions settings that will allow you to administer the groups in either LDAP, JIRA, or both.
This guide describes how to migrate users between the different user directories, as described in Configuring user directories. You will need to log in as a user with the 'JIRA System Administrators' global permission to access the Settings menu.
On this page:
Using the 'migrate users from one directory to another' functionality
This functionality allows for the following scenarios:
- Migrate all users from JIRA Internal to Delegated LDAP
- Migrate all users from Delegated LDAP to JIRA Internal
- Migrate all users from Delegated LDAP to Delegated LDAP
However, it cannot be used for any of the following scenarios:
- Migrating a specific set of users or one single user from one directory to another
- Connector user directories — these can be easily identified, as they have a Synchronize option
- Migrating groups only
- Migrating users without their groups
It also has the following features:
- If you, the currently logged-in user, are in the directory to be migrated from, your user data will not be migrated.
- Users and groups will not be migrated if they already exist in the target directory. For example, consider a user that exists in JIRA Internal and JIRA Delegated LDAP but has different groups in JIRA Internal: when migrating from JIRA Internal to the JIRA Delegated LDAP, that user will be skipped and the groups will not be migrated.
To migrate users:
- If the username needs to be changed as part of the migration, rename them (see Managing users for instructions).
- Choose > User Management.
- Choose User Directories.
- Choose Additional Configuration & Troubleshooting (section) > Migrate users from one directory to another.
- This option will not appear if there are no valid directories to migrate from/to.
- Select the from and to directories and migrate the users:
- You will be shown a message telling you whether the migration was successful or not. In these example screenshots, only 61 out of 62 users could be migrated, as the user doing the migration was logged into the JIRA Internal Directory.
Migrating users by changing the directory order
This method is only applicable if moving users from the JIRA Internal Directory into an LDAP Connector and when LDAP will manage all their groups. Migrating users in this method will not move across any groups as the groups are separate from the JIRA Internal Directory to the LDAP Connector.
- Add the LDAP Connector, as detailed in Connecting to an LDAP directory.
- Move the new user directory, so that it is ordered before the JIRA Internal Directory:
When users login, they will login to the LDAP Connector rather than the JIRA Internal Directory provided the usernames are identical.
Migrating users manually
If the user migration does not fall into the above scenario, you can migrate users by modifying the database. See this knowledge base article for instructions on how to do this: Migrate local group memberships between directories. When JRA-27868 - Migrating users from one directory to another (part 2) Open is completed, JIRA will handle this in product.
Was this helpful?
Thanks for your feedback!