Uploaded image for project: 'Confluence Data Center'
  1. Confluence Data Center
  2. CONFSERVER-37100

REST API to retrieve users counting towards Confluence license

    • 7
    • 6
    • 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.

      NOTE: This suggestion is for Confluence Server. Using Confluence Cloud? See the corresponding suggestion.

      It would be great if there is an REST API that could return

      • the number of users counting towards Confluence license
      • the usernames of those being counted towards Confluence license (workaround: use debug logging as per CONFSERVER-58875)

      This will allow administrators to easily keep track of the users that is counting towards the license and also to allow for easy monitoring of Confluence server user counts.

      As noted in the comments below, a REST API is available to query this information:

      /rest/license/1.0/license/userCount 
      /rest/license/1.0/license/remainingSeats 
      /rest/license/1.0/license/maxUsers
      

      A new REST API has been in added in Confluence 7.1 that allows for the querying of even more details (license expiry date, subscription details etc):

      /rest/license/1.0/license/details

      A REST endpoint has been added to Confluence 9.3 which returns active users sorted on last login time (ascending):

      /rest/api/user/list/active
      

       

          Form Name

            [CONFSERVER-37100] REST API to retrieve users counting towards Confluence license

            Christian Solle added a comment -

            Is there any open request for the missing informations (compared to component license details) or jira license?
            Aktually I am struggeling about the missing SEN as this is the unique identifier for an license, I have no clue why that is not included...

            Christian Solle added a comment - Is there any open request for the missing informations (compared to component license details) or jira license? Aktually I am struggeling about the missing SEN as this is the unique identifier for an license, I have no clue why that is not included...

            The user count should be in the API call results, having to do debug logging stuff is ridiculouis.

            Jason D Smith added a comment - The user count should be in the API call results, having to do debug logging stuff is ridiculouis.

            @Monique, if I understand you this new undocumented REST endpoint returns a number not a list of users?

            In that case, I wouldn't consider this issue resolved.

            Anders Lantz added a comment - @Monique, if I understand you this new undocumented REST endpoint returns a number not a list of users? In that case, I wouldn't consider this issue resolved.

            Hi Everyone, just to clarify, API for "number of users counting towards Confluence license" is now available as mentioned by mbereznitsky.
            As for listing users that count towards the license, please use the debug logging as mentioned in this KB: How to log a list of licensed users - Atlassian Documentation

            Monique Khairuliana (Inactive) added a comment - Hi Everyone, just to clarify, API for "number of users counting towards Confluence license" is now available as mentioned by mbereznitsky . As for listing users that count towards the license, please use the debug logging as mentioned in this KB: How to log a list of licensed users - Atlassian Documentation

            Zac Xu added a comment -

            Hi anders.lantz220570582 I reported it to team. It might be part of the auto generated confluence REST API doc at some point in the future.
            https://docs.atlassian.com/ConfluenceServer/rest/7.1.0/

            Zac Xu added a comment - Hi anders.lantz220570582 I reported it to team. It might be part of the auto generated confluence REST API doc at some point in the future. https://docs.atlassian.com/ConfluenceServer/rest/7.1.0/

            @zac It might be implemented but I´m having a hard time finding the documentation for it?

            Anders Lantz added a comment - @zac It might be implemented but I´m having a hard time finding the documentation for it?

            Zac Xu added a comment -

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

            Zac Xu added a comment - A fix for this issue is available to Server and Data Center customers in Confluence 7.1.0 Upgrade now or check out the Release Notes to see what other issues are resolved.

            As noted in the previous comments, a REST API is available to query this information:

            /rest/license/1.0/license/userCount 
            /rest/license/1.0/license/remainingSeats 
            /rest/license/1.0/license/maxUsers
            

            A new REST API has been in added in Confluence 7.1 that allows for the querying of even more details (license expiry date, subscription details etc):

            /rest/license/1.0/license/details
            

            Mark Bereznitsky added a comment - As noted in the previous comments, a REST API is available to query this information: / rest /license/1.0/license/userCount / rest /license/1.0/license/remainingSeats / rest /license/1.0/license/maxUsers A new REST API has been in added in Confluence 7.1 that allows for the querying of even more details (license expiry date, subscription details etc): / rest /license/1.0/license/details

            Hi Abdul!

            Not off the top of my head, but give this add-on a try and make sure to uncheck "show only public APIs" or something similar close to the search box.

            https://marketplace.atlassian.com/apps/1211542/atlassian-rest-api-browser?hosting=server&tab=overview

             

             

            Anders Lantz added a comment - Hi Abdul! Not off the top of my head, but give this add-on a try and make sure to uncheck "show only public APIs" or something similar close to the search box. https://marketplace.atlassian.com/apps/1211542/atlassian-rest-api-browser?hosting=server&tab=overview    

            Hi @Anders Lantz Thanks alot.

            Any suggestion about Endpoint to get maintenanceExpiryDate and SupportEntitlementNumber from License.

            Abdul Rehman added a comment - Hi @Anders Lantz Thanks alot. Any suggestion about Endpoint to get maintenanceExpiryDate and SupportEntitlementNumber from License.

              mbereznitsky Mark Bereznitsky
              dooi Der Lun
              Votes:
              38 Vote for this issue
              Watchers:
              35 Start watching this issue

                Created:
                Updated:
                Resolved: