Create groups using Postman and REST APIs in Cloud

Still need help?

The Atlassian Community is here for you.

Ask the community

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

When to use this article

This article can be utilized whenever many groups need to be created in Atlassian Cloud (Jira or Confluence).

When not to use this article

For organizations with users and groups provisioned through Atlassian Guard SCIM, utilize the Atlassian Access User Provisioning REST API.


Prepare data

1. Open a text editor and create a document with a list of all groups to be formed.
2. Make sure the first row includes a header labeled groupName.
3. Save the document in CSV format, which will now contain a list of groups to be established.

Sample file

groupName
office-pouso-alegre
mtv-sales-ops
mtv-developers
team-rainbow
vip-support


Setting up Postman

This section may be skipped if:

  • a collection named "Atlassian cloud User Management" has previously been setup, and

  • an environment named "Atlassian Cloud" has previously been setup.

For complete detailed steps in using Postman, see Set up Postman for bulk user management.

Setting up REST API call

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

  2. Select HTTP.

  3. Name the request "Create Group in Atlassian Cloud."

  4. Change the method from GET to POST .

  5. In the URL, paste:

    {{cloudUrl}}/rest/api/latest/group
  6. Select Authorization tab.

  7. Ensure Type is "Inherit auth from parent."

  8. Select Body tab.
  9. Select raw.

  10. Change the content type to "JSON."

  11. Paste the following block in the payload area:

    {
      "name": "{{groupName}}"
    }

    Noting the {{groupName}} matches the CSV header (case-sensitive).

  12. Select Save, saving into the "Atlassian Cloud User Management" collection.

Execute the Postman 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: "Create Group in Atlassian Cloud."

  6. On the Functional tab, select Run manually.

  7. Select Data.

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

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

  10. Leave Advanced settings as is.

  11. Select 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 group count has been increased 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.

References


Last modified on May 5, 2025

Was this helpful?

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