Using the Auth0 API with our Postman Collections
Installing the Collections
To install the Postman Collection, you must install the Postman App for Windows, Mac or Chrome. You can download any of these from the Postman Apps page.
Next, head over to our new API Landing Page, and install the Collection you want to use by clicking on the relevant Run in Postman button.
Postman will prompt whether you want to open the Collection in Postman for Chrome or Postman for Windows / Mac. Select the application you installed.
Once you make a selection, the selected Postman application will open and the collection will be imported.
Our API Collections are organized into folders that categorize the various API calls according to category. For example, you will find all the Users methods under the Users folder in the Management API.
Configuring the Postman Environment
The Auth0 Postman collections make use of environment variables to customize the requests that are sent. More information on managing Postman environments can be found at Setting up an environment with variables
You must create an environment and configure the following variables:
auth0_domain: Should contain the domain for your Auth0 tenant, such as
auth0_token: Should contain the token needed to make calls to the Management API and is only required when using the Management API collection. For more information, see How to Get an Access Token for the Management API
In the screenshot below, you can see a Postman environment configured with both the
auth0_token variables defined:
Executing a request
Once the environment is configured, you can follow these steps to execute an Auth0 API method:
- Select the environment you want to work with.
- Select the relevant API method in the collection folder.
- Click the Send button.
You may also have to configure query parameters or the JSON method body, depending on the API call. For more information, please refer to the Sending Requests page.
A word about storing tokens in Postman variables
We need to point out that storing tokens in Postman as environment variables could pose a potential security risk. If you are signed in to the Postman application, it will automatically try and synchronize entities such as Collections and Environments with the Postman servers. This means that a token, which could allow someone else to gain access to your Management API, is leaving the privacy of your computer and uploaded Postman's servers.
However, Postman has taken measures to ensure that tokens are encrypted and encourages users to store them in Environment Variables. You can read more at their Security page.
If you feel that this still poses too much of a risk, then you will need to sign out of Postman to ensure that environment variables are not synchronized.