This script creates users in a Jira Service Desk instance from an LDAP query.
The script creates users with their email set to the mail LDAP attribute, and the name 'sn, givenName'.
The script prints status information and errors to stderr and the emails for the accounts it imports, one per line, to stdout.
It is only tested with Jira Service Desk cloud.
Cut from the same cloth as jps-people-importer.
To use jsd-people-importer, you will need Python3 and pipenv installed.
To install Python3 on macOS, download the pkg from https://www.python.org/downloads/. Once you've run and installed the pkg, find "Python 3.x" in your Applications directory and run the Update Shell Profile.command file, then the Install Certificates.command file.
To install Python3 on Windows, download its installer from https://www.python.org/downloads/. While installing, check the option to add Python to your PATH. Once the installation completes, reboot your computer so Python can be run from a command prompt.
Pipenv is used to install the dependencies for jsd-people-importer and keep them separate from any other Python projects on your computer. To install pipenv, run the following command in a terminal or command prompt:
pip3 install --user pipenv
You can download the script and its example configuration by selecting "Download ZIP" under the Clone or Download menu, clicking this link, or cloning it with git.
To start, copy conf.py.example to conf.py.
Then, you may either edit the conf.py file to enter your desired values (replacing the environ[...] portions of the configuration) or set the values in your shell environment before running the script.
To set the configuration environment variables under most shells, type export VARIABLE_NAME=value, where VARIABLE_NAME is the part within quotes in the conf.py script. For example, to provide LDAP_FILTER to the script exclusively from the environment, type:
export LDAP_FILTER='(&(mail=*)(sn=*)(givenName=*))'
Under a Windows shell, replace export with set.
Unless otherwise specified in this section, the environment variable used to set a configuration option uses the same name as the configuration option itself. LDAP_FILTER in the config file can be set as LDAP_FILTER in the environment, for example.
This filter is run against each LDAP DN in the LDAP_SEARCH_DN_LIST to retrieve a list of users to add to Jira. "(&(objectcategory=person)(objectclass=user))" should retrieve only the user objects in an Active Directory domain.
This list contains all of the base-level objects that you would like to search for users within. One search (filtered by LDAP_FILTER) will be initiated for each object in this list. For example, suppose your Active Directory domain is located at mydomain.tld and you would like to search the OUs "Students" and "Staff" for users. In this case, you would enter:
LDAP_SEARCH_DN_LIST = [
"OU=Students,DC=mydomain,DC=tld",
"OU=Staff,DC=mydomain,DC=tld",
]A single search DN may be specified in the environment as LDAP_SEARCH_DN
This URI points to your LDAP server. For an Active Directory domain, you probably want to use 'ldaps://mydomain.tld:636'.
If you use 'ldaps://' and you do not use a valid certificate for your LDAP server, set LDAP_INSECURE to True. Certificate checking for your LDAP server will occur if LDAP_INSECURE is set to False. It is False by default.
This value may be specified in the environment as LDAP_INSECURE. If it is set to 1, LDAP_INSECURE is considered True. If it is unset, LDAP_INSECURE is set to False.
These values specify the username and password used to bind to your LDAP directory. For an Active Directory domain, you will probably use mydirectory\username for LDAP_BIND_USERNAME.
This URL points to the base of your Jira instance. For example, https://mycompany.atlassian.net.
These values specify the username and API key used to sign in to Jira. The user account must have Service Desk Administrator and Administer Jira permissions.
Change into the script's directory. With the script configured and its dependencies installed, it can be run with:
pipenv install --three
pipenv run python ./jsd-people-importer.py