Is it possible to retrieve custom User Properties via REST API?

[xavier_sampietro]

Hi All,

I am trying to retrieve custom User Properties that have been set for the users in my Jira app.

I have set an ID with a specific number for each user, as following:

When trying the GET User Properties via REST API, I cannot find these custom keys and value.

When I get user properties via REST API, I get the following keys, but not my custom ID key.

'gh.boardSettings.2', 'growth-nux', 'jira_home_experiment_opted_in', 'jira.root.homepage', 'navigation_next_ui_state'

I have read in the following link that "This operation does not access the user properties created and maintained in Jira."

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties/#api-group-user-properties

And in the following link it explain how to maintain these keys:

https://support.atlassian.com/user-management/docs/update-roles-and-properties-for-jira-users/

Is it not possible to automate a process and get this piece of data? How could this be achieved?

Thank you in advance.

Best

[Earl McCutcheon · Accepted solution]

Hello @xavier_sampietro ,

Thanks for reaching out, and as you were suspecting in your question, the Rest API does not have the endpoint exposed for custom user properties, and this is summed up in a comment on the following Bug report, noting that the bug was closed out as invalid due to changes applied to the system for user management removing the legacy functionality:

- https://jira.atlassian.com/browse/JRACLOUD-59760

Dave Meyer added a comment - 20/Sep/2016 7:18 PM

Hi folks,

There is a free add-on for JIRA Cloud that provides the ability to edit user entity properties, which are accessible via the user entity properties REST API discussed on this issue. 

We know that one of the most common use cases for user properties is workflow automation. For that reason, add-ons like the new JIRA Misc Workflow Extensions add-on for JIRA Cloud have also implemented their own user interfaces for setting and managing user properties.

The reason we are not planning to expose a REST API for the legacy user preferences/properties that are currently not accessible via REST is that we are making a number of changes to how users are stored in Atlassian Cloud as we roll out Atlassian accounts. Unfortunately, migrating legacy user preferences to the new user entity properties available via REST is not straightforward.

Hope this helps.

Dave Meyer
Senior Product Manager, JIRA

Regards,
Earl

[Nicola D.]

Hello here an open-source example to set user/customer properties and retrieve them as smart value within Jira 

https://github.com/WuerthPhoenix/Atlassian-Extension-Scripts/tree/main/load-jsm-customer-ldap