• 525
    • 4
    • We collect Confluence feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      Summary

      As a Confluence System Administrator I would like to be able to manage users and groups directly from REST API endpoints. Automation and scripting of user management can be made easier with REST API.

      Problem statement

      User and groups management is currently not possible via REST API only. Bulk operations, automation or scripting of management actions is not currently possible when using REST API. User management was previously possible with SOAP, which has been deprecated.

      Suggested Resolution

      Provide methods akin to what as present with SOAP that would allow Admins to manage users and groups via REST API.

       

       

       

      Previous Ticket Description
      As Confluence is popular tool used by many users, it should provide the API to add users to groups, similar to what Jira Cloud has.

            [CONFSERVER-56205] Provide REST API methods to manage users and groups

            Group creation works fine with a POST to /rest/api/admin/group. Oddly enough, in my code, I also specify type='group', not just the group name. Wonder if the schema has changed along the way, but it works.

            Creating users seems to have found its way to 8.4.0, I'll need to take a look at that. Updating still has no method, voting for that PUT...

            Janne Korkkula added a comment - Group creation works fine with a POST to /rest/api/ admin /group. Oddly enough, in my code, I also specify type='group', not just the group name. Wonder if the schema has changed along the way, but it works. Creating users seems to have found its way to 8.4.0, I'll need to take a look at that. Updating still has no method, voting for that PUT...

            David Weiss added a comment - - edited

            Hey community,

            can someone verify that creating groups via API works? Unfortunately the POST Method seems to get stuck during authentication while the GET Method works as expected.

            We are currently running a Confluence Data Center instance on version 8.6.1

            #____________________________________________________________________________________
             

            #URL to our Instance
            $URL = "https://link-to-our-confluence/rest/api/latest/group"

            #Auth Token got created using my Confluence admin Account
            $BearerToken = "My-Bearer-Token" 
             
             # Set up headers for the request
             $Headers = @

            {   "Authorization" = "Bearer $BearerToken"   "Content-Type" = "application/json"    }

             # Define the JSON data for creating the group
             $jsonData = @

            {      "name" = "NewConfGroup"   }

            | convertto-Json
             
             Invoke-RestMethod -Uri $URL -Method Post -Headers $headers -Body $jsonData

             
            #____________________________________________________________________________________
            This is the error i am getting: "The remote server returned an error: (405) Method Not Allowed."

             

            thanks in advance!

            David Weiss added a comment - - edited Hey community, can someone verify that creating groups via API works? Unfortunately the POST Method seems to get stuck during authentication while the GET Method works as expected. We are currently running a Confluence Data Center instance on version 8.6.1 #____________________________________________________________________________________   #URL to our Instance $URL = "https://link-to-our-confluence/rest/api/latest/group" #Auth Token got created using my Confluence admin Account $BearerToken = "My-Bearer-Token"     # Set up headers for the request  $Headers = @ {   "Authorization" = "Bearer $BearerToken"   "Content-Type" = "application/json"    }  # Define the JSON data for creating the group  $jsonData = @ {      "name" = "NewConfGroup"   } | convertto-Json    Invoke-RestMethod -Uri $URL -Method Post -Headers $headers -Body $jsonData   #____________________________________________________________________________________ This is the error i am getting: "The remote server returned an error: (405) Method Not Allowed."   thanks in advance!

            Tobias added a comment - - edited

            Opened a new suggestion for providing a PUT method for the user endpoint: CONFSERVER-93140

            Tobias added a comment - - edited Opened a new suggestion for providing a PUT method for the user endpoint: CONFSERVER-93140

            Tobias added a comment -

            First of all thanks for providing methods for the usermanagement and group management. 

            But why is there no method to update a user? Pls tell me if there will be a future deployment scheduled which includes this method. 

            Best

            Tobias 

            Tobias added a comment - First of all thanks for providing methods for the usermanagement and group management.  But why is there no method to update a user? Pls tell me if there will be a future deployment scheduled which includes this method.  Best Tobias 

            There is still no method to create a user. The older API was "deprecated" long ago, but it's still the only functional way to manage internal directory users!

            Janne Korkkula added a comment - There is still no method to create a user. The older API was "deprecated" long ago, but it's still the only functional way to manage internal directory users!

            A fix for this issue is available in Confluence Server and Data Center 8.2.0.
            Upgrade now or check out the Release Notes to see what other issues are resolved.

            Yaroslava Derkach (Inactive) added a comment - A fix for this issue is available in Confluence Server and Data Center 8.2.0. Upgrade now or check out the Release Notes to see what other issues are resolved.

            Hi 028a7e4a38d5,

            Thanks for your question. Unfortunately, this is a fairly significant feature that's been delivered onto our 8.x platform release targeting 8.2 we are currently not looking to backport the functionality. This is because in order to ensure the stability of our LTS releases we generally only backport non-platform breaking bug fixes.
            More details on our backport policy can be found on our bugfix documentation here. We are currently planning our next LTS which will likely be shipping later this year, this will include the REST API work for users and groups along with all the other features and fixes shipped in Confluence since the 7.19 LTS. I'm sorry this may not have been the answer you were looking for, but I hope I've shed some light on our process and how we need to keep our LTS stable by minimising major changes to it.

            Warm Regards.

            Michael Andreacchio
            Confluence DC PM

            Michael Andreacchio added a comment - Hi 028a7e4a38d5 , Thanks for your question. Unfortunately, this is a fairly significant feature that's been delivered onto our 8.x platform release targeting 8.2 we are currently not looking to backport the functionality. This is because in order to ensure the stability of our LTS releases we generally only backport non-platform breaking bug fixes. More details on our backport policy can be found on our bugfix documentation here . We are currently planning our next LTS which will likely be shipping later this year, this will include the REST API work for users and groups along with all the other features and fixes shipped in Confluence since the 7.19 LTS. I'm sorry this may not have been the answer you were looking for, but I hope I've shed some light on our process and how we need to keep our LTS stable by minimising major changes to it. Warm Regards. Michael Andreacchio Confluence DC PM

            We recently migrated to 7.19.5. We are also looking for this feature. Is there a patch Atlassian provides to make this work in our version ?

            Raghavendra Amara added a comment - We recently migrated to 7.19.5. We are also looking for this feature. Is there a patch Atlassian provides to make this work in our version ?

            Niranjan added a comment -

            Hi @James,

            Will this feature be backported to 7.19.7 ? We are planning to upgrade from 7.13 to 7.19 which is the next available LTS version. 

            Niranjan added a comment - Hi @James, Will this feature be backported to 7.19.7 ? We are planning to upgrade from 7.13 to 7.19 which is the next available LTS version. 

            Sake added a comment -

            Sake added a comment - It looks like it's coming in 2023; https://www.atlassian.com/wac/roadmap/data-center/rest-api-user-management?status=comingSoon&product=confluence&p=05ac5e43-1d

              jwhitehead@atlassian.com James Whitehead
              pkamarudin@atlassian.com Putri Nur Dayana Kamarudin (Inactive)
              Votes:
              298 Vote for this issue
              Watchers:
              197 Start watching this issue

                Created:
                Updated:
                Resolved: