Setting up Postman for Organization User Management
Platform Notice: Cloud - This article applies to Atlassian products on the cloud platform.
Download Postman
Download Postman from https://www.postman.com/downloads/
Run Postman.
Create a new environment
Click New, or type
Ctrl
+N
(Windows/Linux) orCmd
+N
(MacOS).Select “Environment”.
Name the environment “Atlassian Cloud (with Org API key)”.
Set up the following variables:
Variable Type Initial value and Current value Comments cloudUrl
default
https://<yoursite>.atlassian.net
Replace yoursite with your subdomain, e.g. acmecorp
orgApiKey
secret
From admin.atlassian.com
organizationId
default
<yourOrganizationId>
Provided at the same time as the organization API token
Can otherwise be obtained from the relevant URL starting with https://admin.atlassian.com/o/
Note that Postman variables are case-sensitive.
- Click Save towards the top right corner.
Create a new collection
Click New, or type
Ctrl
+N
(Windows/Linux) orCmd
+N
(MacOS).Select “Collection”.
Name the collection “Atlassian Cloud User Management (Org API key)”.
- Click the “Authorization” tab.
Change Type to “Bearer Token”.
Specify
{{orgApiKey}}
as the Token. 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.Click the “Tests” tab.
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.- Click Save towards the top right corner.