Delete teams from Atlassian Cloud using Postman and REST APIs

Still need help?

The Atlassian Community is here for you.

Ask the community


Platform Notice: Cloud Only - This article only applies to Atlassian products on the cloud platform.

When to use this article

This article may be used any time there is a need to delete teams in bulk from Atlassian Cloud. For example, after testingmigration to Atlassian Cloud, it may be necessary to delete many teams from the organization to retest.



Prepare data

  1. Follow the steps in Exporting Atlassian Teams and Members data from my Organization to obtain a list of all teams.
  2. Using a spreadsheet program or text editor, remove columns I onwards. This leaves a csv file with eight columns.
  3. Review the spreadsheet and remove all rows (teams) that should not be deleted.
    (warning) Care should be taken as team names are not distinct and may be duplicated.
  4. Update the contents of A1 to teamId (case-sensitive).
  5. Save the csv, now containing a list of all teams to be removed.

The CSV should now resemble:


ABC
1teamIddisplayName...
​2​4fac65bb-00b7-448c-xxxx-6ef06ca98352​Platform CORE...
3be81dfc7-2527-4a79-xxxx-42b4f123bc12Transformers...
4150d846f-8a0d-44ac-xxxx-f8b35506d16bBusDev...

Set up Postman

This section may be skipped if:

  • a collection named "Atlassian Cloud User Management" has previously been set up, and

  • an environment named "Atlassian Cloud" has previously been set up

Click here for instructions to set up Postman

Download Postman

  1. Download Postman from https://www.postman.com/downloads/

  2. Run Postman.

Create a new environment

  1. Click New, or type Ctrl + N (Windows/Linux) or Cmd + N (MacOS).

  2. Select “Environment”.

  3. Name the environment “Atlassian Cloud”.

  4. Set up the following variables:

    VariableTypeInitial value and Current valueComments

    cloudUrl

    default

    https://<yoursite>.atlassian.net

    Replace yoursite with your subdomain, e.g. acmecorp

    apiTokenEmailAddress

    default

    <youruser@yourdomain.com>

    Your Atlassian administrator account email

    apiToken

    secret

    From https://id.atlassian.com/manage-profile/security/api-tokens

    Manage API tokens for your Atlassian account

    Note that Postman variables are case-sensitive.

  5. Click Save towards the top right corner.

Create a new collection

  1. Click New, or type Ctrl + N (Windows/Linux) or Cmd + N (MacOS).

  2. Select “Collection”.

  3. Name the collection “Atlassian Cloud User Management”.

  4. Click the “Authorization” tab.
  5. Change Type to “Basic Auth”.

  6. Specify {{apiTokenEmailAddress}} as the Username. The text should be coloured orange, indicating that Postman has recognized a variable has been specified. This can be confirmed by hovering over the variable name.

  7. Specify {{apiToken}} as the Password. The text should be coloured orange, indicating that Postman has recognized a variable has been specified. This can be confirmed by hovering over the variable name.

  8. Click the “Tests” tab.

  9. Enter:

    pm.test("Request successful", function () {
        pm.expect(pm.response.code).to.be.oneOf([200,201,202,204]);
    });


    This allows us to ensure all REST APIs have been made successfully.

  10. Click Save towards the top right corner.

Set up REST API call

  1. Click New, or type Ctrl + N  (Windows/Linux) or Cmd  + N (MacOS).

  2. Select "HTTP".

  3. Name the request "Delete Team from Atlassian Cloud".

  4. Change the method from GET  to DELETE .

  5. In the URL, paste:

    {{cloudUrl}}/gateway/api/public/teams/v1/org/{{organizationId}}/teams/{{teamId}}
  6. Click the "Authorization" tab.
  7. Ensure Type is "Inherit auth from parent".

  8. Click Save , saving into the "Atlassian Cloud User Management" collection.

Execute runner 

  1. Change the environment using the environment selector at the top right of Postman, selecting "Atlassian Cloud".

  2. Select Collections in the sidebar.

  3. Select the "Atlassian Cloud User Management" collection.

  4. On the Overview tab, select ▶️ Run towards the top right corner.

  5. Under Run order, ensure there is one and only REST API call - "Delete Team from Atlassian Cloud".

  6. On the Functional tab, select Run manually.

  7. Click Data.

  8. Navigate to and select the previously prepared csv file.

  9. Reduce the number of "Iterations" under Run configuration to 1.

    Deleting a team is a destructive and irreversible action. We strongly recommend testing with a single team and verifying results before systematically deleting all teams.

  10. Leave Advanced settings as is.

  11. Click Run Atlassian Cloud User Management.

  12. Check Postman to ensure the runner collection has passed all tests. The run results should show:

    1. "Iterations" and "All tests" to be equivalent in count

    2. Passed (n) where n is the number of iterations

    3. Failed (0)

    4. Skipped (0)

  13. Check admin.atlassian.com to ensure the user count has been reduced by one.

  14. Rerun Postman Runner following the previous steps, with the number of "Iterations" set to the number of rows in the csv file. One error may be expected as it is not possible to delete a team that has already been deleted.

References


Last modified on May 1, 2024

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.