Create users in 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 create users in bulk in Atlassian Cloud (Jira or Confluence).

When not to use this article

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



Prepare data

  1. Use a text editor to prepare a text document listing the email address of all users to be created.
    All users must have valid email addresses (with a mailbox attached) to later receive an email to reset their password upon first sign in.
  2. Ensure the first row has a header row labelled emailAddress  .
  3. Save the file as a csv, now containing a list of email addresses with users to be created.

Sample file

emailAddress
dgrechen@bancly.com
khaulkham-fraben@bancly.com
igunston2@bancly.com
pmaynell3@bancly.com


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

    emailAddress

    default

    <youruser@yourdomain.com>

    Your Atlassian 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 {{emailAddress}} as the Username. The text should be coloured, indicating that Postman has recognized a variable has been specified.

  7. Specify {{apiToken}} as the Password. The text should be coloured, indicating that Postman has recognized a variable has been specified.

  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 "Create User in Atlassian Cloud".

  4. Change the method from GET  to POST .

  5. In the URL, paste:

    {{cloudUrl}}/rest/api/2/user
  6. Click the "Authorization" tab.

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

  8. Click the "Body" tab.
  9. Click "raw".

  10. Change the content type to "JSON".


  11. Paste the following block in payload area:

    {
      "emailAddress": "{{emailAddress}}"
    }

    noting the {{emailAddress}} matches the csv header (case-sensitive).

  12. 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 - "Create User in 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.

  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 increased by one. Check the user's access permissions. They will inherit default access permissions.

  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 Dec 8, 2023

Was this helpful?

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