nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Getting all of the users in Jira v10+ through the API

Erazem Kos

Hi, I want to get all of the users using the Jira Data Center through the rest API for an integration I am developing. I saw that Jira 10 has this limitation. This lead me to trying the following - 1. get all application roles, 2. get the one that has the key "jira-software" and 3. get all of the members of child groups. Will this get all of the users of the Jira DC? Will this key always remain the same, regardless of the language Jira is in or something, or can it be edited?

Accepted answers

All comments

Carlos Garcia Navarro

Hi @Erazem Kos ,

The limitation that you pointed out includes a workaround as well. Would that work for your use case?

Workaround

Use Username Filters to Fetch Subsets of Users
By applying filters to the username parameter, you can retrieve smaller subsets of users and manually aggregate the results. For example:
```
https://{baseurl}/rest/api/2/user/search?username=a*&startAt=0&maxResults=100
```
Query the Jira Database Directly
If direct access to the Jira database is available, the customer can query the cwd_user table to retrieve all users. Example query:
```
SELECT user_name, display_name, email_address
FROM cwd_user
WHERE active = 1
ORDER BY user_name ASC
LIMIT 100 OFFSET 0;
```

Erazem Kos

No I will not have direct access to the database, so that is out of the question for my use case. The subsets approach is very tough as I don't know how many total users there will be. So for example querying with "a" could match more than 100 users, and then I need to produce sub-queries and deduplicate etc.

Will my proposed solution not get all of the users?

Evgenii Isaenkov

Hi, @Erazem Kos

You don't need to perform any deduplication.

When you have more than 100 users, you'll need to use pagination. Simply retrieve and parse the user list page by page until you've fetched all results.

Erazem Kos

But that pagination is not working for Jira 10. It gets truncated to 100 users - talking about the v2 user/search API that I linked to in the original post.

Christian Bär

With Jira 11.0.0 and 10.13.3 (LTS) backported there is a new option with REST.

See https://jira.atlassian.com/browse/JRASERVER-78660
and https://developer.atlassian.com/server/jira/platform/rest/v11002/api-group-user/#api-api-2-user-list-get

Max results is 2000 but you have a new pagination:

With the first call to /rest/api/2/user/list

you get a cursor with the result given as nextCursor or as full url in nextPage like so:

/rest/api/2/user/list?cursor=&maxResults=2000

If no nextPage or nextCursor attribute in the result there are no more users to fetch.

Cheers,
Christian

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

jira

jira-data-center

data-center