How can I add a property for a user on JIRA cloud?

Vishal Vaswani September 25, 2019

I am using JIRA cloud instance and have followed instructions in https://confluence.atlassian.com/cloud/update-roles-and-properties-for-jira-users-744721647.html 

But, I do not see "Edit Jira properties" when I click on the  button to the right of "Login as user", this has been tried for a "Trusted" user and for an "Org & Site admin" user. 

Has the feature been removed for JIRA cloud users, this is required for one of the third party apps I use? 

2 answers

1 accepted

0 votes
Answer accepted
Dario B
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
September 26, 2019

Hi @Vishal Vaswani ,

This is a known issue tracked as:

As you can see this bug is currently in progress so you may want to vote for it and set yourself as a watcher to be notified on any progress.

In the meanwhile, you can use the workaround listed in the bug ticket description:

Workarounds

To access the User properties you can use this link:

  • https://<host>.atlassian.net/secure/admin/user/EditUserProperties.jspa?accountId=<id>

To access the Project roles you can use this link:

  • https://<host>.atlassian.net/secure/admin/roles/ViewUserProjectRoles.jspa?name=<username>

 

I hope this helps.

 

Cheers,
Dario

Vishal Vaswani September 27, 2019

Thanks @Dario B for your reply, 

https://<host>.atlassian.net/secure/admin/user/EditUserProperties.jspa?accountId=<id> 

does work BUT the property added using this method cannot be retrieved using API call like : 

https://<Host>.atlassian.net/rest/api/2/user/properties/<Key-I-Added>?username=<UserName> 

as I do not see any method to fetch username, so I tried  

https://<Host>.atlassian.net/rest/api/2/user/properties/<Key-I-Added>?accountId=<Account-Id>

and this returns 404 

{

errors: { },

errorMessages: [

"The property <Key-I-Added> does not exist."

],

httpStatusCode: {

present: true

}

}

 

Please suggest a fix. Thanks in advance. 

 

Regards 

 

Vishal 

Dario B
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
October 1, 2019

Hi @Vishal Vaswani ,

This is a common misunderstanding caused by the fact that the User Properties you set from the UI have the same name of the User Properties used by add-ons. We already have a Documentation request open asking to make some clarity on this:

As you can read in there:

The user properties that can be set via the user profile page and the user properties exposed in the JIRA REST API are actually two completely different storage mechanisms, which explains why user properties set from EditUserProperties.jspa are not returned when you call the REST API.

[...]to retrieve user properties using a GET request on /rest/api/2/user/properties, they must be set with a PUT to /rest/api/2/user/properties/{propertyKey}

We absolutely recognize the confusion that having two different sets of user properties can cause, and we intend to rectify this in the future.

 

Also, the exact same behavior you are facing was reported as a bug:

And, as you can see, it has been closed as "Invalid" with the below explanation:

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.

 

So, in order to summarize:

  1. The only user properties returned by sending a GET request to the /rest/api/{version}/user/properties endpoint are the one set by sending a PUT request to the /rest/api/{version}/user/properties/{propertyKey} endpoint (where {propertyKey} is the name of the property we are trying to set). 
  2. The User properties you set from the UI are some legacy user properties
  3. 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

 

I hope this explains.

 

Cheers,
Dario

KC Wong August 7, 2023

That free add-on is gone.

Vishal Vaswani January 9, 2023

Thanks @oscar rodriguez for suggestion :)

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events