Uploaded image for project: 'Identity'
  1. Identity
  2. ID-8308

Add query parameter to return suspended users in Find Users API

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Unresolved
    • Directory - APIs
    • None
    • 8

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

    • Jira Software

      Find users API does not return suspended users and there is no way to retrieve accountId from these users to manage the lifecycle programmatically if the user is suspended.

      Example: <site>.atlassian.net/rest/api/3/user/search?query=<user_display_name>

      Can we add another query parameter to include suspended users in the find users API?

      The only way to get suspended users is by calling 'Get all users' API but it does not have a query parameter and multiple calls are needed if you have 1k+ users.

      At the Org level, there is an experimental API to restore/suspend users, but accountId is also needed and the 'Get users in the organization' API does not have a query parameter either.

      Find users: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search/#api-rest-api-3-user-search-get 

      Suspended users: https://support.atlassian.com/user-management/docs/remove-or-suspend-a-user 

      Get all users: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get 

      Org suspend users:  https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v1-orgs-orgid-directory-users-accountid-suspend-access-post 

      Org get users in the organization: https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v1-orgs-orgid-users-get 

            [ID-8308] Add query parameter to return suspended users in Find Users API

            Parikshit Chaudhary added a comment -

            We have 2 sites, each with 6 products, as well as numerous groups and users. We are currently required to manually remove users from each group and product, which is a very time-consuming task. One of our groups has approximately 1200 users, and we have multiple groups to manage. Manually removing suspended and deactivated users from each group is both tedious and laborious. This task needs to be performed every 3 months.

             

            We request that this feature be given high priority. We would like to receive the details of suspended and deactivated users via the below REST API, or alternatively, have a separate REST API created for this purpose.

             

            Here is the link to the REST API: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-group-member-get

            Parikshit Chaudhary added a comment - We have 2 sites, each with 6 products, as well as numerous groups and users. We are currently required to manually remove users from each group and product, which is a very time-consuming task. One of our groups has approximately 1200 users, and we have multiple groups to manage. Manually removing suspended and deactivated users from each group is both tedious and laborious. This task needs to be performed every 3 months.   We request that this feature be given high priority. We would like to receive the details of suspended and deactivated users via the below REST API, or alternatively, have a separate REST API created for this purpose.   Here is the link to the REST API: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-group-member-get

              2015ae912494 Stefan Scorse
              171374dfd069 Wagner Santos (Inactive)
              Votes:
              12 Vote for this issue
              Watchers:
              11 Start watching this issue

                Created:
                Updated: