Configure JumpCloud API Endpoints in Postman

Prerequisites:

• Download and install the Postman app: https://www.getpostman.com/downloads/.

To import API endpoints into Postman:

1. Go to docs.jumpcloud.com.
2. Select API version you want to import. You will need to follow these steps for each API collection.
   • V1: https://docs.jumpcloud.com/api/1.0/index.html
   • V2: https://docs.jumpcloud.com/api/2.0/index.html
3. Change the url from index.html to index.yaml. This will display the yaml version of the API.
4. Download this as a YAML file.
5. In Postman, go to File > Import.
6. Import the index.yaml file from step 4. This will import all the API endpoints to Postman for the given API version.
7. You will now see the API has been imported as a collection into Postman.​ Right click the JumpCloud APIs heading, then click Rename. Name the collection as appropriate (JumpCloud APIs v1 or JumpCloud APIs v2).
8. Repeat the process for each API version.

To use the API endpoints in Postman:

1. Select which API endpoint to run.
2. Click the Params tab to customize the parameters being sent with the command.
3. Remove prepopulated text from fields where necessary (examples shown in the screenshot below for filter and id).
4. Click Save.
   
5. Click the Authorization tab to customize the authorization header values being sent with the command.
6. Verify API Key is selected as the authorization type.
7. Add the value x-api-key to the Key field.
8. Set the Value field to be your API key taken from the JumpCloud Admin Portal.
9. Verify Header is selected in the Add To field.
10. Click Save.
11. Click Send to execute the command.
    
12. View the results of the command.​​