{"id":23531704,"url":"https://github.com/ryanprior/conjur-api-insomnia","last_synced_at":"2026-01-23T13:48:05.979Z","repository":{"id":63115465,"uuid":"150329693","full_name":"ryanprior/conjur-api-insomnia","owner":"ryanprior","description":"Insomnia workspace for exploring the Conjur API","archived":false,"fork":false,"pushed_at":"2019-06-06T14:40:01.000Z","size":13,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-19T11:34:50.981Z","etag":null,"topics":["conjur","conjur-api","cyberark","insomnia","rest-api"],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryanprior.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-25T21:10:04.000Z","updated_at":"2022-11-13T03:43:43.000Z","dependencies_parsed_at":"2022-11-13T05:00:56.212Z","dependency_job_id":null,"html_url":"https://github.com/ryanprior/conjur-api-insomnia","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ryanprior/conjur-api-insomnia","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanprior%2Fconjur-api-insomnia","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanprior%2Fconjur-api-insomnia/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanprior%2Fconjur-api-insomnia/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanprior%2Fconjur-api-insomnia/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryanprior","download_url":"https://codeload.github.com/ryanprior/conjur-api-insomnia/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanprior%2Fconjur-api-insomnia/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28693331,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T11:01:27.039Z","status":"ssl_error","status_checked_at":"2026-01-23T11:00:26.909Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["conjur","conjur-api","cyberark","insomnia","rest-api"],"created_at":"2024-12-25T22:20:08.343Z","updated_at":"2026-01-23T13:48:05.962Z","avatar_url":"https://github.com/ryanprior.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Conjur.org Insomnia Workspace\n\nWith Insomnia and this Conjur.org workspace, you have a convenient and powerful\ngraphical interface for learning, testing, and demonstrating the Conjur API.\n\nOn a scale of `curl` to the full Conjur Enterprise UI, the Conjur.org Insomnia\nWorkspace is here:\n\n```\n                                        more graphical, semantic, high level -\u003e\n[curl]--------------[*]-----------------------------------------[Enterprise UI]\n\u003c- more textual, literal, low level\n```\n\n## Prerequisites\n\n1. An account on a Conjur server.\n   \n   The easiest way to get this is to [sign up for a hosted evaluation\n   account][get-started].\n   \n   *License: GNU LGPL*\n   \n   You could also [install Conjur yourself][install-conjur].\n2. Insomnia\n   \n   Download: https://insomnia.rest/\n   \n   *License: MIT*\n\n[get-started]: https://www.conjur.org/get-started/try-conjur.html\n[install-conjur]: https://www.conjur.org/get-started/install-conjur.html\n\n## Importing the workspace\n\nTo import the Conjur.org workspace:\n1. Clone this repository.\n2. Open Insomnia. In the top left, you'll notice a purple \"Insomnia\" header -\n   this is your workspace switcher. Click it and choose the \"Import/Export\"\n   option.\n3. Choose Import Data, then From File. Select the \"Conjur.org.json\" in this\n   folder. You should see an \"Import Succeeded\" dialog appear; click OK.\n\n## Initializing the workspace\n\nBefore you can use the Conjur API, the workspace needs to be initialized with\nsome values specific to your environment.\n\n### Connecting to the Conjur server\n\nIn order for Insomnia to connect to the Conjur server, it needs the server's\nendpoint URL and your account.\n\n1. click the text that says \"No Environment\" in the top\nleft, then select \"Manage Environments\" at the bottom of that menu. This opens\nthe environment editor.\n2. Enter in your account and the URL of the Conjur server you're using, if\ndifferent from the eval server that's pre-filled. You get the account when you\nfill out the form to create an eval account, or if you're hosting Conjur\nyourself, it's the account you created with `conjurctl account create`.\n3. Press \"Done\" at the lower right corner of the editor. If the done button is\ndisabled, check your syntax for balanced quotes and mistaken keystrokes. Each\nenvironment needs to be a valid JSON document.\n\n#### Check server health\n\nAt this point, you should be able to check the health of the server:\n1. In the left sidebar, choose \"Verify the server is healthy\"\n2. In the top bar towards the middle right, click \"Send.\"\n3. Verify in the right-hand pane that the response comes in saying \"200 OK\"\n\n##### Troubleshooting\n\nIf it says something else, go back to the environment editor and check your\nserver URL. It should start with `https://` (or `http://` if you're testing a\nlocal insecure installation) and shouldn't have any trailing `/api`.\n\n### Set up the admin user\n\nNow that we're connected to the server, we can set up the first user:\n1. Switch to the \"admin\" environment by clicking \"No Environment\" in the top\n   left and selecting \"Use admin.\"\n2. Click \"admin\" and select \"Manage Environments\" to bring up the environment\n   editor again. This time it shows the admin sub-environment.\n3. Enter the admin's API key. You get this API key when you fill out the form to\n   create an eval account, or when you create an account on your own Conjur\n   server.\n   \n   *Note: the API key goes into the `\"api_key` field, not the `\"password\"` field.\"*\n4. Press \"Done\"\n\n#### Authenticate as admin\n\nIn the left sidebar, select \"Authenticate\" and click \"Send.\" You should get back\na \"200 OK\" result.\n\n##### Troubleshooting\n\nIf you get a `404 Not Found` result, check the account parameter in your base\nenvironment editor.\n\nIf you get a `401 Not Authorized` result:\n1. Make sure you are using the admin environment. It should say Conjur.org in\n   the top left, then below that, a red circle with \"admin\"\n2. Check the API key in the admin environment editor. There should be no extra\n   spaces or stray characters.\n\n#### Set an admin password (optional)\n\nIf you want to set a password for the admin user, select \"Change your password\"\non the left-hand side and click \"Send.\" You will be prompted to type a new\npassword. You should get a \"204 No Content\" response.\n\nNow open the environment editor and add the password to the environment's\n`password` field.\n\nIf you set a password, test that it works by selecting \"Login\" on the left-hand\nside and clicking \"Send.\" You should get back a \"200 OK\" response along with the\nadmin's API key.\n\n##### Troubleshooting\n\nIf you get a `401 Not Authorized` result, double check that you added the\npassword to the admin sub-environment and that it's the same one you typed when\nyou were prompted.\n\n### Load a policy\n\nNext, we'll load a policy that will create users, groups, and other objects for\nus to manipulate using the API.\n\n1. Right-click on the \"Policy\" folder in the left-hand pane and select\n   \"Environment.\" This opens the environment editor specifically for APIs in\n   this folder.\n2. In the environment is a template tag that says \"File\" and initially it will\n   be red. Click it, then in the dialog that appears, click \"policy.yml\"\n   underneath \"Choose File.\"\n3. In the file selector that appears, locate and select the `policy.yml` file in\n   this folder. Click \"Import\" and then \"Done.\" The file template tag should be\n   blue now.\n4. Click \"Done\" in the environment editor.\n5. Select \"Replace a policy\" in the left-hand pane and click \"Send.\" You should\n   get a \"201 Created\" response.\n\n##### Troubleshooting\n\nIf you get a `401 Not Authorized` result:\n1. Make sure you are using the admin environment. It should say Conjur.org in\n   the top left, then below that, a red circle with \"admin\"\n2. If it's been a few minutes since you last authenticated, select\n   \"Authenticate\" on the left-hand side and click \"Send** again.\n\n**Important Conjur API Tip:** the auth token you get from the \"Authenticate\" API\nendpoint has a time-to-live of eight minutes. Every time it expires, you'll need\nto authenticate again. The Conjur CLI and Conjur API clients typically do this\nfor you, but in Insomnia you'll have to remember to do this. Any time you see\n`401 Unauthorized` it could be because your token is expired.\n\n### Set up the non-admin users\n\nYour policy creates three non-admin users with various different roles. For a\ndescription of these users and their roles, see the [Intro to Conjur\npolicy][policy-intro] from which the Insomnia workspace policy is derived.\n\n[policy-intro]: https://www.conjur.org/get-started/key-concepts/intro-to-conjur-policy.html\n\nWhen you first load the policy, the JSON you get back will contain the API keys\nfor each created user.\n\nIf you loaded the policy previously, you can't get the API keys again by loading\nthe policy. Instead, you'll want to use \"Rotate another API key\" to rotate them.\n\nFor each user:\n1. Switch to that user's sub-environment\n2. Open the environment editor and enter that user's API key\n3. Test that you can \"Authenticate\"\n4. Optionally, set a password\n\n### That's It\n\nNow you're set up with a fully functional Conjur.org Insomnia workspace.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanprior%2Fconjur-api-insomnia","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryanprior%2Fconjur-api-insomnia","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanprior%2Fconjur-api-insomnia/lists"}