Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,364,029
Community Members
 
Community Events
168
Community Groups

How can I get additional properties for group in Jira REST API?

Right now, I am using this API:
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-group-groups

API's create group (POST /rest/api/3/group) endpoint has parameter called "Additional properties". There were no examples how to use Additional properties parameter. I tried many ways of adding additional property to the group, but I could not get those properties. Getting single group via "GET /rest/api/3/group" or "GET /rest/api/3/group/member" does not return additional properties field. Also, "GET /rest/api/3/groups/picker" does not provide a way to use additional properties nor returns them with the group.

Using the same API, there is a something similar for users, using the Set user property (PUT /rest/api/3/user/properties/{propertyKey}) and Get user property (GET /rest/api/3/user/properties/{propertyKey}) endpoints, but there is no such endpoints for groups.

While using Atlassian Administration web page, it is possible to create a group and give it description text. There is a text box for it.

There is an endpoint in another API that is capable of returning group description:
https://admin.atlassian.com/gateway/api/adminhub/um/org/{orgID}/groups/{groupID}

But this API endpoint is not official, not documented and may change over time, as similar endpoint is explained in this issue:
https://jira.atlassian.com/browse/JRACLOUD-72942

Is there any other way of getting and setting additional properties for group, group description or any workaround (like in the given example regarding users) to achieve addition of one more field in the group?

1 answer

Hello @Dragan Jovic 

This question has come up many times. In the v3 REST API documentation, the reference to 'Additional Properties' parameters is errata. It is probably a placeholder for future functionality.

Apart from users (members of the Group), Groups have only a name and a description. There are no additional or hidden 'properties' or 'fields' for Groups that you can put abstract information into.

  1. You can get or set the name of a Group via the REST API or the GUI.
  2. You can't get or set the description of a Group via the REST API, only via the GUI.

Suggest an answer

Log in or Sign up to answer
TAGS

Atlassian Community Events