{"id":88565,"date":"2023-06-05T13:09:21","date_gmt":"2023-06-05T17:09:21","guid":{"rendered":"https:\/\/jumpcloud.com\/?post_type=support&#038;p=88565"},"modified":"2023-06-05T13:09:21","modified_gmt":"2023-06-05T17:09:21","slug":"configure-jumpcloud-api-endpoints-in-postman","status":"publish","type":"support","link":"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman","title":{"rendered":"Configure JumpCloud API Endpoints in Postman"},"content":{"rendered":"\n<p><strong>Prerequisites<\/strong>:<\/p>\n\n\n\n<ul>\n<li>Download and install the Postman app: <a href=\"https:\/\/www.getpostman.com\/downloads\/\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/www.getpostman.com\/downloads\/<\/a>.<\/li>\n<\/ul>\n\n\n\n<p><strong>To import API endpoints into Postman<\/strong>:<\/p>\n\n\n\n<ol>\n<li>Go to&nbsp;<a target=\"_blank\" href=\"https:\/\/docs.jumpcloud.com\/api\/index.html\" rel=\"noreferrer noopener\">docs.jumpcloud.com<\/a>.<\/li>\n\n\n\n<li>Select API version you want to import. You will need to follow these steps for each API collection.\n<ul>\n\n<li><strong>V1<\/strong>:&nbsp;<a target=\"_blank\" href=\"https:\/\/docs.jumpcloud.com\/api\/1.0\/index.html\" rel=\"noreferrer noopener\">https:\/\/docs.jumpcloud.com\/api\/1.0\/index.html<\/a><\/li>\n\n\n<li><strong>V2<\/strong>:&nbsp;<a target=\"_blank\" href=\"https:\/\/docs.jumpcloud.com\/api\/2.0\/index.html\" rel=\"noreferrer noopener\">https:\/\/docs.jumpcloud.com\/api\/2.0\/index.html<\/a><\/li>\n\n<\/ul>\n<\/li>\n\n\n\n<li>Change the url from&nbsp;<strong>index.html<\/strong>&nbsp;to&nbsp;<strong>index.yaml<\/strong>.&nbsp;This will display the&nbsp;<strong>yaml&nbsp;<\/strong>version of the API.<\/li>\n\n\n\n<li>Download this as a YAML file.<\/li>\n\n\n\n<li>In Postman, go to&nbsp;<strong>File&nbsp;<\/strong>&gt;&nbsp;<strong>Import<\/strong>.<\/li>\n\n\n\n<li>Import the&nbsp;<strong>index.yaml&nbsp;<\/strong>file from step 4. This will import all the API endpoints to Postman for the given API version.<\/li>\n\n\n\n<li>You will now see the API has been imported as a collection into Postman.\u200b Right click the <strong>JumpCloud APIs<\/strong> heading, then click <strong>Rename<\/strong>. Name the collection as appropriate (JumpCloud APIs v1 or JumpCloud APIs v2).<\/li>\n\n\n\n<li>Repeat the process for each API version.<\/li>\n<\/ol>\n\n\n\n<p><strong>To use the API endpoints in Postman<\/strong>:<\/p>\n\n\n\n<ol>\n<li>Select which API endpoint to run.<\/li>\n\n\n\n<li>Click the <strong>Params<\/strong> tab to customize the parameters being sent with the command.<\/li>\n\n\n\n<li>Remove prepopulated text from fields where necessary (examples shown in the screenshot below for <strong>filter<\/strong> and <strong>id<\/strong>).<\/li>\n\n\n\n<li>Click <strong>Save<\/strong>.<br><img decoding=\"async\" width=\"2560\" height=\"685\" class=\"wp-image-88568\" style=\"width: 800px\" src=\"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-scaled.jpeg\" alt=\"\" srcset=\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-scaled.jpeg 2560w, https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-300x80.jpeg 300w, https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-1024x274.jpeg 1024w, https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-768x206.jpeg 768w, https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-1536x411.jpeg 1536w, https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-2048x548.jpeg 2048w\" sizes=\"(max-width: 2560px) 100vw, 2560px\" \/><\/li>\n\n\n\n<li>Click the <strong>Authorization<\/strong> tab to customize the authorization header values being sent with the command.<\/li>\n\n\n\n<li>Verify <strong>API Key<\/strong> is selected as the authorization type.<\/li>\n\n\n\n<li>Add the value <strong>x-api-key<\/strong> to the <strong>Key <\/strong>field.<\/li>\n\n\n\n<li>Set the <strong>Value <\/strong>field to be your API key taken from the JumpCloud Admin Portal.<\/li>\n\n\n\n<li>Verify <strong>Header<\/strong> is selected in the <strong>Add To<\/strong> field.<\/li>\n\n\n\n<li>Click <strong>Save<\/strong>.<\/li>\n\n\n\n<li>Click <strong>Send<\/strong> to execute the command.<br><img decoding=\"async\" width=\"2492\" height=\"784\" class=\"wp-image-88567\" style=\"width: 800px\" src=\"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/05\/postman-api-key.jpeg\" alt=\"\" srcset=\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-api-key.jpeg 2492w, https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-api-key-300x94.jpeg 300w, https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-api-key-1024x322.jpeg 1024w, https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-api-key-768x242.jpeg 768w, https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-api-key-1536x483.jpeg 1536w, https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/05\/postman-api-key-2048x644.jpeg 2048w\" sizes=\"(max-width: 2492px) 100vw, 2492px\" \/><\/li>\n\n\n\n<li>View the results of the command.\u200b\u200b<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"<p>Prerequisites: To import API endpoints into Postman: To use the API endpoints in Postman:<\/p>\n","protected":false},"author":206,"featured_media":0,"template":"","meta":{"_acf_changed":false,"_oasis_is_in_workflow":0,"_oasis_original":0,"_oasis_task_priority":"","inline_featured_image":false,"footnotes":""},"support_category":[2917,2856],"support_tag":[],"coauthors":[2842],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v22.9 (Yoast SEO v22.9) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Configure JumpCloud API Endpoints in Postman - JumpCloud<\/title>\n<meta name=\"description\" content=\"Learn how to configure API endpoints with the Postman app, which must be downloaded separately.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Configure JumpCloud API Endpoints in Postman\" \/>\n<meta property=\"og:description\" content=\"Learn how to configure API endpoints with the Postman app, which must be downloaded separately.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman\" \/>\n<meta property=\"og:site_name\" content=\"JumpCloud\" \/>\n<meta property=\"og:image\" content=\"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-scaled.jpeg\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"1 minute\" \/>\n\t<meta name=\"twitter:label2\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data2\" content=\"pamkellman\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman\",\"url\":\"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman\",\"name\":\"Configure JumpCloud API Endpoints in Postman - JumpCloud\",\"isPartOf\":{\"@id\":\"https:\/\/jumpcloud.com\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman#primaryimage\"},\"image\":{\"@id\":\"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman#primaryimage\"},\"thumbnailUrl\":\"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-scaled.jpeg\",\"datePublished\":\"2023-06-05T17:09:21+00:00\",\"dateModified\":\"2023-06-05T17:09:21+00:00\",\"description\":\"Learn how to configure API endpoints with the Postman app, which must be downloaded separately.\",\"breadcrumb\":{\"@id\":\"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman#primaryimage\",\"url\":\"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-scaled.jpeg\",\"contentUrl\":\"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-scaled.jpeg\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/jumpcloud.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Support\",\"item\":\"https:\/\/jumpcloud.com\/support\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Configure JumpCloud API Endpoints in Postman\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/jumpcloud.com\/#website\",\"url\":\"https:\/\/jumpcloud.com\/\",\"name\":\"JumpCloud\",\"description\":\"Daily insights on directory services, IAM, LDAP, identity security, SSO, system management (Mac, Windows, Linux), networking, and the cloud.\",\"publisher\":{\"@id\":\"https:\/\/jumpcloud.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/jumpcloud.com\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/jumpcloud.com\/#organization\",\"name\":\"JumpCloud\",\"url\":\"https:\/\/jumpcloud.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png\",\"contentUrl\":\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png\",\"width\":598,\"height\":101,\"caption\":\"JumpCloud\"},\"image\":{\"@id\":\"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Configure JumpCloud API Endpoints in Postman - JumpCloud","description":"Learn how to configure API endpoints with the Postman app, which must be downloaded separately.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman","og_locale":"en_US","og_type":"article","og_title":"Configure JumpCloud API Endpoints in Postman","og_description":"Learn how to configure API endpoints with the Postman app, which must be downloaded separately.","og_url":"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman","og_site_name":"JumpCloud","og_image":[{"url":"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-scaled.jpeg"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"1 minute","Written by":"pamkellman"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman","url":"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman","name":"Configure JumpCloud API Endpoints in Postman - JumpCloud","isPartOf":{"@id":"https:\/\/jumpcloud.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman#primaryimage"},"image":{"@id":"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman#primaryimage"},"thumbnailUrl":"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-scaled.jpeg","datePublished":"2023-06-05T17:09:21+00:00","dateModified":"2023-06-05T17:09:21+00:00","description":"Learn how to configure API endpoints with the Postman app, which must be downloaded separately.","breadcrumb":{"@id":"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman#primaryimage","url":"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-scaled.jpeg","contentUrl":"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/05\/postman-list-a-system-user-scaled.jpeg"},{"@type":"BreadcrumbList","@id":"https:\/\/jumpcloud.com\/support\/configure-jumpcloud-api-endpoints-in-postman#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/jumpcloud.com\/"},{"@type":"ListItem","position":2,"name":"Support","item":"https:\/\/jumpcloud.com\/support"},{"@type":"ListItem","position":3,"name":"Configure JumpCloud API Endpoints in Postman"}]},{"@type":"WebSite","@id":"https:\/\/jumpcloud.com\/#website","url":"https:\/\/jumpcloud.com\/","name":"JumpCloud","description":"Daily insights on directory services, IAM, LDAP, identity security, SSO, system management (Mac, Windows, Linux), networking, and the cloud.","publisher":{"@id":"https:\/\/jumpcloud.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/jumpcloud.com\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/jumpcloud.com\/#organization","name":"JumpCloud","url":"https:\/\/jumpcloud.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/","url":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png","contentUrl":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png","width":598,"height":101,"caption":"JumpCloud"},"image":{"@id":"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/88565"}],"collection":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support"}],"about":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/types\/support"}],"author":[{"embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/users\/206"}],"version-history":[{"count":3,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/88565\/revisions"}],"predecessor-version":[{"id":88936,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/88565\/revisions\/88936"}],"wp:attachment":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/media?parent=88565"}],"wp:term":[{"taxonomy":"support_category","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support_category?post=88565"},{"taxonomy":"support_tag","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support_tag?post=88565"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/coauthors?post=88565"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}