Uploaded image for project: 'Confluence Cloud'
  1. Confluence Cloud
  2. CONFCLOUD-69909

Addition of a field in REST user response objects to indicate status

    XMLWordPrintable

Details

    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

    Description

      Issue Summary

      The shape of the user objects in the response to /wiki/rest/api/group/{groupName}/member does not include a field to indicate the status of the user (active, deactivated, system, ???).

      Steps to Reproduce

      1. Log in to a Confluence tenant
      2. Change the path of the ULR to /wiki/rest/api/group/confluence-users/member

      Expected Results

      The returned JSON includes a field "status" which identifies the user's status as per a documented enum of user statuses.

      Actual Results

      No such field is returned. Some app developers may be tempted to interpret the user's status from a suffix that Confluence adds to the displayName field. Examples are Foo (Unlicensed) and Bar (System).

      Workaround

      Adding ?expand=operations to the query will include the operations allowed by the user and may help some apps distinguish users as per their requirements, but this workaround may not satisfy all app use cases.

      Other REST API Responses Containing User Objects

      There may be other REST resources that return user objects. It seems reasonable and preferable to enhance those APIs with status information as per the member resource identified above.

      Attachments

        Activity

          People

            Unassigned Unassigned
            dmorrow@atlassian.com Dugald Morrow
            Votes:
            1 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: