How to export userKey values to CSV or similar?

[Jess Johns]

Given that userKeys need to be used in place of userId for JIRA cloud, is it possible to export a user list with all the unique userKeys listed as part of the file? The regular export function does not show this data in its fields. 

[Andy Heinzer · Accepted solution]

Hi Jess,

Could you clarify what you mean by userkey here?  My understanding is that this was the value that Jira would use for a user account when it is first created in Jira.  And if a user account was renamed, Jira could change that user account's name/email/etc and use this user_key value as a means to track account changes.  Which is beneficial for tracking historical changes to issues/edits/etc.

However Jira Cloud recently implemented some major changes to the REST APIs in regards to user account privacy, see Deprecation notice and migration guide for major changes to Jira Cloud REST APIs to improve user privacy.   In which case, I would instead expect that you would be looking for the user's accountId value.

I'm still not sure there is a way to gather what you want here, but perhaps you can tell us more about the use case here and what you are trying to do so that we can get a better picture of the problem.

Thanks

Andy

[Jess Johns]

There seems to now be a value in JIRA Cloud called "userKey" that is a UUID. From what I've read in the documentation this is an identifier that cannot be changed, and will always reference one particular user account. (Whereas an email address, full name, or userId can be changed)

The intent here is mainly to work with conjunction with the JIRA CLI that requires userKey now instead of a more generic userId (information that is exportable from the JIRA web interface)

I believe I have found a solution using the CLI, but was curious if there is a way to do this in the web interface as well. 

For reference, the CLI command I used to export the UUID (userKey) values was the following:   

jira.sh --action getUserList --name "@all" --outputFormat 2 > jira_users.csv

The "--outputFormat 2" here is the important part here to get the UUIDs to print out. This prints a comma separated list with Group, User, Key, Name, Email, Time Zone, Avatar URL, Active status, and Group membership.

[Andy Heinzer]

Hi Jess,

Thanks for explain in more detail here.  I have not been able to find a clear way to export this data from a Jira Cloud site today.  If this was Jira Server, this is something you could lookup via a SQL query, but that's not an option in the Jira Cloud platform.

There does not seem to be a way to do this via the web interface. While there are some REST API endpoints that can still return this info, they tend to be bound to search results, or individual account lookups.  There doesn't appear to be a way to gather all these userkey values from all accounts in a Jira Cloud site at this time. 

[Jess Johns]

Thanks kindly Andrew for looking into this.